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

Docs: Suggest linting plugins for ESLint plugin developers #14754

Merged
merged 1 commit into from Jul 2, 2021

Conversation

@bmish
Copy link
Member

@bmish bmish commented Jun 29, 2021

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an 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)

Updates the "Working with Plugins" doc to suggest a few ESLint plugins to lint ESLint plugins with. The goal is to generally increase the quality of ESLint plugins and increase the usability of ESLint plugin rules.

  • eslint
  • eslint-plugin-eslint-plugin
    • This is a powerful tool we have for helping plugin developers create more-reliable rules with better usability, and for helping plugin developers migrate off deprecated ESLint APIs to modern replacements
    • For example, this plugin could help us eventually make rule schemas mandatory for rules with options using the require-meta-schema rule (#14709), or remove support for deprecated function-based rules using the prefer-object-rule rule
    • I consider this one to be the highest-impact plugin that we could encourage plugin developers to use, and we should do as much as we can to publicize it
  • eslint-plugin-node
    • ESLint plugins contain Node code

These three plugins are plugins included or soon-to-be-included in the generator-eslint plugin blueprint, and are widely used in ESLint plugins.

CC: @aladdin-add

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

No

@aladdin-add
Copy link
Member

@aladdin-add aladdin-add commented Jun 30, 2021

as the generator-eslint, it will be discussed in the next TSC meeting. thanks @nzakas !

Copy link
Contributor

@snitin315 snitin315 left a comment

LGTM

nzakas
nzakas approved these changes Jul 2, 2021
@nzakas nzakas merged commit 19a871a into eslint:master Jul 2, 2021
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants