refactor: remove createSimpleRule

zanminkian · Dec 28, 2024 · a2b6676 · a2b6676
1 parent 3f45e5f
commit a2b6676
Show file tree

Hide file tree

Showing 7 changed files with 97 additions and 81 deletions.
diff --git a/packages/eslint-plugin-ts/src/rules/exact-map-set-type.ts b/packages/eslint-plugin-ts/src/rules/exact-map-set-type.ts
@@ -1,9 +1,15 @@
+import type { Rule } from "eslint";
 import type { Node } from "estree";
-import { createSimpleRule, getRuleName } from "../utils.js";
+import { getRuleName } from "../utils.js";
 
-export const exactMapSetType = createSimpleRule({
-  name: getRuleName(import.meta.url),
-  message: "Disallow using Map and Set without type arguments.",
+const name = getRuleName(import.meta.url);
+const messages = {
+  default: "Disallow using Map and Set without type arguments.",
+} as const;
+const rule: Rule.RuleModule = {
+  meta: {
+    messages,
+  },
   create: (context) => {
     const selectors = [
       // new Set();
@@ -13,8 +19,10 @@ export const exactMapSetType = createSimpleRule({
     ];
     return {
       [`:matches(${selectors.join(", ")})`]: (node: Node) => {
-        context.reportNode(node);
+        context.report({ node, messageId: messages.default });
       },
     };
   },
-});
+};
+
+export const exactMapSetType = { name, rule };
diff --git a/packages/eslint-plugin-ts/src/rules/no-const-enum.ts b/packages/eslint-plugin-ts/src/rules/no-const-enum.ts
@@ -1,12 +1,20 @@
+import type { Rule } from "eslint";
 import type { Node } from "estree";
-import { createSimpleRule, getRuleName } from "../utils.js";
+import { getRuleName } from "../utils.js";
 
-export const noConstEnum = createSimpleRule({
-  name: getRuleName(import.meta.url),
-  message: "Disallow using `const enum` expression.",
+const name = getRuleName(import.meta.url);
+const messages = {
+  default: "Disallow using `const enum` expression.",
+} as const;
+const rule: Rule.RuleModule = {
+  meta: {
+    messages,
+  },
   create: (context) => ({
     "TSEnumDeclaration[const=true]": (node: Node) => {
-      context.reportNode(node);
+      context.report({ node, messageId: messages.default });
     },
   }),
-});
+};
+
+export const noConstEnum = { name, rule };
diff --git a/packages/eslint-plugin-ts/src/rules/no-declares.ts b/packages/eslint-plugin-ts/src/rules/no-declares.ts
@@ -1,18 +1,24 @@
+import type { Rule } from "eslint";
 import type { Node } from "estree";
-import { createSimpleRule, getRuleName } from "../utils.js";
+import { getRuleName } from "../utils.js";
 
-export const noDeclares = createSimpleRule({
-  name: getRuleName(import.meta.url),
-  message: "Disallow using `declare` statement.",
-  schema: [
-    {
-      type: "object",
-      properties: {
-        allowClassProperty: { type: "boolean" },
+const name = getRuleName(import.meta.url);
+const messages = {
+  default: "Disallow using `declare` statement.",
+} as const;
+const rule: Rule.RuleModule = {
+  meta: {
+    messages,
+    schema: [
+      {
+        type: "object",
+        properties: {
+          allowClassProperty: { type: "boolean" },
+        },
+        additionalProperties: false,
       },
-      additionalProperties: false,
-    },
-  ],
+    ],
+  },
   create: (context) => ({
     "[declare=true]": (node: Node & { parent: Node }) => {
       const { allowClassProperty = false } = context.options[0] ?? {};
@@ -23,7 +29,8 @@ export const noDeclares = createSimpleRule({
       ) {
         return;
       }
-      context.reportNode(node);
+      context.report({ node, messageId: messages.default });
     },
   }),
-});
+};
+export const noDeclares = { name, rule };
diff --git a/packages/eslint-plugin-ts/src/rules/no-export-assignment.ts b/packages/eslint-plugin-ts/src/rules/no-export-assignment.ts
@@ -1,12 +1,20 @@
+import type { Rule } from "eslint";
 import type { Node } from "estree";
-import { createSimpleRule, getRuleName } from "../utils.js";
+import { getRuleName } from "../utils.js";
 
-export const noExportAssignment = createSimpleRule({
-  name: getRuleName(import.meta.url),
-  message: "Disallow using `export =` statement.",
+const name = getRuleName(import.meta.url);
+const messages = {
+  default: "Disallow using `export =` statement.",
+} as const;
+const rule: Rule.RuleModule = {
+  meta: {
+    messages,
+  },
   create: (context) => ({
     TSExportAssignment: (node: Node) => {
-      context.reportNode(node);
+      context.report({ node, messageId: messages.default });
     },
   }),
-});
+};
+
+export const noExportAssignment = { name, rule };
diff --git a/packages/eslint-plugin-ts/src/rules/no-property-decorator.ts b/packages/eslint-plugin-ts/src/rules/no-property-decorator.ts
@@ -1,19 +1,25 @@
+import type { Rule } from "eslint";
 import type { Node } from "estree";
-import { createSimpleRule, getRuleName } from "../utils.js";
+import { getRuleName } from "../utils.js";
 
-export const noPropertyDecorator = createSimpleRule({
-  name: getRuleName(import.meta.url),
-  message:
+const name = getRuleName(import.meta.url);
+const messages = {
+  default:
     "Disallow using property decorator. Consider adding `declare` keyword in front of the property to fix it.",
-  schema: [
-    {
-      type: "object",
-      properties: {
-        ignoreDeclaration: { type: "boolean" },
+} as const;
+const rule: Rule.RuleModule = {
+  meta: {
+    messages,
+    schema: [
+      {
+        type: "object",
+        properties: {
+          ignoreDeclaration: { type: "boolean" },
+        },
+        additionalProperties: false,
       },
-      additionalProperties: false,
-    },
-  ],
+    ],
+  },
   create: (context) => ({
     "ClassBody > PropertyDefinition[decorators.length>0]": (node: Node) => {
       if (
@@ -23,7 +29,8 @@ export const noPropertyDecorator = createSimpleRule({
       ) {
         return;
       }
-      context.reportNode(node);
+      context.report({ node, messageId: messages.default });
     },
   }),
-});
+};
+export const noPropertyDecorator = { name, rule };
diff --git a/packages/eslint-plugin-ts/src/rules/no-untyped-empty-array.ts b/packages/eslint-plugin-ts/src/rules/no-untyped-empty-array.ts
@@ -1,14 +1,21 @@
+import type { Rule } from "eslint";
 import type { Node } from "estree";
-import { createSimpleRule, getRuleName } from "../utils.js";
+import { getRuleName } from "../utils.js";
 
-export const noUntypedEmptyArray = createSimpleRule({
-  name: getRuleName(import.meta.url),
-  message:
+const name = getRuleName(import.meta.url);
+const messages = {
+  default:
     "Defining a variable with an empty array should annotate the array type",
+};
+const rule: Rule.RuleModule = {
+  meta: {
+    messages,
+  },
   create: (context) => ({
     "VariableDeclarator:not([id.typeAnnotation]) > ArrayExpression.init[elements.length=0]":
       (node: Node) => {
-        context.reportNode(node);
+        context.report({ node, messageId: messages.default });
       },
   }),
-});
+};
+export const noUntypedEmptyArray = { name, rule };
diff --git a/packages/eslint-plugin-ts/src/utils.ts b/packages/eslint-plugin-ts/src/utils.ts
@@ -1,34 +1,5 @@
 import path from "node:path";
 import { fileURLToPath } from "node:url";
-import type { Rule } from "eslint";
-import type { Node } from "estree";
-import type { JSONSchema4 } from "json-schema";
-
-export interface Context extends Omit<Rule.RuleContext, "report"> {
-  reportNode: (node: Node) => void;
-}
-
-export function createSimpleRule(options: {
-  name: string;
-  message: string;
-  schema?: JSONSchema4[];
-  create: (context: Context) => Rule.RuleListener;
-}): { name: string; rule: Rule.RuleModule } {
-  const { name, message, schema, create } = options;
-  const rule: Rule.RuleModule = {
-    meta: {
-      ...(schema && { schema }),
-    },
-    create: (context: Rule.RuleContext) => {
-      const ctx = Object.assign({}, context, {
-        reportNode: (node: Node) => context.report({ node, message }),
-      });
-      Object.setPrototypeOf(ctx, Object.getPrototypeOf(context));
-      return create(ctx);
-    },
-  };
-  return { name, rule };
-}
 
 export function getRuleName(importMetaUrl: string) {
   // remove '.js' extension