Docs: Clarify the CLIEngine options #10995
Merged
+19
−6
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
eslint-deprecated
bot
added
the
triage
platinumazure
added
documentation
docs/developer-guide/nodejs-api.md
Outdated
| * `fix` - This can be a boolean or a function which will be provided each linting message and should return a boolean. True indicates that fixes should be included with the output report, and that errors and warnings should not be listed if they can be fixed. However, the files on disk will not be changed. To persist changes to disk, call [`outputFixes()`](#cliengineoutputfixes). | ||
| * `globals` - An array of global variables to declare (default: empty array). Corresponds to `--global`. | ||
| * `globals` - An array of global variables to declare (default: empty array). Corresponds to `--global`. Note: This differs from `.eslintrc.*` / `baseConfig`, where `globals` is an object. |
There was a problem hiding this comment.
Question: Do we support passing in string values that are parsed as key/value pairs (e.g., "window:true" to signify that the window global variable should be considered writable)? If so, that may be worth calling out here.
I think --ext does allow the global readable/writable configuration, so I would expect it to be supported here too. Just wanted to double check.
|
@edmorley Friendly ping: Have you had a chance to look into the question I raised? Thanks! |
|
@platinumazure hi! Sorry for the delayed reply. I've tested locally and setting |
This aims to prevent some of the common pitfalls/points of confusion when configuring `CLIEngine`, such as: * it not being clear that `baseConfig` supports all of the options defined in the `.eslintrc.*` schema, and so can be used for options that are not supported as top-level `CLIEngine` arguments such as `extends` and `settings. * some of the CLIEngine options being named the same or almost the same as their `.eslintrc.*` equivalents, but being a different data type. * it not being clear that CLIEngine silently ignores invalid options (which will hopefully be fixed at some point by eslint#10272). Refs: eslint#4402 eslint#5179 eslint#6605 eslint#7247 eslint#7967 eslint#10272 webpack-contrib/eslint-loader#173 webpack-contrib/eslint-loader#252 neutrinojs/neutrino#1181
edmorley
force-pushed
the
clarify-cliengine-options
branch
from
70e532f to
1a3d550
Compare
|
Thank you for the review/merge :-) |
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of this pull request? (put an "X" next to item)
[X] Documentation update
What changes did you make? (Give an overview)
This aims to prevent some of the common pitfalls/points of confusion when configuring
CLIEngine, such as:baseConfigsupports all of the options defined in the.eslintrc.*schema, and so can be used for options that are not supported as top-levelCLIEnginearguments such asextendsandsettings..eslintrc.*equivalents, but being a different data type.Refs:
#4402
#5179
#6605
#7247
#7967
#10272
webpack-contrib/eslint-loader#173
webpack-contrib/eslint-loader#252
neutrinojs/neutrino#1181
Is there anything you'd like reviewers to focus on?
Nothing specifically :-)