New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Describe values under Extending Configuration Files (refs #6240) #6336
Conversation
LGTM |
By analyzing the blame information on this pull request, we identified @nzakas, @fakewaffle and @gyandeeps to be potential reviewers |
@@ -550,84 +550,125 @@ The complete configuration hierarchy, from highest precedence to lowest preceden | |||
|
|||
## Extending Configuration Files | |||
|
|||
If you want to extend a specific configuration file, you can use the `extends` property and specify the path to the file. The path can be either relative or absolute. | |||
A configuration file can "extend" one or more "child" configurations to override a "base" set of rules. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why the quotes around these terms? If the intent is to introduce new terms, then I'd suggest formally defining them in a terminology section.
9d171c5
to
b9b5d2d
Compare
LGTM |
Made changes from first critique, asks self “what was I thinking?” Added example sentences to make config file format explicit and changed one to YAML. Next up: first draft of content and example for |
b9b5d2d
to
b69ba0e
Compare
LGTM |
Bring all feedback great and small to first draft of |
Nice, LGTM. Should we put an even bigger disclaimer around |
Yeah, I might just put this directly under the heading: Important: This configuration changes with every minor and major release, and as such, is not recommended for production use. Use at your own risk. |
b69ba0e
to
07df59b
Compare
LGTM |
Included Important paragraph after initial descriptive paragraph because it seemed to stand out a bit more there and because the following paragraph explains why. Changed the first and last level-3 headings to give more descriptive anchors:
s/specify different options/override default options/ Changed from bulleted items to ordinary paragraphs. Rephrased to include original use case: especially if you rarely override options or disable rules. |
LGTM |
The first two paragraphs might work as a short summary for the version blog with link from The Important: This configuration is not recommended for production use because it changes with every minor and major version of ESLint. Use at your own risk. |
Yeah, I'll be sure to include that. |
For this docs counterpart to #6248 let’s aim for about 3 steps of critique:
"eslint:all"
extends
property values followed by level-3 headings with an example of configuration."eslint:recommended"
on the rules index page. In particular, can whoever has expert knowledge ( @IanVS ? :) help me with the paragraph about “ESLint resolves a relative path…”"eslint:all"
including thoughts from Configuration to enable all rules #6240 and New: Addeslint:all
option (fixes #6240) #6248 especially New: Addeslint:all
option (fixes #6240) #6248 (comment)"eslint:all"