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.
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: Update configuration file pages #16509
docs: Update configuration file pages #16509
Changes from 6 commits
9016ac3
9a7c3b9
7974af7
53dd21d
3f814af
632a9fa
5ff543e
a5e1b9c
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
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.
"it is supplied to every rule executed by that configuration object" might be misleading. It sounds like the
settings
object is only supplied torules: {}
from the same configuration object.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.
@mdjermanovic
what'd be correct, it's applied to all rules in the project?
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.
I think you can just drop “executed by that configuration object”.
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.
It's supplied to every rule when linting a file to which the configuration object applies, but those rules don't have to be enabled by that configuration object.
For example:
When linting
a.js
,my-plugin/my-rule
will be supplied with{ data: "something" }
(ascontext.settings
), althoughmy-plugin/my-rule
rule isn't enabled in the same configuration object wheresettings
are defined.Since this sentence only briefly describes what
settings
means, it could just say "it is supplied to every rule", as @nzakas suggested.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.
thanks for the further clarification, implementing nicholas's suggestion!