Add and share SeverityString type

Author: karlhorky

lib/configs/rules/all.ts

@@ -1,7 +1,8 @@
 import { rules as ruleLint } from "../../all-rules"
+import type { SeverityString } from "../../types"
 import { rules as recommendedRules } from "./recommended"
 
-const all: Record<string, string> = {}
+const all: Record<string, SeverityString> = {}
 for (const rule of ruleLint) {
     all[rule.meta.docs.ruleId] = "error"
 }

lib/configs/rules/recommended.ts

@@ -1,4 +1,6 @@
-export const rules = {
+import type { SeverityString } from "../../types"
+
+export const rules: Record<string, SeverityString> = {
     // ESLint core rules
     "no-control-regex": "error",
     "no-misleading-character-class": "error",
@@ -70,4 +72,4 @@ export const rules = {
     "regexp/sort-flags": "error",
     "regexp/strict": "error",
     "regexp/use-ignore-case": "error",
-} as const
+}

lib/types.ts

@@ -13,6 +13,8 @@ export type RuleCategory =
     | "Best Practices"
     | "Stylistic Issues"
 
+export type SeverityString = "error" | "warn" | "off"
+
 export interface RuleMetaData {
     docs: {
         description: string
@@ -21,7 +23,7 @@ export interface RuleMetaData {
         url: string
         ruleId: string
         ruleName: string
-        default?: "error" | "warn"
+        default?: Exclude<SeverityString, "off">
     }
     messages: { [messageId: string]: string }
     fixable?: "code" | "whitespace"
@@ -42,7 +44,7 @@ export interface PartialRuleMetaData {
         description: string
         category: RuleCategory
         recommended: boolean
-        default?: "error" | "warn"
+        default?: Exclude<SeverityString, "off">
     }
     messages: { [messageId: string]: string }
     fixable?: "code" | "whitespace"

tools/update-rulesets.ts

@@ -14,7 +14,9 @@ const coreRules = [
     // "require-unicode-regexp", // modern
 ]
 
-const content = `export const rules = {
+const content = `import type { SeverityString } from "../../types"
+
+export const rules: Record<string, SeverityString> = {
     // ESLint core rules
     ${coreRules.map((ruleName) => `"${ruleName}": "error"`).join(",\n    ")},
     // The ESLint rule will report fewer cases than our rule