fix: crash when used with eslint v9.15 (#378)

ota-meshi · web-flow · commit e46de35da1e4 · 2024-11-18T10:08:09.000+09:00
diff --git a/.changeset/rare-avocados-grin.md b/.changeset/rare-avocados-grin.md
@@ -0,0 +1,5 @@
+---
+"eslint-plugin-jsonc": patch
+---
+
+fix: crash when used with eslint v9.15
diff --git a/lib/rules/auto.ts b/lib/rules/auto.ts
@@ -1,4 +1,4 @@
-import type { BaseRuleListener, RuleModule } from "../types";
+import type { BaseRuleListener, PartialRuleModule, RuleModule } from "../types";
 import { createRule } from "../utils";
 import { getAutoConfig } from "../utils/get-auto-jsonc-rules-config";
 
@@ -30,7 +30,7 @@ export default createRule("auto", {
       ).default;
       const subContext: any = {
         __proto__: context,
-        options: getRuleOptions(autoConfig[ruleId]),
+        options: getRuleOptions(autoConfig[ruleId], rule.jsoncDefineRule),
         report(options: any) {
           if (options.messageId) {
             options.message = `[${ruleId}] ${
@@ -72,9 +72,17 @@ export default createRule("auto", {
 /**
  * Build the options to create the rule.
  */
-function getRuleOptions(options: number | string | any[]): any[] {
-  if (!Array.isArray(options)) {
-    return [];
+function getRuleOptions(
+  options: number | string | any[],
+  rule: PartialRuleModule,
+): any[] {
+  const jsonOptions = Array.isArray(options) ? options.slice(1) : [];
+  if (rule.meta.defaultOptions) {
+    rule.meta.defaultOptions.forEach((option, index) => {
+      if (jsonOptions[index] === undefined) {
+        jsonOptions[index] = option;
+      }
+    });
   }
-  return options.slice(1);
+  return jsonOptions;
 }
diff --git a/lib/rules/no-dupe-keys.ts b/lib/rules/no-dupe-keys.ts
@@ -3,6 +3,7 @@ const coreRule = getCoreRule("no-dupe-keys");
 
 export default createRule("no-dupe-keys", {
   meta: {
+    ...coreRule.meta,
     docs: {
       description: "disallow duplicate keys in object literals",
       recommended: ["json", "jsonc", "json5"],
@@ -14,6 +15,8 @@ export default createRule("no-dupe-keys", {
     schema: coreRule.meta!.schema!,
     messages: coreRule.meta!.messages!,
     type: coreRule.meta!.type!,
+    deprecated: false,
+    replacedBy: [],
   },
   create(context) {
     return defineWrapperListener(coreRule, context, context.options);
diff --git a/lib/rules/no-floating-decimal.ts b/lib/rules/no-floating-decimal.ts
@@ -3,6 +3,7 @@ const coreRule = getCoreRule("no-floating-decimal");
 
 export default createRule("no-floating-decimal", {
   meta: {
+    ...coreRule.meta,
     docs: {
       description:
         "disallow leading or trailing decimal points in numeric literals",
@@ -15,6 +16,8 @@ export default createRule("no-floating-decimal", {
     schema: coreRule.meta!.schema!,
     messages: coreRule.meta!.messages!,
     type: coreRule.meta!.type!,
+    deprecated: false,
+    replacedBy: [],
   },
   create(context) {
     return defineWrapperListener(coreRule, context, context.options);
diff --git a/lib/rules/no-irregular-whitespace.ts b/lib/rules/no-irregular-whitespace.ts
@@ -3,6 +3,7 @@ const coreRule = getCoreRule("no-irregular-whitespace");
 
 export default createRule("no-irregular-whitespace", {
   meta: {
+    ...coreRule.meta,
     docs: {
       description: "disallow irregular whitespace",
       // TODO: We will switch this in the next major version.
@@ -16,6 +17,8 @@ export default createRule("no-irregular-whitespace", {
     schema: coreRule.meta!.schema!,
     messages: coreRule.meta!.messages!,
     type: coreRule.meta!.type!,
+    deprecated: false,
+    replacedBy: [],
   },
   create(context) {
     return defineWrapperListener(coreRule, context, context.options);
diff --git a/lib/rules/no-multi-str.ts b/lib/rules/no-multi-str.ts
@@ -3,6 +3,7 @@ const coreRule = getCoreRule("no-multi-str");
 
 export default createRule("no-multi-str", {
   meta: {
+    ...coreRule.meta,
     docs: {
       description: "disallow multiline strings",
       recommended: ["json", "jsonc"],
@@ -17,6 +18,8 @@ export default createRule("no-multi-str", {
       multilineString: "Multiline support is limited to JSON5 only.",
     },
     type: coreRule.meta!.type!,
+    deprecated: false,
+    replacedBy: [],
   },
   create(context) {
     return defineWrapperListener(coreRule, context, context.options);
diff --git a/lib/rules/no-octal-escape.ts b/lib/rules/no-octal-escape.ts
@@ -3,6 +3,7 @@ const coreRule = getCoreRule("no-octal-escape");
 
 export default createRule("no-octal-escape", {
   meta: {
+    ...coreRule.meta,
     docs: {
       description: "disallow octal escape sequences in string literals",
       recommended: null,
@@ -14,6 +15,8 @@ export default createRule("no-octal-escape", {
     schema: coreRule.meta!.schema!,
     messages: coreRule.meta!.messages!,
     type: coreRule.meta!.type!,
+    deprecated: false,
+    replacedBy: [],
   },
   create(context) {
     return defineWrapperListener(coreRule, context, context.options);
diff --git a/lib/rules/no-octal.ts b/lib/rules/no-octal.ts
@@ -3,6 +3,7 @@ const coreRule = getCoreRule("no-octal");
 
 export default createRule("no-octal", {
   meta: {
+    ...coreRule.meta,
     docs: {
       description: "disallow legacy octal literals",
       recommended: ["json", "jsonc", "json5"],
@@ -14,6 +15,8 @@ export default createRule("no-octal", {
     schema: coreRule.meta!.schema!,
     messages: coreRule.meta!.messages!,
     type: coreRule.meta!.type!,
+    deprecated: false,
+    replacedBy: [],
   },
   create(context) {
     return defineWrapperListener(coreRule, context, context.options);
diff --git a/lib/rules/no-sparse-arrays.ts b/lib/rules/no-sparse-arrays.ts
@@ -3,6 +3,7 @@ const coreRule = getCoreRule("no-sparse-arrays");
 
 export default createRule("no-sparse-arrays", {
   meta: {
+    ...coreRule.meta,
     docs: {
       description: "disallow sparse arrays",
       recommended: ["json", "jsonc", "json5"],
@@ -14,6 +15,8 @@ export default createRule("no-sparse-arrays", {
     schema: coreRule.meta!.schema!,
     messages: coreRule.meta!.messages!,
     type: coreRule.meta!.type!,
+    deprecated: false,
+    replacedBy: [],
   },
   create(context) {
     return defineWrapperListener(coreRule, context, context.options);
diff --git a/lib/rules/no-useless-escape.ts b/lib/rules/no-useless-escape.ts
@@ -3,6 +3,7 @@ const coreRule = getCoreRule("no-useless-escape");
 
 export default createRule("no-useless-escape", {
   meta: {
+    ...coreRule.meta,
     docs: {
       description: "disallow unnecessary escape usage",
       recommended: ["json", "jsonc", "json5"],
@@ -14,6 +15,8 @@ export default createRule("no-useless-escape", {
     schema: coreRule.meta!.schema!,
     messages: coreRule.meta!.messages!,
     type: coreRule.meta!.type!,
+    deprecated: false,
+    replacedBy: [],
   },
   create(context) {
     return defineWrapperListener(coreRule, context, context.options);
diff --git a/lib/types.ts b/lib/types.ts
@@ -85,6 +85,7 @@ export interface PartialRuleMetaData {
   messages: { [messageId: string]: string };
   fixable?: "code" | "whitespace";
   hasSuggestions?: boolean;
+  defaultOptions?: any[];
   schema: false | JSONSchema4 | JSONSchema4[];
   deprecated?: boolean;
   replacedBy?: [];
diff --git a/package.json b/package.json
@@ -98,7 +98,7 @@
     "dts-bundle": "^0.7.3",
     "env-cmd": "^10.1.0",
     "esbuild": "^0.24.0",
-    "eslint": "^9.5.0",
+    "eslint": "^9.15.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-eslint-plugin": "^6.1.0",
     "eslint-plugin-eslint-rule-tester": "^0.6.0",
diff --git a/tools/new-rule.ts b/tools/new-rule.ts
@@ -29,6 +29,7 @@ const coreRule = getCoreRule("${ruleId}")
 
 export default createRule("${ruleId}", {
     meta: {
+        ...coreRule.meta,
         docs: {
             description: "...",
             recommended: true,
@@ -38,6 +39,8 @@ export default createRule("${ruleId}", {
         schema: coreRule.meta!.schema!,
         messages: coreRule.meta!.messages!,
         type: coreRule.meta!.type!,
+        deprecated: false,
+        replacedBy: [],
     },
     create(context) {
         const sourceCode = context.sourceCode;

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"eslint-plugin-jsonc": patch
 +---
++
 +fix: crash when used with eslint v9.15