LogoSheriff
Documentation/CLI usage

Commands reference

All the CLI commands

@sherifforg/create-config

CLI options for the Scaffolder.

Summary Table

PropTypeDefault
install-deps?
boolean
true
prettier?
boolean
-
typescript?
boolean
-
filter?
string
-

--filter

  • Type: string

Filter for specific workspace. More info here https://www.eslint-config-sheriff.dev/docs/monorepo-support#setup-with-npm-init-sherifforgconfig

--typescript

  • Type: boolean

eslint.config.ts boilerplate will be added without asking it in the wizard.

--prettier

  • Type: boolean

Prettier boilerplate will be added without asking it in the wizard.

--install-deps

  • Type: boolean
  • Default: true

Should the dependencies be installed at the end of the wizard or not.

@sherifforg/cli

CLI options for the Doctor.

Summary Table

PropTypeDefault
ignore-astro?
boolean
false
ignore-playwright?
boolean
false
ignore-jest?
boolean
false
ignore-vitest?
boolean
false
ignore-remeda?
boolean
false
ignore-lodash?
boolean
false
ignore-next?
boolean
false
ignore-react?
boolean
false
debug?
boolean
false
no-fail?
boolean
false

--no-fail

  • Type: boolean
  • Default: false

If true: when a inconsistency is found, it will be reported as a warning. If false: when a inconsistency is found, it will be reported as an error and the process will fail with exit code 1.

--debug

  • Type: boolean
  • Default: false

Enables verbose logging.

--ignore-react

  • Type: boolean
  • Default: false

Skips React checks (react, react-dom, next).

--ignore-next

  • Type: boolean
  • Default: false

Skips Next.js checks.

--ignore-lodash

  • Type: boolean
  • Default: false

Skips Lodash (lodash, lodash-es) checks.

--ignore-remeda

  • Type: boolean
  • Default: false

Skips Remeda checks.

--ignore-vitest

  • Type: boolean
  • Default: false

Skips Vitest checks.

--ignore-jest

  • Type: boolean
  • Default: false

Skips Jest checks.

--ignore-playwright

  • Type: boolean
  • Default: false

Skips Playwright (playwright, @playwright/test) checks.

--ignore-astro

  • Type: boolean
  • Default: false

Skips Astro checks.

Last updated on