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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: clarify how to use configs in plugins #11199

Merged
merged 10 commits into from Dec 22, 2018
Merged

Docs: clarify how to use configs in plugins #11199

merged 10 commits into from Dec 22, 2018

Conversation

@kaicataldo
Copy link
Member

@kaicataldo kaicataldo commented Dec 17, 2018

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 馃槄

@@ -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 = {
Copy link
Member Author

@kaicataldo kaicataldo Dec 17, 2018

Added for consistency

Copy link
Member

@platinumazure platinumazure left a comment

Leaving a few minor suggestions, otherwise LGTM. Thanks!

docs/developer-guide/working-with-plugins.md Outdated Show resolved Hide resolved
docs/developer-guide/working-with-plugins.md Outdated Show resolved Hide resolved
platinumazure and others added 2 commits Dec 18, 2018
Co-Authored-By: kaicataldo <kaicataldo@users.noreply.github.com>
Co-Authored-By: kaicataldo <kaicataldo@users.noreply.github.com>
@kaicataldo
Copy link
Member Author

@kaicataldo kaicataldo commented Dec 18, 2018

The "use commit suggestion" feature is pretty cool! @platinumazure changes merged.

Copy link
Member

@platinumazure platinumazure left a comment

LGTM, thanks!

Glad you enjoy the suggested changes feature- it's fun! I just wish it were available on mobile.

@not-an-aardvark not-an-aardvark merged commit 88f99d3 into master Dec 22, 2018
5 checks passed
@not-an-aardvark not-an-aardvark deleted the docs-update branch Dec 22, 2018
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Jun 21, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants