Add rule documentation URLs and schemas (and eslint-plugin-eslint-plugin) #294
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
bmish
changed the title
bmish
force-pushed
the
eslint-plugin-eslint-plugin
branch
from
581d244
to
e1b7863
Compare
[eslint-plugin-eslint-plugin](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin) is a popular plugin for enforcing best practices for eslint plugins. The main reason I added this is because I noticed that the mocha rules did not have URLs specified. URLs are necessary so that IDEs/editors can provide a convenient link to rule documentation when showing violations so that developers can better understand the rules. So I enabled the fully-autofixable rule [eslint-plugin/require-meta-docs-url](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/require-meta-docs-url.md). A few other violations were autofixed including [duplicate test cases](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-identical-tests.md) and the use of the [deprecated report API](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-deprecated-report-api.md).
bmish
force-pushed
the
eslint-plugin-eslint-plugin
branch
from
e1b7863
to
b692a5f
Compare
lo1tuma
approved these changes
Oct 15, 2021
bmish
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
eslint-plugin-eslint-plugin is a popular plugin for enforcing best practices for eslint plugins.
The main reason I added this is because I noticed that the mocha rules did not have URLs specified. URLs are necessary so that IDEs/editors can provide a convenient link to rule documentation when showing violations so that developers can better understand the rules. So I enabled the fully-autofixable rule eslint-plugin/require-meta-docs-url.
A few other violations were autofixed including duplicate test cases, the use of the deprecated report API, and adding missing empty schemas.