Skip to main content

require-stylelint-report-disables

Require reportDisables: true in authored Stylelint config files.

Targeted pattern scopeโ€‹

This rule targets Stylelint config modules such as stylelint.config.ts, stylelint.config.mjs, and .stylelintrc.js.

It focuses on top-level exported config objects, including configs wrapped in defineConfig(...).

What this rule reportsโ€‹

Reports configs where reportDisables is missing or explicitly set to false.

Why this rule existsโ€‹

Disable-comment usage should stay visible during lint runs. Enabling reportDisables improves governance and reviewability in shared lint policy.

โŒ Incorrectโ€‹

export default {
rules: {},
};
export default {
reportDisables: false,
rules: {},
};

โœ… Correctโ€‹

export default {
reportDisables: true,
rules: {},
};

Behavior and migration notesโ€‹

This rule auto-fixes by inserting or setting reportDisables: true.

ESLint flat config exampleโ€‹

import stylelint2 from "eslint-plugin-stylelint-2";

export default [stylelint2.configs.configuration];

When not to use itโ€‹

Do not use this rule if your team intentionally suppresses disable-comment reporting.

Package documentationโ€‹

Stylelint package documentation:

Rule catalog ID: R029

Further readingโ€‹