Skip to main content

🗺️ CLI reference

@sherifforg/create-config​

CLI options for the npm init @sherifforg/config command.

--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 sheriff command.

--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.