@remark/cardinal

Cardinal 🐦

car·di·nal /ˈkärd(ə)nl/

adjective

1. of the greatest importance; fundamental.

Usage

First you need to install Cardinal:

npm i -D @remark/cardinal

Once that finishes, you can configure your desired scripts:

{
  "scripts": {
+    "format": "remark-cardinal format"
  }
}

Scripts

build

build builds your code.

Currently only supports TypeScript (via the --typescript flag).

Options

• --typescript [<tsc_flag>...] - Builds your code using the TypeScript compiler. May optionally take any number of TypeScript compiler options.

format

format formats your code using Prettier.

lint

lint lints your code using ESLint.

Options

• --config <path> - Specify a custom Prettier configuration file.
• --ignore-path <path> - Path to a file containing patterns that describe files to ignore. By default, Cardinal respects the project's .gitignore.
• --no-write - Disables Prettier's --write option.