New: Add new rule require-meta-has-suggestions
#105
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
1 task
bmish
force-pushed
the
require-meta-docs-suggestion
branch
from
ce40169
to
2913ed8
Compare
aladdin-add
requested changes
Apr 8, 2021
| contextIdentifiers = utils.getContextIdentifiers(context, node); | ||
| }, | ||
| CallExpression (node) { | ||
| if ( |
There was a problem hiding this comment.
it could be simple to use selectors and the util: https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/a3017e253db08630da3f92428df6f4f2680ecf12/lib/utils.js#L257 . :)
There was a problem hiding this comment.
I'm not sure if it's convenient to use selectors here since we have a variable contextIdentifiers in the condition.
|
I have moved this PR to draft status pending the outcome of this issue eslint/eslint#14312 to discuss the future of the |
bmish
changed the title
require-meta-docs-suggestionrequire-meta-has-suggestions
Suggestable ESLint rules should have a `meta.hasSuggestions` property to indicate that they provide [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions). This new rule enforces that the `meta.hasSuggestions` property is correctly enabled when a rule provides suggestions, and not enabled when a rule does not provide suggestions. The change to require suggestable rules to have `meta.hasSuggestions` has been accepted and mentioned in the blog post for the upcoming ESLint 8 breaking changes. So we should adopt this change now to help plugin authors ensure they are compatible with ESLint 8 as soon as possible. The old property `meta.docs.suggestion` was unused anyway. https://eslint.org/blog/2021/06/whats-coming-in-eslint-8.0.0#rules-with-suggestions-now-require-the-metahassuggestions-property This is very similar to the existing [eslint-plugin/require-meta-fixable](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/require-meta-fixable.md) rule enforcing the correct presence of the `meta.fixable` property.
bmish
force-pushed
the
require-meta-docs-suggestion
branch
from
971aa26
to
54cf3d3
Compare
|
Now that the |
aladdin-add
changed the title
require-meta-has-suggestionsrequire-meta-has-suggestions
not-an-aardvark
approved these changes
Jun 13, 2021
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.
Suggestable ESLint rules should have a
meta.hasSuggestionsproperty to indicate that they provide suggestions. This new rule enforces that themeta.hasSuggestionsproperty is correctly enabled when a rule provides suggestions, and not enabled when a rule does not provide suggestions.The change to require suggestable rules to have
meta.hasSuggestionshas been accepted and mentioned in the blog post for the upcoming ESLint 8 breaking changes. So we should adopt this change now to help plugin authors ensure they are compatible with ESLint 8 as soon as possible. The old propertymeta.docs.suggestionwas unused anyway.https://eslint.org/blog/2021/06/whats-coming-in-eslint-8.0.0#rules-with-suggestions-now-require-the-metahassuggestions-property
We should make this a
recommendedrule in the next major release.This is very similar to the existing eslint-plugin/require-meta-fixable rule enforcing the correct presence of the
meta.fixableproperty.