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
Update docs to explain config option merging #7499
Conversation
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.
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:
Can you please update the pull request to address these? (More information can be found in our pull request guide.) |
@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. |
Thanks for the PR! I think the build is failing because markdownlint wants you to use four spaces in markdown indentation, rather than two. |
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:
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"]` |
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.
Can you use the "error", "warning", "off" notation instead of the numeric notation for severity?
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.
Done.
@danny-andrews Sorry to have you do this again, but mind signing the JS Foundation CLA by clicking on "Details" next to the |
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:
Can you please update the pull request to address these? (More information can be found in our pull request guide.) |
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:
Can you please update the pull request to address these? (More information can be found in our pull request guide.) |
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.
LGTM, thanks for the contribution!
If this looks ready to go, I'll squash and amend the commit message. |
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.
LGTM
@danny-andrews don't worry, we can squash and change the commit message directly. Thanks for the contribution! |
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.