Skip to content
small-rules

Directive Require Description

Suggestion
small-rules/directive-require-description

Require descriptions for `oxlint` and `eslint` disable/enable directives.

Diagnostic Messages

missingDescription
Missing description for '{{kind}}' comment.

Configuration

This rule accepts one options object after the severity.

ignoreOptional

Directive kinds that do not require a description.

Type
Array<string>
Default
-
{
  "jsPlugins": [
    "@pobammer-ts/small-rules"
  ],
  "rules": {
    "small-rules/directive-require-description": [
      "error",
      {
        "ignore": [
          "oxlint-disable"
        ]
      }
    ]
  }
}

Examples

Missing directive description
/* oxlint-disable no-console */
const x = 1;
Described directive comment
/* oxlint-disable no-console -- need for debugging */
const x = 1;
Directive No Restricted DisableRelatedRestricted-rule disables and description-required disables both constrain when suppressions are allowed.Directive No Unlimited DisableRelatedBlanket disables and undescribed disables are the two broadest suppression-quality failures.Directive No UseSupersedesIf block directives are forbidden, description requirements never apply to them.