eslint-plugin-eslint-comments

Appearance

@eslint-community/eslint-comments/require-description ​

require include descriptions in ESLint directive-comments

This rule warns directive comments without description.

WARNING

This rule can only be used with ESLint v7.x or later.

Rule Details ​

Examples of 👎 incorrect code for this rule:

Now loading...

Examples of 👍 correct code for this rule:

Now loading...

Options ​

You can specify ignored directive-comments.

json
{
    "@eslint-community/eslint-comments/require-description": ["error", {"ignore": []}]
}
  • ignore option is an array to ignore specified directive-comments. The value of the array is some of the following strings:
    • "eslint"
    • "eslint-disable"
    • "eslint-disable-line"
    • "eslint-disable-next-line"
    • "eslint-enable"
    • "eslint-env"
    • "exported"
    • "global"
    • "globals"

Further Reading ​