search

mysticatea / eslint-plugin-eslint-comments

Additional ESLint rules for directive comments of ESLint.
https://mysticatea.github.io/eslint-plugin-eslint-comments/
MIT License
354 stars 44 forks source link

Add `eslint-comments/require-description` rule #44

Closed ota-meshi closed 4 years ago

ota-meshi commented 4 years ago

This PR adds eslint-comments/require-description rule. This rule warns directive comments without description. This rule can only be used with ESLint v7.x or later.

close #40 close #29

nemoDreamer commented 4 years ago

@ota-meshi just updated, and it seems that adding a description satisfies your rule, but interferes with the disabling of the actual rule?

Might be an issue w/ my ESLint version? I'm on ^5.16.0, but the latest is 7.1.0.

image

image

Update: yup, confirmed it's because of my older version of ESLint. (Will leave this comment here for future searchers)

ota-meshi commented 4 years ago

As you say, this rule is only available with ESLint v7.x or later. I also wrote it in the documentation for this rule.

https://mysticatea.github.io/eslint-plugin-eslint-comments/rules/require-description.html