Skip to content

Commit

Permalink
Docs: add errorOnUnmatchedPattern option to CLIEngine (#12834)
Browse files Browse the repository at this point in the history
  • Loading branch information
arthurdenner committed Feb 5, 2020
1 parent 439c833 commit 824d235
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/developer-guide/nodejs-api.md
Expand Up @@ -356,6 +356,7 @@ The `CLIEngine` is a constructor, and you can create a new instance by passing i
* `configFile` - The configuration file to use (default: null). If `useEslintrc` is true or not specified, this configuration will be merged with any configuration defined in `.eslintrc.*` files, with options in this configuration having precedence. Corresponds to `-c`.
* `cwd` - Path to a directory that should be considered as the current working directory.
* `envs` - An array of environments to load (default: empty array). Corresponds to `--env`. Note: This differs from `.eslintrc.*` / `baseConfig`, where instead the option is called `env` and is an object.
* `errorOnUnmatchedPattern` - Set to `false` to prevent errors when pattern is unmatched. Corresponds to `--no-error-on-unmatched-pattern`.
* `extensions` - An array of filename extensions that should be checked for code. The default is an array containing just `".js"`. Corresponds to `--ext`. It is only used in conjunction with directories, not with filenames, glob patterns or when using `executeOnText()`.
* `fix` - A boolean or a function (default: `false`). If a function, it will be passed each linting message and should return a boolean indicating whether the fix should be included with the output report (errors and warnings will not be listed if fixed). Files on disk are never changed regardless of the value of `fix`. To persist changes to disk, call [`outputFixes()`](#cliengineoutputfixes).
* `fixTypes` - An array of rule types for which fixes should be applied (default: `null`). This array acts like a filter, only allowing rules of the given types to apply fixes. Possible array values are `"problem"`, `"suggestion"`, and `"layout"`.
Expand Down

0 comments on commit 824d235

Please sign in to comment.