Docs: clarify how to use configs in plugins #11199
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eslint-deprecated
bot
added
the
triage
kaicataldo
added
documentation
kaicataldo
commented
Dec 17, 2018
| @@ -52,31 +52,33 @@ Plugin environments can define the following objects: | |||
| You can also create plugins that would tell ESLint how to process files other than JavaScript. In order to create a processor, the object that is exported from your module has to conform to the following interface: | |||
|
|
|||
| ```js | |||
| processors: { | |||
| module.exports = { | |||
There was a problem hiding this comment.
Added for consistency
platinumazure
requested changes
Dec 17, 2018
Co-Authored-By: kaicataldo <kaicataldo@users.noreply.github.com>
Co-Authored-By: kaicataldo <kaicataldo@users.noreply.github.com>
|
The "use commit suggestion" feature is pretty cool! @platinumazure changes merged. |
platinumazure
approved these changes
Dec 18, 2018
not-an-aardvark
approved these changes
Dec 22, 2018
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
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)
Was writing a new plugin with some configs and noticed there aren't any concrete examples of how a config is actually defined in a configuration file. Added an example to show how a user would do this.
Is there anything you'd like reviewers to focus on?
I wasn't able to find any other documentation surrounding this - let me know if I just missed it!
Sorry for all the commits - I used the the GitHub UI for this and kept wanting to iterate 馃槄