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

Update docs to explain config option merging #7499

Merged
merged 4 commits into from Nov 8, 2016
Merged

Update docs to explain config option merging #7499

merged 4 commits into from Nov 8, 2016

Conversation

danny-andrews
Copy link
Contributor

What is the purpose of this pull request? (put an "X" next to item)

[X] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Updated the docs to explain how config options are merged from base configs.

Is there anything you'd like reviewers to focus on?

There was a lot of confusion generated by the merging behavior of rules inherited from base configs, so I thought I would clear that up here. There still may be scenarios which arise where options cannot be overridden from base configs, but we'll deal with those on a per-case basis.

There was a lot of [confusion](#6361) generated by the merging behavior of rules inherited from base configs, so I thought I would clear that up here. There still may be [scenarios](#6144) which arise where options cannot be overridden from base configs, but we'll deal with those on a per-case basis.
@eslintbot
Copy link

Thanks for the pull request, @danny-andrews! I took a look to make sure it's ready for merging and found some changes are needed:

  • The commit summary needs to begin with a tag (such as Fix: or Update:). Please check out our guide for how to properly format your commit summary and update it on this pull request.

Can you please update the pull request to address these?

(More information can be found in our pull request guide.)

@mention-bot
Copy link

@danny-andrews, thanks for your PR! By analyzing the history of the files in this pull request, we identified @pedrottimark, @nzakas and @MikeMcl to be potential reviewers.

@not-an-aardvark not-an-aardvark added the documentation Relates to ESLint's documentation label Oct 31, 2016
@not-an-aardvark
Copy link
Member

Thanks for the PR! I think the build is failing because markdownlint wants you to use four spaces in markdown indentation, rather than two.

@jsf-clabot
Copy link

jsf-clabot commented Oct 31, 2016

CLA assistant check
All committers have signed the CLA.

@eslintbot
Copy link

Thanks for the pull request, @danny-andrews! I took a look to make sure it's ready for merging and found some changes are needed:

  • The commit summary needs to begin with a tag (such as Fix: or Update:). Please check out our guide for how to properly format your commit summary and update it on this pull request.

Can you please update the pull request to address these?

(More information can be found in our pull request guide.)

* override default options for rules from base configurations
* disable rules from base configurations
* change an inherited rule's severity without changing its options:
* Base config: `"eqeqeq": [2, "allow-null"]`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you use the "error", "warning", "off" notation instead of the numeric notation for severity?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@kaicataldo
Copy link
Member

@danny-andrews Sorry to have you do this again, but mind signing the JS Foundation CLA by clicking on "Details" next to the license/cla check in the checks below?

@eslintbot
Copy link

Thanks for the pull request, @danny-andrews! I took a look to make sure it's ready for merging and found some changes are needed:

  • The commit summary needs to begin with a tag (such as Fix: or Update:). Please check out our guide for how to properly format your commit summary and update it on this pull request.

Can you please update the pull request to address these?

(More information can be found in our pull request guide.)

@eslintbot
Copy link

Thanks for the pull request, @danny-andrews! I took a look to make sure it's ready for merging and found some changes are needed:

  • The commit summary needs to begin with a tag (such as Fix: or Update:). Please check out our guide for how to properly format your commit summary and update it on this pull request.

Can you please update the pull request to address these?

(More information can be found in our pull request guide.)

Copy link
Member

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for the contribution!

@danny-andrews
Copy link
Contributor Author

If this looks ready to go, I'll squash and amend the commit message.

Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@nzakas
Copy link
Member

nzakas commented Nov 8, 2016

@danny-andrews don't worry, we can squash and change the commit message directly. Thanks for the contribution!

@nzakas nzakas merged commit 3e6131e into eslint:master Nov 8, 2016
@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 documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants