spire-plugin-eslint

ESLint plugin for Spire.

• Hooks
• Options

Hooks

• setup Adds lint and prepares eslint arguments.
• precommit Adds eslint linter.
• run Runs eslint.

Options

• Plugin ['spire-plugin-eslint', options]

  • command <string> Command name to run eslint on. Defaults to lint.
  • eslintConfig <string> Default [eslint] configuration. Defaults to ./config.js.
  • autosetEslintConfig <boolean> Decides if the plugin should automatically create an .eslintrc.js file. It will only create the file if there isn't already a config present. Defaults to true.
  • allowCustomConfig <boolean> Whether to allow user-provided config. If this option is false and there's custom eslint config found it will throw an error. Defaults to true.
  • eslintIgnore <string> Path to default .eslintignore. Defaults to .gitignore.
  • allowCustomIgnore <boolean> Whether to allow user-provided .eslintignore. If this option is false and there's custom ignore file found it will throw an error. Defaults to true.
  • fileExtensions <string[]> Extension of files eslint should scan. Defaults to ['.js', '.jsx', '.mjs', '.ts', '.tsx'].

• CLI npx spire lint [args]

  • Passes all arguments as-is to eslint.