eslint-plugin-stylelint-2 1.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +329 -0
- package/LICENSE +21 -0
- package/README.md +174 -0
- package/dist/_internal/rule-docs-url.d.ts +15 -0
- package/dist/_internal/rule-docs-url.d.ts.map +1 -0
- package/dist/_internal/rule-docs-url.js +15 -0
- package/dist/_internal/rule-docs-url.js.map +1 -0
- package/dist/_internal/rules-registry.d.ts +88 -0
- package/dist/_internal/rules-registry.d.ts.map +1 -0
- package/dist/_internal/rules-registry.js +85 -0
- package/dist/_internal/rules-registry.js.map +1 -0
- package/dist/_internal/stylelint-config-boolean-option-rule.d.ts +17 -0
- package/dist/_internal/stylelint-config-boolean-option-rule.d.ts.map +1 -0
- package/dist/_internal/stylelint-config-boolean-option-rule.js +90 -0
- package/dist/_internal/stylelint-config-boolean-option-rule.js.map +1 -0
- package/dist/_internal/stylelint-config-disallowed-option-rule.d.ts +16 -0
- package/dist/_internal/stylelint-config-disallowed-option-rule.d.ts.map +1 -0
- package/dist/_internal/stylelint-config-disallowed-option-rule.js +48 -0
- package/dist/_internal/stylelint-config-disallowed-option-rule.js.map +1 -0
- package/dist/_internal/stylelint-config-object.d.ts +62 -0
- package/dist/_internal/stylelint-config-object.d.ts.map +1 -0
- package/dist/_internal/stylelint-config-object.js +114 -0
- package/dist/_internal/stylelint-config-object.js.map +1 -0
- package/dist/_internal/stylelint-config-package-option-rule.d.ts +12 -0
- package/dist/_internal/stylelint-config-package-option-rule.d.ts.map +1 -0
- package/dist/_internal/stylelint-config-package-option-rule.js +66 -0
- package/dist/_internal/stylelint-config-package-option-rule.js.map +1 -0
- package/dist/_internal/stylelint-config-rules-object.d.ts +23 -0
- package/dist/_internal/stylelint-config-rules-object.d.ts.map +1 -0
- package/dist/_internal/stylelint-config-rules-object.js +47 -0
- package/dist/_internal/stylelint-config-rules-object.js.map +1 -0
- package/dist/_internal/stylelint-config-string-array-option-rule.d.ts +27 -0
- package/dist/_internal/stylelint-config-string-array-option-rule.d.ts.map +1 -0
- package/dist/_internal/stylelint-config-string-array-option-rule.js +234 -0
- package/dist/_internal/stylelint-config-string-array-option-rule.js.map +1 -0
- package/dist/_internal/stylelint-config-string-array-option.d.ts +32 -0
- package/dist/_internal/stylelint-config-string-array-option.d.ts.map +1 -0
- package/dist/_internal/stylelint-config-string-array-option.js +55 -0
- package/dist/_internal/stylelint-config-string-array-option.js.map +1 -0
- package/dist/_internal/stylelint-package-dependencies.d.ts +18 -0
- package/dist/_internal/stylelint-package-dependencies.d.ts.map +1 -0
- package/dist/_internal/stylelint-package-dependencies.js +107 -0
- package/dist/_internal/stylelint-package-dependencies.js.map +1 -0
- package/dist/_internal/stylelint-runner.d.ts +4 -0
- package/dist/_internal/stylelint-runner.d.ts.map +1 -0
- package/dist/_internal/stylelint-runner.js +93 -0
- package/dist/_internal/stylelint-runner.js.map +1 -0
- package/dist/_internal/stylelint-worker-types.d.ts +70 -0
- package/dist/_internal/stylelint-worker-types.d.ts.map +1 -0
- package/dist/_internal/stylelint-worker-types.js +2 -0
- package/dist/_internal/stylelint-worker-types.js.map +1 -0
- package/dist/_internal/stylelint-worker.d.ts +2 -0
- package/dist/_internal/stylelint-worker.d.ts.map +1 -0
- package/dist/_internal/stylelint-worker.js +113 -0
- package/dist/_internal/stylelint-worker.js.map +1 -0
- package/dist/_internal/stylelint2-config-references.d.ts +32 -0
- package/dist/_internal/stylelint2-config-references.d.ts.map +1 -0
- package/dist/_internal/stylelint2-config-references.js +65 -0
- package/dist/_internal/stylelint2-config-references.js.map +1 -0
- package/dist/_internal/typed-rule.d.ts +42 -0
- package/dist/_internal/typed-rule.d.ts.map +1 -0
- package/dist/_internal/typed-rule.js +53 -0
- package/dist/_internal/typed-rule.js.map +1 -0
- package/dist/plugin.cjs +1 -0
- package/dist/plugin.d.cts +10 -0
- package/dist/plugin.d.ts +36 -0
- package/dist/plugin.d.ts.map +1 -0
- package/dist/plugin.js +183 -0
- package/dist/plugin.js.map +1 -0
- package/dist/rules/disallow-stylelint-allow-empty-input.d.ts +9 -0
- package/dist/rules/disallow-stylelint-allow-empty-input.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-allow-empty-input.js +29 -0
- package/dist/rules/disallow-stylelint-allow-empty-input.js.map +1 -0
- package/dist/rules/disallow-stylelint-configuration-comment.d.ts +9 -0
- package/dist/rules/disallow-stylelint-configuration-comment.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-configuration-comment.js +29 -0
- package/dist/rules/disallow-stylelint-configuration-comment.js.map +1 -0
- package/dist/rules/disallow-stylelint-custom-syntax.d.ts +12 -0
- package/dist/rules/disallow-stylelint-custom-syntax.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-custom-syntax.js +32 -0
- package/dist/rules/disallow-stylelint-custom-syntax.js.map +1 -0
- package/dist/rules/disallow-stylelint-default-severity.d.ts +9 -0
- package/dist/rules/disallow-stylelint-default-severity.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-default-severity.js +28 -0
- package/dist/rules/disallow-stylelint-default-severity.js.map +1 -0
- package/dist/rules/disallow-stylelint-duplicate-extends.d.ts +9 -0
- package/dist/rules/disallow-stylelint-duplicate-extends.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-duplicate-extends.js +29 -0
- package/dist/rules/disallow-stylelint-duplicate-extends.js.map +1 -0
- package/dist/rules/disallow-stylelint-duplicate-plugins.d.ts +9 -0
- package/dist/rules/disallow-stylelint-duplicate-plugins.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-duplicate-plugins.js +29 -0
- package/dist/rules/disallow-stylelint-duplicate-plugins.js.map +1 -0
- package/dist/rules/disallow-stylelint-duplicate-rule-option-values.d.ts +10 -0
- package/dist/rules/disallow-stylelint-duplicate-rule-option-values.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-duplicate-rule-option-values.js +171 -0
- package/dist/rules/disallow-stylelint-duplicate-rule-option-values.js.map +1 -0
- package/dist/rules/disallow-stylelint-empty-rules-object.d.ts +7 -0
- package/dist/rules/disallow-stylelint-empty-rules-object.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-empty-rules-object.js +65 -0
- package/dist/rules/disallow-stylelint-empty-rules-object.js.map +1 -0
- package/dist/rules/disallow-stylelint-ignore-disables.d.ts +9 -0
- package/dist/rules/disallow-stylelint-ignore-disables.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-ignore-disables.js +28 -0
- package/dist/rules/disallow-stylelint-ignore-disables.js.map +1 -0
- package/dist/rules/disallow-stylelint-ignore-files.d.ts +9 -0
- package/dist/rules/disallow-stylelint-ignore-files.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-ignore-files.js +28 -0
- package/dist/rules/disallow-stylelint-ignore-files.js.map +1 -0
- package/dist/rules/disallow-stylelint-null-rule-config.d.ts +7 -0
- package/dist/rules/disallow-stylelint-null-rule-config.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-null-rule-config.js +86 -0
- package/dist/rules/disallow-stylelint-null-rule-config.js.map +1 -0
- package/dist/rules/disallow-stylelint-overrides-runtime-options.d.ts +7 -0
- package/dist/rules/disallow-stylelint-overrides-runtime-options.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-overrides-runtime-options.js +124 -0
- package/dist/rules/disallow-stylelint-overrides-runtime-options.js.map +1 -0
- package/dist/rules/disallow-stylelint-processors.d.ts +9 -0
- package/dist/rules/disallow-stylelint-processors.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-processors.js +29 -0
- package/dist/rules/disallow-stylelint-processors.js.map +1 -0
- package/dist/rules/disallow-stylelint-relative-extends-paths.d.ts +9 -0
- package/dist/rules/disallow-stylelint-relative-extends-paths.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-relative-extends-paths.js +28 -0
- package/dist/rules/disallow-stylelint-relative-extends-paths.js.map +1 -0
- package/dist/rules/disallow-stylelint-relative-plugin-paths.d.ts +9 -0
- package/dist/rules/disallow-stylelint-relative-plugin-paths.d.ts.map +1 -0
- package/dist/rules/disallow-stylelint-relative-plugin-paths.js +28 -0
- package/dist/rules/disallow-stylelint-relative-plugin-paths.js.map +1 -0
- package/dist/rules/prefer-stylelint-cache.d.ts +9 -0
- package/dist/rules/prefer-stylelint-cache.d.ts.map +1 -0
- package/dist/rules/prefer-stylelint-cache.js +28 -0
- package/dist/rules/prefer-stylelint-cache.js.map +1 -0
- package/dist/rules/prefer-stylelint-define-config.d.ts +7 -0
- package/dist/rules/prefer-stylelint-define-config.d.ts.map +1 -0
- package/dist/rules/prefer-stylelint-define-config.js +82 -0
- package/dist/rules/prefer-stylelint-define-config.js.map +1 -0
- package/dist/rules/prefer-stylelint-extends-array.d.ts +9 -0
- package/dist/rules/prefer-stylelint-extends-array.d.ts.map +1 -0
- package/dist/rules/prefer-stylelint-extends-array.js +29 -0
- package/dist/rules/prefer-stylelint-extends-array.js.map +1 -0
- package/dist/rules/prefer-stylelint-fix.d.ts +7 -0
- package/dist/rules/prefer-stylelint-fix.d.ts.map +1 -0
- package/dist/rules/prefer-stylelint-fix.js +90 -0
- package/dist/rules/prefer-stylelint-fix.js.map +1 -0
- package/dist/rules/prefer-stylelint-formatter.d.ts +10 -0
- package/dist/rules/prefer-stylelint-formatter.d.ts.map +1 -0
- package/dist/rules/prefer-stylelint-formatter.js +77 -0
- package/dist/rules/prefer-stylelint-formatter.js.map +1 -0
- package/dist/rules/prefer-stylelint-plugins-array.d.ts +9 -0
- package/dist/rules/prefer-stylelint-plugins-array.d.ts.map +1 -0
- package/dist/rules/prefer-stylelint-plugins-array.js +29 -0
- package/dist/rules/prefer-stylelint-plugins-array.js.map +1 -0
- package/dist/rules/prefer-stylelint-report-descriptionless-disables.d.ts +12 -0
- package/dist/rules/prefer-stylelint-report-descriptionless-disables.d.ts.map +1 -0
- package/dist/rules/prefer-stylelint-report-descriptionless-disables.js +32 -0
- package/dist/rules/prefer-stylelint-report-descriptionless-disables.js.map +1 -0
- package/dist/rules/prefer-stylelint-report-invalid-scope-disables.d.ts +12 -0
- package/dist/rules/prefer-stylelint-report-invalid-scope-disables.d.ts.map +1 -0
- package/dist/rules/prefer-stylelint-report-invalid-scope-disables.js +32 -0
- package/dist/rules/prefer-stylelint-report-invalid-scope-disables.js.map +1 -0
- package/dist/rules/prefer-stylelint-report-needless-disables.d.ts +9 -0
- package/dist/rules/prefer-stylelint-report-needless-disables.d.ts.map +1 -0
- package/dist/rules/prefer-stylelint-report-needless-disables.js +29 -0
- package/dist/rules/prefer-stylelint-report-needless-disables.js.map +1 -0
- package/dist/rules/prefer-stylelint-report-unscoped-disables.d.ts +9 -0
- package/dist/rules/prefer-stylelint-report-unscoped-disables.d.ts.map +1 -0
- package/dist/rules/prefer-stylelint-report-unscoped-disables.js +29 -0
- package/dist/rules/prefer-stylelint-report-unscoped-disables.js.map +1 -0
- package/dist/rules/require-stylelint-config-file-naming-convention.d.ts +13 -0
- package/dist/rules/require-stylelint-config-file-naming-convention.d.ts.map +1 -0
- package/dist/rules/require-stylelint-config-file-naming-convention.js +58 -0
- package/dist/rules/require-stylelint-config-file-naming-convention.js.map +1 -0
- package/dist/rules/require-stylelint-custom-syntax-in-overrides.d.ts +7 -0
- package/dist/rules/require-stylelint-custom-syntax-in-overrides.d.ts.map +1 -0
- package/dist/rules/require-stylelint-custom-syntax-in-overrides.js +100 -0
- package/dist/rules/require-stylelint-custom-syntax-in-overrides.js.map +1 -0
- package/dist/rules/require-stylelint-extends-packages-installed.d.ts +12 -0
- package/dist/rules/require-stylelint-extends-packages-installed.d.ts.map +1 -0
- package/dist/rules/require-stylelint-extends-packages-installed.js +31 -0
- package/dist/rules/require-stylelint-extends-packages-installed.js.map +1 -0
- package/dist/rules/require-stylelint-overrides-configuration.d.ts +7 -0
- package/dist/rules/require-stylelint-overrides-configuration.d.ts.map +1 -0
- package/dist/rules/require-stylelint-overrides-configuration.js +100 -0
- package/dist/rules/require-stylelint-overrides-configuration.js.map +1 -0
- package/dist/rules/require-stylelint-overrides-files-array.d.ts +7 -0
- package/dist/rules/require-stylelint-overrides-files-array.d.ts.map +1 -0
- package/dist/rules/require-stylelint-overrides-files-array.js +99 -0
- package/dist/rules/require-stylelint-overrides-files-array.js.map +1 -0
- package/dist/rules/require-stylelint-overrides-files.d.ts +7 -0
- package/dist/rules/require-stylelint-overrides-files.d.ts.map +1 -0
- package/dist/rules/require-stylelint-overrides-files.js +104 -0
- package/dist/rules/require-stylelint-overrides-files.js.map +1 -0
- package/dist/rules/require-stylelint-plugins-packages-installed.d.ts +12 -0
- package/dist/rules/require-stylelint-plugins-packages-installed.d.ts.map +1 -0
- package/dist/rules/require-stylelint-plugins-packages-installed.js +31 -0
- package/dist/rules/require-stylelint-plugins-packages-installed.js.map +1 -0
- package/dist/rules/require-stylelint-report-disables.d.ts +9 -0
- package/dist/rules/require-stylelint-report-disables.d.ts.map +1 -0
- package/dist/rules/require-stylelint-report-disables.js +29 -0
- package/dist/rules/require-stylelint-report-disables.js.map +1 -0
- package/dist/rules/require-stylelint-rules-object.d.ts +7 -0
- package/dist/rules/require-stylelint-rules-object.d.ts.map +1 -0
- package/dist/rules/require-stylelint-rules-object.js +65 -0
- package/dist/rules/require-stylelint-rules-object.js.map +1 -0
- package/dist/rules/sort-stylelint-extends.d.ts +9 -0
- package/dist/rules/sort-stylelint-extends.d.ts.map +1 -0
- package/dist/rules/sort-stylelint-extends.js +28 -0
- package/dist/rules/sort-stylelint-extends.js.map +1 -0
- package/dist/rules/sort-stylelint-plugins.d.ts +9 -0
- package/dist/rules/sort-stylelint-plugins.d.ts.map +1 -0
- package/dist/rules/sort-stylelint-plugins.js +28 -0
- package/dist/rules/sort-stylelint-plugins.js.map +1 -0
- package/dist/rules/sort-stylelint-rule-keys.d.ts +7 -0
- package/dist/rules/sort-stylelint-rule-keys.d.ts.map +1 -0
- package/dist/rules/sort-stylelint-rule-keys.js +129 -0
- package/dist/rules/sort-stylelint-rule-keys.js.map +1 -0
- package/dist/rules/stylelint.d.ts +15 -0
- package/dist/rules/stylelint.d.ts.map +1 -0
- package/dist/rules/stylelint.js +157 -0
- package/dist/rules/stylelint.js.map +1 -0
- package/docs/rules/disallow-stylelint-allow-empty-input.md +62 -0
- package/docs/rules/disallow-stylelint-configuration-comment.md +62 -0
- package/docs/rules/disallow-stylelint-custom-syntax.md +70 -0
- package/docs/rules/disallow-stylelint-default-severity.md +77 -0
- package/docs/rules/disallow-stylelint-duplicate-extends.md +61 -0
- package/docs/rules/disallow-stylelint-duplicate-plugins.md +61 -0
- package/docs/rules/disallow-stylelint-duplicate-rule-option-values.md +73 -0
- package/docs/rules/disallow-stylelint-empty-rules-object.md +62 -0
- package/docs/rules/disallow-stylelint-ignore-disables.md +78 -0
- package/docs/rules/disallow-stylelint-ignore-files.md +78 -0
- package/docs/rules/disallow-stylelint-null-rule-config.md +63 -0
- package/docs/rules/disallow-stylelint-overrides-runtime-options.md +82 -0
- package/docs/rules/disallow-stylelint-processors.md +62 -0
- package/docs/rules/disallow-stylelint-relative-extends-paths.md +61 -0
- package/docs/rules/disallow-stylelint-relative-plugin-paths.md +61 -0
- package/docs/rules/getting-started.md +130 -0
- package/docs/rules/overview.md +99 -0
- package/docs/rules/prefer-stylelint-cache.md +79 -0
- package/docs/rules/prefer-stylelint-define-config.md +90 -0
- package/docs/rules/prefer-stylelint-extends-array.md +61 -0
- package/docs/rules/prefer-stylelint-fix.md +79 -0
- package/docs/rules/prefer-stylelint-formatter.md +80 -0
- package/docs/rules/prefer-stylelint-plugins-array.md +61 -0
- package/docs/rules/prefer-stylelint-report-descriptionless-disables.md +85 -0
- package/docs/rules/prefer-stylelint-report-invalid-scope-disables.md +83 -0
- package/docs/rules/prefer-stylelint-report-needless-disables.md +83 -0
- package/docs/rules/prefer-stylelint-report-unscoped-disables.md +83 -0
- package/docs/rules/presets/all.md +39 -0
- package/docs/rules/presets/configs.md +40 -0
- package/docs/rules/presets/configuration.md +64 -0
- package/docs/rules/presets/index.md +82 -0
- package/docs/rules/presets/recommended.md +40 -0
- package/docs/rules/presets/stylelint-only.md +42 -0
- package/docs/rules/require-stylelint-config-file-naming-convention.md +61 -0
- package/docs/rules/require-stylelint-custom-syntax-in-overrides.md +77 -0
- package/docs/rules/require-stylelint-extends-packages-installed.md +61 -0
- package/docs/rules/require-stylelint-overrides-configuration.md +80 -0
- package/docs/rules/require-stylelint-overrides-files-array.md +78 -0
- package/docs/rules/require-stylelint-overrides-files.md +83 -0
- package/docs/rules/require-stylelint-plugins-packages-installed.md +61 -0
- package/docs/rules/require-stylelint-report-disables.md +67 -0
- package/docs/rules/require-stylelint-rules-object.md +61 -0
- package/docs/rules/sort-stylelint-extends.md +61 -0
- package/docs/rules/sort-stylelint-plugins.md +61 -0
- package/docs/rules/sort-stylelint-rule-keys.md +65 -0
- package/docs/rules/stylelint.md +100 -0
- package/package.json +577 -0
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# prefer-stylelint-report-descriptionless-disables
|
|
2
|
+
|
|
3
|
+
Require enabling Stylelint's `reportDescriptionlessDisables` config option in authored Stylelint config files.
|
|
4
|
+
|
|
5
|
+
## Targeted pattern scope
|
|
6
|
+
|
|
7
|
+
This rule targets Stylelint config modules such as `stylelint.config.ts`, `stylelint.config.mjs`, and `.stylelintrc.js`.
|
|
8
|
+
|
|
9
|
+
It focuses on top-level exported config objects, including configs wrapped in `defineConfig(...)`.
|
|
10
|
+
|
|
11
|
+
## What this rule reports
|
|
12
|
+
|
|
13
|
+
This rule reports Stylelint config objects when `reportDescriptionlessDisables` is:
|
|
14
|
+
|
|
15
|
+
- missing
|
|
16
|
+
- explicitly `false`
|
|
17
|
+
- configured as an array whose primary option is not `true`
|
|
18
|
+
|
|
19
|
+
## Why this rule exists
|
|
20
|
+
|
|
21
|
+
Stylelint already ships a built-in config option for reporting disable comments that do not explain why a rule was turned off.
|
|
22
|
+
|
|
23
|
+
Enabling that option improves review quality because disable comments stop being silent escapes with no context.
|
|
24
|
+
|
|
25
|
+
## ❌ Incorrect
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
export default {
|
|
29
|
+
rules: {
|
|
30
|
+
"color-no-invalid-hex": true,
|
|
31
|
+
},
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## ✅ Correct
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
export default {
|
|
39
|
+
reportDescriptionlessDisables: true,
|
|
40
|
+
rules: {
|
|
41
|
+
"color-no-invalid-hex": true,
|
|
42
|
+
},
|
|
43
|
+
};
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Behavior and migration notes
|
|
47
|
+
|
|
48
|
+
- Missing properties are autofixed by inserting `reportDescriptionlessDisables: true`.
|
|
49
|
+
- `false` values are autofixed to `true`.
|
|
50
|
+
- Array-form values preserve the secondary options object while rewriting the primary option to `true`.
|
|
51
|
+
|
|
52
|
+
## Additional examples
|
|
53
|
+
|
|
54
|
+
### ✅ Correct — keep secondary options
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
export default {
|
|
58
|
+
reportDescriptionlessDisables: [true, { severity: "warning" }],
|
|
59
|
+
};
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## ESLint flat config example
|
|
63
|
+
|
|
64
|
+
```ts
|
|
65
|
+
import stylelint2 from "eslint-plugin-stylelint-2";
|
|
66
|
+
|
|
67
|
+
export default [
|
|
68
|
+
stylelint2.configs.configuration,
|
|
69
|
+
];
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## When not to use it
|
|
73
|
+
|
|
74
|
+
Do not use this rule if your team intentionally allows undocumented Stylelint disable comments and does not want Stylelint to report them.
|
|
75
|
+
|
|
76
|
+
## Package documentation
|
|
77
|
+
|
|
78
|
+
Stylelint package documentation:
|
|
79
|
+
|
|
80
|
+
> **Rule catalog ID:** R003
|
|
81
|
+
|
|
82
|
+
## Further reading
|
|
83
|
+
|
|
84
|
+
- [Stylelint ignore-code guide](https://stylelint.io/user-guide/ignore-code/)
|
|
85
|
+
- [Stylelint configuring guide](https://stylelint.io/user-guide/configure/#reportdescriptionlessdisables)
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# prefer-stylelint-report-invalid-scope-disables
|
|
2
|
+
|
|
3
|
+
Require enabling Stylelint's `reportInvalidScopeDisables` config option in authored Stylelint config files.
|
|
4
|
+
|
|
5
|
+
## Targeted pattern scope
|
|
6
|
+
|
|
7
|
+
This rule targets Stylelint config modules such as `stylelint.config.ts`, `stylelint.config.mjs`, and `.stylelintrc.js`.
|
|
8
|
+
|
|
9
|
+
It focuses on top-level exported config objects, including configs wrapped in `defineConfig(...)`.
|
|
10
|
+
|
|
11
|
+
## What this rule reports
|
|
12
|
+
|
|
13
|
+
This rule reports Stylelint config objects when `reportInvalidScopeDisables` is:
|
|
14
|
+
|
|
15
|
+
- missing
|
|
16
|
+
- explicitly `false`
|
|
17
|
+
- configured as an array whose primary option is not `true`
|
|
18
|
+
|
|
19
|
+
## Why this rule exists
|
|
20
|
+
|
|
21
|
+
Stylelint can report disable comments that reference rules outside the active config. That catches stale or mistyped disable comments that silently stop being meaningful.
|
|
22
|
+
|
|
23
|
+
## ❌ Incorrect
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
export default {
|
|
27
|
+
rules: {
|
|
28
|
+
"color-no-invalid-hex": true,
|
|
29
|
+
},
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## ✅ Correct
|
|
34
|
+
|
|
35
|
+
```ts
|
|
36
|
+
export default {
|
|
37
|
+
reportInvalidScopeDisables: true,
|
|
38
|
+
rules: {
|
|
39
|
+
"color-no-invalid-hex": true,
|
|
40
|
+
},
|
|
41
|
+
};
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Behavior and migration notes
|
|
45
|
+
|
|
46
|
+
- Missing properties are autofixed by inserting `reportInvalidScopeDisables: true`.
|
|
47
|
+
- `false` values are autofixed to `true`.
|
|
48
|
+
- Array-form values preserve secondary options while rewriting the primary option to `true`.
|
|
49
|
+
|
|
50
|
+
## Additional examples
|
|
51
|
+
|
|
52
|
+
### ✅ Correct — keep secondary options
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
export default {
|
|
56
|
+
reportInvalidScopeDisables: [true, { severity: "warning" }],
|
|
57
|
+
};
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## ESLint flat config example
|
|
61
|
+
|
|
62
|
+
```ts
|
|
63
|
+
import stylelint2 from "eslint-plugin-stylelint-2";
|
|
64
|
+
|
|
65
|
+
export default [
|
|
66
|
+
stylelint2.configs.configuration,
|
|
67
|
+
];
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## When not to use it
|
|
71
|
+
|
|
72
|
+
Do not use this rule if your team intentionally allows invalid-scope disable comments to pass silently.
|
|
73
|
+
|
|
74
|
+
## Package documentation
|
|
75
|
+
|
|
76
|
+
Stylelint package documentation:
|
|
77
|
+
|
|
78
|
+
> **Rule catalog ID:** R004
|
|
79
|
+
|
|
80
|
+
## Further reading
|
|
81
|
+
|
|
82
|
+
- [Stylelint configuring guide](https://stylelint.io/user-guide/configure/#reportinvalidscopedisables)
|
|
83
|
+
- [Stylelint ignore-code guide](https://stylelint.io/user-guide/ignore-code/)
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# prefer-stylelint-report-needless-disables
|
|
2
|
+
|
|
3
|
+
Require enabling Stylelint's `reportNeedlessDisables` config option in authored Stylelint config files.
|
|
4
|
+
|
|
5
|
+
## Targeted pattern scope
|
|
6
|
+
|
|
7
|
+
This rule targets Stylelint config modules such as `stylelint.config.ts`, `stylelint.config.mjs`, and `.stylelintrc.js`.
|
|
8
|
+
|
|
9
|
+
It focuses on top-level exported config objects, including configs wrapped in `defineConfig(...)`.
|
|
10
|
+
|
|
11
|
+
## What this rule reports
|
|
12
|
+
|
|
13
|
+
This rule reports Stylelint config objects when `reportNeedlessDisables` is:
|
|
14
|
+
|
|
15
|
+
- missing
|
|
16
|
+
- explicitly `false`
|
|
17
|
+
- configured as an array whose primary option is not `true`
|
|
18
|
+
|
|
19
|
+
## Why this rule exists
|
|
20
|
+
|
|
21
|
+
Stylelint can report disable comments that do not suppress any active finding. That helps teams remove stale disable comments instead of letting them accumulate as dead configuration noise.
|
|
22
|
+
|
|
23
|
+
## ❌ Incorrect
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
export default {
|
|
27
|
+
rules: {
|
|
28
|
+
"color-no-invalid-hex": true,
|
|
29
|
+
},
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## ✅ Correct
|
|
34
|
+
|
|
35
|
+
```ts
|
|
36
|
+
export default {
|
|
37
|
+
reportNeedlessDisables: true,
|
|
38
|
+
rules: {
|
|
39
|
+
"color-no-invalid-hex": true,
|
|
40
|
+
},
|
|
41
|
+
};
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Behavior and migration notes
|
|
45
|
+
|
|
46
|
+
- Missing properties are autofixed by inserting `reportNeedlessDisables: true`.
|
|
47
|
+
- `false` values are autofixed to `true`.
|
|
48
|
+
- Array-form values preserve secondary options while rewriting the primary option to `true`.
|
|
49
|
+
|
|
50
|
+
## Additional examples
|
|
51
|
+
|
|
52
|
+
### ✅ Correct — keep secondary options
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
export default {
|
|
56
|
+
reportNeedlessDisables: [true, { severity: "warning" }],
|
|
57
|
+
};
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## ESLint flat config example
|
|
61
|
+
|
|
62
|
+
```ts
|
|
63
|
+
import stylelint2 from "eslint-plugin-stylelint-2";
|
|
64
|
+
|
|
65
|
+
export default [
|
|
66
|
+
stylelint2.configs.configuration,
|
|
67
|
+
];
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## When not to use it
|
|
71
|
+
|
|
72
|
+
Do not use this rule if your team intentionally allows needless disable comments to remain in place without reporting.
|
|
73
|
+
|
|
74
|
+
## Package documentation
|
|
75
|
+
|
|
76
|
+
Stylelint package documentation:
|
|
77
|
+
|
|
78
|
+
> **Rule catalog ID:** R005
|
|
79
|
+
|
|
80
|
+
## Further reading
|
|
81
|
+
|
|
82
|
+
- [Stylelint configuring guide](https://stylelint.io/user-guide/configure/#reportneedlessdisables)
|
|
83
|
+
- [Stylelint ignore-code guide](https://stylelint.io/user-guide/ignore-code/)
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# prefer-stylelint-report-unscoped-disables
|
|
2
|
+
|
|
3
|
+
Require enabling Stylelint's `reportUnscopedDisables` config option in authored Stylelint config files.
|
|
4
|
+
|
|
5
|
+
## Targeted pattern scope
|
|
6
|
+
|
|
7
|
+
This rule targets Stylelint config modules such as `stylelint.config.ts`, `stylelint.config.mjs`, and `.stylelintrc.js`.
|
|
8
|
+
|
|
9
|
+
It focuses on top-level exported config objects, including configs wrapped in `defineConfig(...)`.
|
|
10
|
+
|
|
11
|
+
## What this rule reports
|
|
12
|
+
|
|
13
|
+
This rule reports Stylelint config objects when `reportUnscopedDisables` is:
|
|
14
|
+
|
|
15
|
+
- missing
|
|
16
|
+
- explicitly `false`
|
|
17
|
+
- configured as an array whose primary option is not `true`
|
|
18
|
+
|
|
19
|
+
## Why this rule exists
|
|
20
|
+
|
|
21
|
+
Stylelint can report disable comments that are not scoped to specific rules. Enabling that report helps teams avoid broad, ambiguous disable comments that hide more than they need to.
|
|
22
|
+
|
|
23
|
+
## ❌ Incorrect
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
export default {
|
|
27
|
+
rules: {
|
|
28
|
+
"color-no-invalid-hex": true,
|
|
29
|
+
},
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## ✅ Correct
|
|
34
|
+
|
|
35
|
+
```ts
|
|
36
|
+
export default {
|
|
37
|
+
reportUnscopedDisables: true,
|
|
38
|
+
rules: {
|
|
39
|
+
"color-no-invalid-hex": true,
|
|
40
|
+
},
|
|
41
|
+
};
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Behavior and migration notes
|
|
45
|
+
|
|
46
|
+
- Missing properties are autofixed by inserting `reportUnscopedDisables: true`.
|
|
47
|
+
- `false` values are autofixed to `true`.
|
|
48
|
+
- Array-form values preserve secondary options while rewriting the primary option to `true`.
|
|
49
|
+
|
|
50
|
+
## Additional examples
|
|
51
|
+
|
|
52
|
+
### ✅ Correct — keep secondary options
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
export default {
|
|
56
|
+
reportUnscopedDisables: [true, { severity: "warning" }],
|
|
57
|
+
};
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## ESLint flat config example
|
|
61
|
+
|
|
62
|
+
```ts
|
|
63
|
+
import stylelint2 from "eslint-plugin-stylelint-2";
|
|
64
|
+
|
|
65
|
+
export default [
|
|
66
|
+
stylelint2.configs.configuration,
|
|
67
|
+
];
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## When not to use it
|
|
71
|
+
|
|
72
|
+
Do not use this rule if your team intentionally allows broad unscoped disable comments without reporting them.
|
|
73
|
+
|
|
74
|
+
## Package documentation
|
|
75
|
+
|
|
76
|
+
Stylelint package documentation:
|
|
77
|
+
|
|
78
|
+
> **Rule catalog ID:** R006
|
|
79
|
+
|
|
80
|
+
## Further reading
|
|
81
|
+
|
|
82
|
+
- [Stylelint configuring guide](https://stylelint.io/user-guide/configure/#reportunscopeddisables)
|
|
83
|
+
- [Stylelint ignore-code guide](https://stylelint.io/user-guide/ignore-code/)
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# all
|
|
2
|
+
|
|
3
|
+
`all` enables the stylesheet bridge plus the full configuration-rule catalog, including the more opinionated operational policy rules that `recommended` intentionally leaves out.
|
|
4
|
+
|
|
5
|
+
## Flat config example
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import stylelint2 from "eslint-plugin-stylelint-2";
|
|
9
|
+
|
|
10
|
+
export default [
|
|
11
|
+
...stylelint2.configs.all,
|
|
12
|
+
];
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Related preset docs
|
|
16
|
+
|
|
17
|
+
- [Presets overview](./index.md)
|
|
18
|
+
- [Recommended preset](./recommended.md)
|
|
19
|
+
- [Stylelint-only preset](./stylelint-only.md)
|
|
20
|
+
- [Configuration-only preset](./configuration.md)
|
|
21
|
+
|
|
22
|
+
## Notable rules in this preset
|
|
23
|
+
|
|
24
|
+
For the exhaustive generated rule matrix, see [Presets overview](./index.md).
|
|
25
|
+
|
|
26
|
+
| Rule | Fix |
|
|
27
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :-: |
|
|
28
|
+
| [`stylelint`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/stylelint) | 🔧 |
|
|
29
|
+
| [`prefer-stylelint-cache`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-cache) | 🔧 |
|
|
30
|
+
| [`disallow-stylelint-default-severity`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-default-severity) | 🔧 |
|
|
31
|
+
| [`prefer-stylelint-fix`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-fix) | 🔧 |
|
|
32
|
+
| [`prefer-stylelint-formatter`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-formatter) | — |
|
|
33
|
+
| [`disallow-stylelint-ignore-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-ignore-disables) | 🔧 |
|
|
34
|
+
| [`disallow-stylelint-ignore-files`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-ignore-files) | 🔧 |
|
|
35
|
+
| [`prefer-stylelint-define-config`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-define-config) | 🔧 |
|
|
36
|
+
| [`prefer-stylelint-report-descriptionless-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-descriptionless-disables) | 🔧 |
|
|
37
|
+
| [`prefer-stylelint-report-invalid-scope-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-invalid-scope-disables) | 🔧 |
|
|
38
|
+
| [`prefer-stylelint-report-needless-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-needless-disables) | 🔧 |
|
|
39
|
+
| [`prefer-stylelint-report-unscoped-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-unscoped-disables) | 🔧 |
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# configs
|
|
2
|
+
|
|
3
|
+
Legacy alias page for the preferred `configuration` preset.
|
|
4
|
+
|
|
5
|
+
Use [`stylelint2.configs.configuration`](./configuration.md) for new documentation and examples.
|
|
6
|
+
|
|
7
|
+
`stylelint2.configs.configs` remains supported as a backwards-compatible alias.
|
|
8
|
+
|
|
9
|
+
## Flat config example
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
import stylelint2 from "eslint-plugin-stylelint-2";
|
|
13
|
+
|
|
14
|
+
export default [
|
|
15
|
+
stylelint2.configs.configs,
|
|
16
|
+
];
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Preferred docs
|
|
20
|
+
|
|
21
|
+
- [Configuration-only preset](./configuration.md)
|
|
22
|
+
- [Presets overview](./index.md)
|
|
23
|
+
|
|
24
|
+
## Notable rules in this preset
|
|
25
|
+
|
|
26
|
+
For the exhaustive generated rule matrix, see [Configuration-only preset](./configuration.md) and [Presets overview](./index.md).
|
|
27
|
+
|
|
28
|
+
| Rule | Fix |
|
|
29
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :-: |
|
|
30
|
+
| [`prefer-stylelint-cache`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-cache) | 🔧 |
|
|
31
|
+
| [`disallow-stylelint-default-severity`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-default-severity) | 🔧 |
|
|
32
|
+
| [`prefer-stylelint-fix`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-fix) | 🔧 |
|
|
33
|
+
| [`prefer-stylelint-formatter`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-formatter) | — |
|
|
34
|
+
| [`disallow-stylelint-ignore-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-ignore-disables) | 🔧 |
|
|
35
|
+
| [`disallow-stylelint-ignore-files`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-ignore-files) | 🔧 |
|
|
36
|
+
| [`prefer-stylelint-define-config`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-define-config) | 🔧 |
|
|
37
|
+
| [`prefer-stylelint-report-descriptionless-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-descriptionless-disables) | 🔧 |
|
|
38
|
+
| [`prefer-stylelint-report-invalid-scope-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-invalid-scope-disables) | 🔧 |
|
|
39
|
+
| [`prefer-stylelint-report-needless-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-needless-disables) | 🔧 |
|
|
40
|
+
| [`prefer-stylelint-report-unscoped-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-unscoped-disables) | 🔧 |
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# configuration
|
|
2
|
+
|
|
3
|
+
Enable only the full Stylelint configuration-authoring workflow.
|
|
4
|
+
|
|
5
|
+
Use this preset when you want to lint `stylelint.config.*` and `.stylelintrc.*` files for config hygiene, but you do **not** want the stylesheet bridge, source CSS linting, or Stylelint autofix bridging enabled in the same preset.
|
|
6
|
+
|
|
7
|
+
## Flat config example
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import stylelint2 from "eslint-plugin-stylelint-2";
|
|
11
|
+
|
|
12
|
+
export default [
|
|
13
|
+
stylelint2.configs.configuration,
|
|
14
|
+
];
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
> Legacy alias: `stylelint2.configs.configs` remains supported for backwards compatibility.
|
|
18
|
+
|
|
19
|
+
## What this preset includes
|
|
20
|
+
|
|
21
|
+
- `stylelint-2/prefer-stylelint-cache`
|
|
22
|
+
- `stylelint-2/disallow-stylelint-default-severity`
|
|
23
|
+
- `stylelint-2/prefer-stylelint-fix`
|
|
24
|
+
- `stylelint-2/prefer-stylelint-formatter`
|
|
25
|
+
- `stylelint-2/disallow-stylelint-ignore-disables`
|
|
26
|
+
- `stylelint-2/disallow-stylelint-ignore-files`
|
|
27
|
+
- `stylelint-2/prefer-stylelint-define-config`
|
|
28
|
+
- `stylelint-2/prefer-stylelint-report-descriptionless-disables`
|
|
29
|
+
- `stylelint-2/prefer-stylelint-report-invalid-scope-disables`
|
|
30
|
+
- `stylelint-2/prefer-stylelint-report-needless-disables`
|
|
31
|
+
- `stylelint-2/prefer-stylelint-report-unscoped-disables`
|
|
32
|
+
- `stylelint-2/require-stylelint-overrides-configuration`
|
|
33
|
+
- `stylelint-2/require-stylelint-overrides-files-array`
|
|
34
|
+
|
|
35
|
+
## What this preset does not include
|
|
36
|
+
|
|
37
|
+
- No CSS `stylelint-2/stylelint` bridge rule
|
|
38
|
+
- No stylesheet linting for `**/*.css`
|
|
39
|
+
- No Stylelint autofix bridge for source CSS files
|
|
40
|
+
|
|
41
|
+
## Related preset docs
|
|
42
|
+
|
|
43
|
+
- [Presets overview](./index.md)
|
|
44
|
+
- [Recommended preset](./recommended.md)
|
|
45
|
+
- [Stylelint-only preset](./stylelint-only.md)
|
|
46
|
+
- [All preset](./all.md)
|
|
47
|
+
|
|
48
|
+
## Notable rules in this preset
|
|
49
|
+
|
|
50
|
+
For the exhaustive generated rule matrix, see [Presets overview](./index.md).
|
|
51
|
+
|
|
52
|
+
| Rule | Fix |
|
|
53
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :-: |
|
|
54
|
+
| [`prefer-stylelint-cache`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-cache) | 🔧 |
|
|
55
|
+
| [`disallow-stylelint-default-severity`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-default-severity) | 🔧 |
|
|
56
|
+
| [`prefer-stylelint-fix`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-fix) | 🔧 |
|
|
57
|
+
| [`prefer-stylelint-formatter`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-formatter) | — |
|
|
58
|
+
| [`disallow-stylelint-ignore-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-ignore-disables) | 🔧 |
|
|
59
|
+
| [`disallow-stylelint-ignore-files`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-ignore-files) | 🔧 |
|
|
60
|
+
| [`prefer-stylelint-define-config`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-define-config) | 🔧 |
|
|
61
|
+
| [`prefer-stylelint-report-descriptionless-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-descriptionless-disables) | 🔧 |
|
|
62
|
+
| [`prefer-stylelint-report-invalid-scope-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-invalid-scope-disables) | 🔧 |
|
|
63
|
+
| [`prefer-stylelint-report-needless-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-needless-disables) | 🔧 |
|
|
64
|
+
| [`prefer-stylelint-report-unscoped-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-unscoped-disables) | 🔧 |
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Presets
|
|
3
|
+
description: Preset reference for eslint-plugin-stylelint-2.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Presets
|
|
7
|
+
|
|
8
|
+
The plugin currently exposes four presets:
|
|
9
|
+
|
|
10
|
+
- `stylelint2.configs.recommended`
|
|
11
|
+
- `stylelint2.configs.stylelintOnly`
|
|
12
|
+
- `stylelint2.configs.configuration`
|
|
13
|
+
- `stylelint2.configs.all`
|
|
14
|
+
|
|
15
|
+
Legacy aliases remain available:
|
|
16
|
+
|
|
17
|
+
- `stylelint2.configs.stylesheets` → `stylelint2.configs.stylelintOnly`
|
|
18
|
+
- `stylelint2.configs.configs` → `stylelint2.configs.configuration`
|
|
19
|
+
|
|
20
|
+
## Preset setup guides
|
|
21
|
+
|
|
22
|
+
Use the setup page for the preset you want to enable:
|
|
23
|
+
|
|
24
|
+
| Preset | Purpose | Setup page |
|
|
25
|
+
| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
26
|
+
| [`stylelint2.configs.recommended`](./recommended.md) | Enable both stylesheet linting and Stylelint config authoring guidance. | [Recommended preset guide](./recommended.md) |
|
|
27
|
+
| [`stylelint2.configs.stylelintOnly`](./stylelint-only.md) | Enable only the Stylelint bridge workflow for stylesheets and ESLint-side autofix. | [Stylelint-only preset guide](./stylelint-only.md) |
|
|
28
|
+
| [`stylelint2.configs.configuration`](./configuration.md) | Lint only Stylelint config modules and disable-comment reporting settings, with no stylesheet bridge. | [Configuration-only preset guide](./configuration.md) |
|
|
29
|
+
| [`stylelint2.configs.all`](./all.md) | Enable every preset entry currently shipped by this plugin. | [All preset guide](./all.md) |
|
|
30
|
+
|
|
31
|
+
## Rule matrix
|
|
32
|
+
|
|
33
|
+
Fix legend:
|
|
34
|
+
- `🔧` = autofixable
|
|
35
|
+
- `—` = report only
|
|
36
|
+
|
|
37
|
+
Preset key legend:
|
|
38
|
+
- [`🟡`](./recommended.md) — [`stylelint2.configs.recommended`](./recommended.md)
|
|
39
|
+
- [`🎨`](./stylelint-only.md) — [`stylelint2.configs.stylelintOnly`](./stylelint-only.md)
|
|
40
|
+
- [`🔧`](./configuration.md) — [`stylelint2.configs.configuration`](./configuration.md)
|
|
41
|
+
- [`🟣`](./all.md) — [`stylelint2.configs.all`](./all.md)
|
|
42
|
+
|
|
43
|
+
| Rule | Fix | Preset key |
|
|
44
|
+
| --- | :-: | :-- |
|
|
45
|
+
| [`stylelint`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/stylelint) | 🔧 | [🟡](./recommended.md) [🎨](./stylelint-only.md) [🟣](./all.md) |
|
|
46
|
+
| [`disallow-stylelint-allow-empty-input`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-allow-empty-input) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
47
|
+
| [`disallow-stylelint-configuration-comment`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-configuration-comment) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
48
|
+
| [`disallow-stylelint-custom-syntax`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-custom-syntax) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
49
|
+
| [`disallow-stylelint-default-severity`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-default-severity) | 🔧 | [🔧](./configuration.md) [🟣](./all.md) |
|
|
50
|
+
| [`disallow-stylelint-duplicate-extends`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-duplicate-extends) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
51
|
+
| [`disallow-stylelint-duplicate-plugins`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-duplicate-plugins) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
52
|
+
| [`disallow-stylelint-duplicate-rule-option-values`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-duplicate-rule-option-values) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
53
|
+
| [`disallow-stylelint-empty-rules-object`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-empty-rules-object) | — | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
54
|
+
| [`disallow-stylelint-ignore-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-ignore-disables) | 🔧 | [🔧](./configuration.md) [🟣](./all.md) |
|
|
55
|
+
| [`disallow-stylelint-ignore-files`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-ignore-files) | 🔧 | [🔧](./configuration.md) [🟣](./all.md) |
|
|
56
|
+
| [`disallow-stylelint-null-rule-config`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-null-rule-config) | — | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
57
|
+
| [`disallow-stylelint-overrides-runtime-options`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-overrides-runtime-options) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
58
|
+
| [`disallow-stylelint-processors`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-processors) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
59
|
+
| [`disallow-stylelint-relative-extends-paths`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-relative-extends-paths) | — | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
60
|
+
| [`disallow-stylelint-relative-plugin-paths`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/disallow-stylelint-relative-plugin-paths) | — | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
61
|
+
| [`prefer-stylelint-cache`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-cache) | 🔧 | [🔧](./configuration.md) [🟣](./all.md) |
|
|
62
|
+
| [`prefer-stylelint-define-config`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-define-config) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
63
|
+
| [`prefer-stylelint-extends-array`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-extends-array) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
64
|
+
| [`prefer-stylelint-fix`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-fix) | 🔧 | [🔧](./configuration.md) [🟣](./all.md) |
|
|
65
|
+
| [`prefer-stylelint-formatter`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-formatter) | — | [🔧](./configuration.md) [🟣](./all.md) |
|
|
66
|
+
| [`prefer-stylelint-plugins-array`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-plugins-array) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
67
|
+
| [`prefer-stylelint-report-descriptionless-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-descriptionless-disables) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
68
|
+
| [`prefer-stylelint-report-invalid-scope-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-invalid-scope-disables) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
69
|
+
| [`prefer-stylelint-report-needless-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-needless-disables) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
70
|
+
| [`prefer-stylelint-report-unscoped-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-unscoped-disables) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
71
|
+
| [`require-stylelint-custom-syntax-in-overrides`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/require-stylelint-custom-syntax-in-overrides) | — | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
72
|
+
| [`require-stylelint-config-file-naming-convention`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/require-stylelint-config-file-naming-convention) | — | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
73
|
+
| [`require-stylelint-extends-packages-installed`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/require-stylelint-extends-packages-installed) | — | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
74
|
+
| [`require-stylelint-overrides-configuration`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/require-stylelint-overrides-configuration) | — | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
75
|
+
| [`require-stylelint-overrides-files-array`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/require-stylelint-overrides-files-array) | — | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
76
|
+
| [`require-stylelint-overrides-files`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/require-stylelint-overrides-files) | — | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
77
|
+
| [`require-stylelint-plugins-packages-installed`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/require-stylelint-plugins-packages-installed) | — | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
78
|
+
| [`require-stylelint-report-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/require-stylelint-report-disables) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
79
|
+
| [`require-stylelint-rules-object`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/require-stylelint-rules-object) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
80
|
+
| [`sort-stylelint-extends`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/sort-stylelint-extends) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
81
|
+
| [`sort-stylelint-plugins`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/sort-stylelint-plugins) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
82
|
+
| [`sort-stylelint-rule-keys`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/sort-stylelint-rule-keys) | 🔧 | [🟡](./recommended.md) [🔧](./configuration.md) [🟣](./all.md) |
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# recommended
|
|
2
|
+
|
|
3
|
+
Enable both primary workflows in `eslint-plugin-stylelint-2`:
|
|
4
|
+
|
|
5
|
+
- run the Stylelint bridge from ESLint for stylesheet files
|
|
6
|
+
- enforce the broadly useful Stylelint configuration-authoring rules in config modules
|
|
7
|
+
|
|
8
|
+
Use this preset when you want the default rollout path without opting into every operational or repository-specific Stylelint config preference.
|
|
9
|
+
|
|
10
|
+
`recommended` intentionally leaves out the more opinionated policy rules around cache defaults, formatter defaults, autofix defaults, global ignore globs, disable-comment bypasses, and global default severity.
|
|
11
|
+
|
|
12
|
+
## Flat config example
|
|
13
|
+
|
|
14
|
+
```ts
|
|
15
|
+
import stylelint2 from "eslint-plugin-stylelint-2";
|
|
16
|
+
|
|
17
|
+
export default [
|
|
18
|
+
...stylelint2.configs.recommended,
|
|
19
|
+
];
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Related preset docs
|
|
23
|
+
|
|
24
|
+
- [Presets overview](./index.md)
|
|
25
|
+
- [Stylelint-only preset](./stylelint-only.md)
|
|
26
|
+
- [Configuration-only preset](./configuration.md)
|
|
27
|
+
- [All preset](./all.md)
|
|
28
|
+
|
|
29
|
+
## Notable rules in this preset
|
|
30
|
+
|
|
31
|
+
For the exhaustive generated rule matrix, see [Presets overview](./index.md).
|
|
32
|
+
|
|
33
|
+
| Rule | Fix |
|
|
34
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :-: |
|
|
35
|
+
| [`stylelint`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/stylelint) | 🔧 |
|
|
36
|
+
| [`prefer-stylelint-define-config`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-define-config) | 🔧 |
|
|
37
|
+
| [`prefer-stylelint-report-descriptionless-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-descriptionless-disables) | 🔧 |
|
|
38
|
+
| [`prefer-stylelint-report-invalid-scope-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-invalid-scope-disables) | 🔧 |
|
|
39
|
+
| [`prefer-stylelint-report-needless-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-needless-disables) | 🔧 |
|
|
40
|
+
| [`prefer-stylelint-report-unscoped-disables`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/prefer-stylelint-report-unscoped-disables) | 🔧 |
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# stylelintOnly
|
|
2
|
+
|
|
3
|
+
Enable only the stylesheet-facing Stylelint bridge workflow.
|
|
4
|
+
|
|
5
|
+
This preset is the clearest choice when you want Stylelint diagnostics and autofixes to flow through ESLint, but you do **not** want any Stylelint config-authoring rules in the same preset.
|
|
6
|
+
|
|
7
|
+
## Flat config example
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import stylelint2 from "eslint-plugin-stylelint-2";
|
|
11
|
+
|
|
12
|
+
export default [
|
|
13
|
+
stylelint2.configs.stylelintOnly,
|
|
14
|
+
];
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
> Legacy alias: `stylelint2.configs.stylesheets` remains supported for backwards compatibility.
|
|
18
|
+
|
|
19
|
+
## What this preset includes
|
|
20
|
+
|
|
21
|
+
- `stylelint-2/stylelint`
|
|
22
|
+
- stylesheet files only (`**/*.css`)
|
|
23
|
+
- Stylelint edit info surfaced through `eslint --fix` when available
|
|
24
|
+
|
|
25
|
+
## What this preset does not include
|
|
26
|
+
|
|
27
|
+
- No Stylelint config-module rules
|
|
28
|
+
- No `defineConfig()` authoring checks
|
|
29
|
+
- No disable-comment reporting checks for config files
|
|
30
|
+
|
|
31
|
+
## Related preset docs
|
|
32
|
+
|
|
33
|
+
- [Presets overview](./index.md)
|
|
34
|
+
- [Recommended preset](./recommended.md)
|
|
35
|
+
- [Configuration-only preset](./configuration.md)
|
|
36
|
+
- [All preset](./all.md)
|
|
37
|
+
|
|
38
|
+
## Rules in this preset
|
|
39
|
+
|
|
40
|
+
| Rule | Fix |
|
|
41
|
+
| ------------------------------------------------------------------------------------------ | :-: |
|
|
42
|
+
| [`stylelint`](https://nick2bad4u.github.io/eslint-plugin-stylelint-2/docs/rules/stylelint) | 🔧 |
|