feat: Add interface-name-prefix rule

Author: Simoon-F

configs/.eslintrc.js

@@ -4,14 +4,21 @@ module.exports = {
     "eslint:recommended",
     "plugin:prettier/recommended",
     "plugin:react-hooks/recommended",
+    "plugin:eslint-plugin/recommended",
     "plugin:@typescript-eslint/recommended",
   ],
   parser: "@typescript-eslint/parser",
-  plugins: ["react", "simple-import-sort", "unicorn", "import"],
+  plugins: [
+    "react",
+    "simple-import-sort",
+    "unicorn",
+    "import",
+    "@sj-distributor/react",
+  ],
   env: {
+    node: true,
     es2022: true,
     browser: true,
-    node: true,
   },
   parserOptions: {
     sourceType: "module",
@@ -54,6 +61,8 @@ module.exports = {
         next: "*",
       },
     ],
+    "@typescript-eslint/no-var-requires": 0, // 关闭禁止使用 require 语句
+    "@sj-distributor/react/interface-name-prefix": ["error", "I"], // 默认强制 interface 大写 I 前缀
   },
   // 共享配置，提供给每一个将被执行的规则
   settings: {

lib/index.js

@@ -1,5 +1,5 @@
 /**
- * @fileoverview ESLint presets for react native
+ * @fileoverview ESLint presets for react
  */
 "use strict";
 
@@ -8,14 +8,15 @@
 //------------------------------------------------------------------------------
 
 const requireIndex = require("requireindex");
+const path = require("path");
 const eslintrc = require("../configs/.eslintrc");
 
 //------------------------------------------------------------------------------
 // Plugin Definition
 //------------------------------------------------------------------------------
 module.exports = {
   // 引入所有的自定义的规则
-  rules: requireIndex(__dirname + "/rules"),
+  rules: requireIndex(path.join(__dirname + "/rules")),
   configs: {
     recommended: eslintrc,
   },

lib/rules/interface-name-prefix.js

@@ -0,0 +1,64 @@
+/**
+ * @fileoverview Require interface names to begin with a specified prefix
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      category: "Naming",
+      recommended: false,
+      description: "Require interface names to begin with a specified prefix",
+    },
+    fixable: "code",
+    schema: [
+      {
+        type: "string",
+      },
+    ],
+    messages: {
+      missingPrefix:
+        "Interface name '{{ name }}' should start with '{{ prefix }}'",
+    },
+  },
+
+  create(context) {
+    const [prefix = "I"] = context.options;
+
+    function checkPrefix(node) {
+      const name = node.id.name;
+
+      if (
+        typeof name !== "string" ||
+        name.startsWith(prefix) ||
+        node.parent.type === "TSModuleDeclaration"
+      ) {
+        return;
+      }
+
+      context.report({
+        node,
+        messageId: "missingPrefix",
+        data: {
+          name,
+          prefix,
+        },
+        fix: (fixer) => {
+          const newName = `${prefix}${name}`;
+
+          return fixer.replaceText(node.id, newName);
+        },
+      });
+    }
+
+    return {
+      TSInterfaceDeclaration: checkPrefix,
+    };
+  },
+};