Skip to content
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

Merged
merged 1 commit into from Jun 10, 2016

Conversation

pedrottimark
Copy link
Member

For this docs counterpart to #6248 let’s aim for about 3 steps of critique:

  1. Baseline with only placeholder content for "eslint:all"
    • Critique a new structure for Extending Configuration Files that is adapted from new structure under Options in rule docs: bulleted list of extends property values followed by level-3 headings with an example of configuration.
    • Critique reorganization and rewriting of existing content. Is it correct, clear, and complete in context? For example, this section is the target of the link about "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…”
  2. Baseline improvements plus first draft of new content about "eslint:all" including thoughts from Configuration to enable all rules #6240 and New: Add eslint:all option (fixes #6240) #6248 especially New: Add eslint:all option (fixes #6240) #6248 (comment)
  3. Second draft of new content about "eslint:all"

@eslintbot
Copy link

LGTM

@mention-bot
Copy link

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.
Copy link
Member

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.

@eslintbot
Copy link

LGTM

@pedrottimark
Copy link
Member Author

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 "eslint:all"

@eslintbot
Copy link

LGTM

@pedrottimark
Copy link
Member Author

Bring all feedback great and small to first draft of "eslint:all"

@ilyavolodin
Copy link
Member

Nice, LGTM. Should we put an even bigger disclaimer around eslint:all section. Using this will void your warranty and don't come crying to us?:-)

@nzakas
Copy link
Member

nzakas commented Jun 9, 2016

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.

@eslintbot
Copy link

LGTM

@pedrottimark
Copy link
Member Author

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:

  • Using "eslint:recommended"
  • Using "eslint:all"

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.

@nzakas
Copy link
Member

nzakas commented Jun 9, 2016

LGTM

@pedrottimark
Copy link
Member Author

The first two paragraphs might work as a short summary for the version blog with link from "eslint:all" to the subheading in this doc.

The extends property value can be "eslint:all" to enable all core rules in the currently installed version of ESLint. The set of core rules can change at any minor or major version of ESLint.

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.

@nzakas
Copy link
Member

nzakas commented Jun 10, 2016

Yeah, I'll be sure to include that.

@nzakas nzakas merged commit 5affab1 into master Jun 10, 2016
@pedrottimark pedrottimark deleted the docs-extend-values branch June 10, 2016 16:17
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants