Skip to content

Commit d4a8aa8

Browse files
committed
Add detailed documentation for rule override behavior in preset generation
- Expanded RULE_OVERRIDES comment to explain default behavior for rules without overrides - Added documentation for how Problem vs non-Problem rules get default severity levels - Clarified how rules with/without config schemas are handled by default - Improved examples to distinguish between severity-only and severity+config overrides
1 parent d6bc6e5 commit d4a8aa8

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

tasks/generate-presets.ts

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,17 @@ import {
1919
const __dirname = path.dirname(fileURLToPath(import.meta.url));
2020

2121
/**
22-
* Override severity or config for specific rules in preset generation.
23-
* If you want to change the default severity or config for a rule, add it here.
22+
* Override the default severity or configuration for specific rules in preset generation.
2423
*
25-
* Examples:
26-
* - 'rule-name': 'error' (Override severity only).
27-
* - 'rule-name': ['warn', { option: true }] (Override severity with config).
24+
* **Default behavior (without overrides):**
25+
* - `Problem` type rules → severity: `"error"`.
26+
* - Other type rules → severity: `"warn"`.
27+
* - Rules with a config schema → `[severity, ...defaultConfig]`.
28+
* - Rules without config → just the severity string.
29+
*
30+
* **Examples:**
31+
* - `'rule-name': 'error'` - Override severity only (keeps default config if one exists).
32+
* - `'rule-name': ['warn', { option: true }]` - Override severity AND config.
2833
*/
2934
const RULE_OVERRIDES: Readonly<Record<string, LinterRuleConfig>> = {
3035
// TODO: Add overrides here

0 commit comments

Comments
 (0)