@nest-boot/eslint-plugin 7.0.0-beta.1 → 7.0.0-beta.2

package/dist/utils/decorators.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasClassDecorator = hasClassDecorator;
+exports.hasPropertyDecorator = hasPropertyDecorator;
+exports.getClassDecorator = getClassDecorator;
+exports.getPropertyDecorator = getPropertyDecorator;
+const utils_1 = require("@typescript-eslint/utils");
+/**
+ * 检查类是否有指定的装饰器
+ * @param classDeclaration 类声明节点
+ * @param decoratorNames 装饰器名称（可以是字符串或字符串数组）
+ * @returns 是否有指定的装饰器
+ */
+function hasClassDecorator(classDeclaration, decoratorNames) {
+    const names = Array.isArray(decoratorNames)
+        ? decoratorNames
+        : [decoratorNames];
+    return classDeclaration.decorators.some((decorator) => {
+        if (decorator.expression.type !== utils_1.AST_NODE_TYPES.CallExpression) {
+            return false;
+        }
+        if (decorator.expression.callee.type !== utils_1.AST_NODE_TYPES.Identifier) {
+            return false;
+        }
+        return names.includes(decorator.expression.callee.name);
+    });
+}
+/**
+ * 检查属性是否有指定的装饰器
+ * @param propertyDefinition 属性定义节点
+ * @param decoratorNames 装饰器名称（可以是字符串或字符串数组）
+ * @returns 是否有指定的装饰器
+ */
+function hasPropertyDecorator(propertyDefinition, decoratorNames) {
+    const names = Array.isArray(decoratorNames)
+        ? decoratorNames
+        : [decoratorNames];
+    return propertyDefinition.decorators.some((decorator) => {
+        if (decorator.expression.type !== utils_1.AST_NODE_TYPES.CallExpression) {
+            return false;
+        }
+        if (decorator.expression.callee.type !== utils_1.AST_NODE_TYPES.Identifier) {
+            return false;
+        }
+        return names.includes(decorator.expression.callee.name);
+    });
+}
+/**
+ * 获取类的装饰器
+ * @param classDeclaration 类声明节点
+ * @param decoratorName 装饰器名称
+ * @returns 装饰器节点，如果不存在则返回 null
+ */
+function getClassDecorator(classDeclaration, decoratorName) {
+    return (classDeclaration.decorators.find((decorator) => {
+        return (decorator.expression.type === utils_1.AST_NODE_TYPES.CallExpression &&
+            decorator.expression.callee.type === utils_1.AST_NODE_TYPES.Identifier &&
+            decorator.expression.callee.name === decoratorName);
+    }) ?? null);
+}
+/**
+ * 获取属性的装饰器
+ * @param propertyDefinition 属性定义节点
+ * @param decoratorName 装饰器名称
+ * @returns 装饰器节点，如果不存在则返回 null
+ */
+function getPropertyDecorator(propertyDefinition, decoratorName) {
+    return (propertyDefinition.decorators.find((decorator) => {
+        return (decorator.expression.type === utils_1.AST_NODE_TYPES.CallExpression &&
+            decorator.expression.callee.type === utils_1.AST_NODE_TYPES.Identifier &&
+            decorator.expression.callee.name === decoratorName);
+    }) ?? null);
+}
+//# sourceMappingURL=decorators.js.map

package/dist/utils/decorators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/utils/decorators.ts"],"names":[],"mappings":";;AAQA,8CAiBC;AAQD,oDAiBC;AAQD,8CAaC;AAQD,oDAaC;AA5FD,oDAAoE;AAEpE;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,gBAA2C,EAC3C,cAAiC;IAEjC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC;QACzC,CAAC,CAAC,cAAc;QAChB,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;IAErB,OAAO,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAA6B,EAAE,EAAE;QACxE,IAAI,SAAS,CAAC,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,cAAc,EAAE,CAAC;YAChE,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,EAAE,CAAC;YACnE,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,kBAA+C,EAC/C,cAAiC;IAEjC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC;QACzC,CAAC,CAAC,cAAc;QAChB,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;IAErB,OAAO,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAA6B,EAAE,EAAE;QAC1E,IAAI,SAAS,CAAC,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,cAAc,EAAE,CAAC;YAChE,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,EAAE,CAAC;YACnE,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,gBAA2C,EAC3C,aAAqB;IAErB,OAAO,CACL,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAA6B,EAAE,EAAE;QACjE,OAAO,CACL,SAAS,CAAC,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,cAAc;YAC3D,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU;YAC9D,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,KAAK,aAAa,CACnD,CAAC;IACJ,CAAC,CAAC,IAAI,IAAI,CACX,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,kBAA+C,EAC/C,aAAqB;IAErB,OAAO,CACL,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAA6B,EAAE,EAAE;QACnE,OAAO,CACL,SAAS,CAAC,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,cAAc;YAC3D,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU;YAC9D,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,KAAK,aAAa,CACnD,CAAC;IACJ,CAAC,CAAC,IAAI,IAAI,CACX,CAAC;AACJ,CAAC"}

package/dist/utils/tester.d.ts

@@ -0,0 +1,2 @@
+import { RuleTester } from "@typescript-eslint/rule-tester";
+export declare const tester: RuleTester;

package/dist/utils/tester.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tester = void 0;
+const globals_1 = require("@jest/globals");
+const parser_1 = __importDefault(require("@typescript-eslint/parser"));
+const rule_tester_1 = require("@typescript-eslint/rule-tester");
+const path_1 = __importDefault(require("path"));
+rule_tester_1.RuleTester.afterAll = globals_1.afterAll;
+rule_tester_1.RuleTester.it = globals_1.it;
+rule_tester_1.RuleTester.itOnly = globals_1.it.only;
+rule_tester_1.RuleTester.describe = globals_1.describe;
+exports.tester = new rule_tester_1.RuleTester({
+    languageOptions: {
+        parser: parser_1.default,
+        parserOptions: {
+            projectService: {
+                allowDefaultProject: ["*.ts*"],
+                defaultProject: "tsconfig.json",
+            },
+            tsconfigRootDir: path_1.default.join(__dirname, "../.."),
+        },
+    },
+});
+//# sourceMappingURL=tester.js.map

package/dist/utils/tester.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tester.js","sourceRoot":"","sources":["../../src/utils/tester.ts"],"names":[],"mappings":";;;;;;AAAA,2CAAuD;AACvD,uEAA+C;AAC/C,gEAA4D;AAC5D,gDAAwB;AAExB,wBAAU,CAAC,QAAQ,GAAG,kBAAQ,CAAC;AAC/B,wBAAU,CAAC,EAAE,GAAG,YAAE,CAAC;AACnB,wBAAU,CAAC,MAAM,GAAG,YAAE,CAAC,IAAI,CAAC;AAC5B,wBAAU,CAAC,QAAQ,GAAG,kBAAQ,CAAC;AAElB,QAAA,MAAM,GAAG,IAAI,wBAAU,CAAC;IACnC,eAAe,EAAE;QACf,MAAM,EAAN,gBAAM;QACN,aAAa,EAAE;YACb,cAAc,EAAE;gBACd,mBAAmB,EAAE,CAAC,OAAO,CAAC;gBAC9B,cAAc,EAAE,eAAe;aAChC;YACD,eAAe,EAAE,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC;SAC/C;KACF;CACF,CAAC,CAAC"}

package/eslint.config.mjs

@@ -1,13 +1,49 @@
-import config from "@nest-boot/eslint-config";
+import { FlatCompat } from "@eslint/eslintrc";
+import js from "@eslint/js";
+import parser from "@typescript-eslint/parser";
+import prettierConfig from "eslint-config-prettier";
+import simpleImportSort from "eslint-plugin-simple-import-sort";
+import { dirname } from "path";
+import { configs } from "typescript-eslint";
+import { fileURLToPath } from "url";
+
+const compat = new FlatCompat({
+  baseDirectory: dirname(fileURLToPath(import.meta.url)),
+});
 
 /** @type {import('eslint').Linter.Config[]} */
 export default [
-  ...config,
+  js.configs.recommended,
+
+  // 使用 FlatCompat 包装 Standard 配置
+  ...compat.extends("standard"),
+
+  // TypeScript 严格类型检查配置
+  ...configs.strictTypeChecked,
+  ...configs.stylisticTypeChecked,
+
+  // Prettier 配置
+  prettierConfig,
+
+  // TypeScript 配置
   {
     languageOptions: {
+      parser,
       parserOptions: {
         project: ["tsconfig.json"],
       },
     },
   },
+
+  // Simple Import Sort 配置
+  {
+    plugins: {
+      "simple-import-sort": simpleImportSort,
+    },
+    rules: {
+      "import/order": "off",
+      "simple-import-sort/imports": "error",
+      "simple-import-sort/exports": "error",
+    },
+  },
 ];

package/jest.config.ts

@@ -0,0 +1,12 @@
+import type { Config } from "jest";
+
+export default {
+  moduleFileExtensions: ["js", "json", "ts"],
+  testRegex: ".spec.ts$",
+  transform: {
+    "^.+.(t|j)s$": "ts-jest",
+  },
+  coverageDirectory: "./coverage",
+  collectCoverageFrom: ["src/**/*"],
+  testEnvironment: "node",
+} satisfies Config;

package/package.json

@@ -1,19 +1,26 @@
 {
   "name": "@nest-boot/eslint-plugin",
-  "version": "7.0.0-beta.1",
+  "version": "7.0.0-beta.2",
   "license": "MIT",
   "main": "./dist/index.js",
   "exports": "./dist/index.js",
   "dependencies": {
-    "@typescript-eslint/utils": "^8.18.0"
+    "@typescript-eslint/utils": "^8.44.1"
   },
   "devDependencies": {
-    "eslint": "^9.28.0",
-    "eslint-doc-generator": "^2.1.2",
-    "mocha": "^10.8.2",
-    "npm-run-all": "^4.1.5",
-    "typescript": "^5.8.3",
-    "@nest-boot/tsconfig": "7.0.0-beta.0"
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.36.0",
+    "@jest/globals": "^30.2.0",
+    "@types/node": "^22.18.6",
+    "@typescript-eslint/rule-tester": "^8.44.1",
+    "eslint": "^9.36.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.4.4",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.44.1",
+    "@nest-boot/tsconfig": "7.0.0-beta.1"
   },
   "peerDependencies": {
     "eslint": "^9.0.0"
@@ -25,12 +32,13 @@
     "extends": "../../package.json"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "tsc -p tsconfig.build.json",
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
-    "dev": "tsc --watch",
-    "lint:eslint-docs": "npm-run-all \"update:eslint-docs -- --check\"",
-    "lint:js": "eslint .",
-    "test": "mocha tests --recursive",
-    "update:eslint-docs": "eslint-doc-generator"
+    "dev": "tsc -p tsconfig.build.json --watch",
+    "lint": "eslint \"{src,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:cov": "jest --coverage",
+    "test:watch": "jest --watch",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand"
   }
 }

package/src/index.ts

@@ -1,3 +1,3 @@
-import rules from "./rules";
+import { rules } from "./rules";
 
 export { rules };

package/src/rules/graphql/graphql-field-config-from-types.spec.ts

@@ -0,0 +1,242 @@
+import { tester } from "../../utils/tester";
+import rule from "./graphql-field-config-from-types";
+
+tester.run("graphql-field-config-from-types", rule, {
+  valid: [
+    // 正确的 string 类型
+    /* typescript */ `
+      @ObjectType()
+      class User {
+        @Field(() => String)
+        name!: string;
+      }
+    `,
+    // 正确的 number 类型（Float）
+    /* typescript */ `
+      @ObjectType()
+      class User {
+        @Field(() => Float)
+        score!: number;
+      }
+    `,
+    // 正确的 number 类型（Int）
+    /* typescript */ `
+      @ObjectType()
+      class User {
+        @Field(() => Int)
+        age!: number;
+      }
+    `,
+    // 正确的 boolean 类型
+    /* typescript */ `
+      @ObjectType()
+      class User {
+        @Field(() => Boolean)
+        isActive!: boolean;
+      }
+    `,
+    // 正确的 nullable 配置
+    /* typescript */ `
+      @ObjectType()
+      class User {
+        @Field(() => String, { nullable: true })
+        name?: string;
+      }
+    `,
+    // 正确的数组类型
+    /* typescript */ `
+      @ObjectType()
+      class User {
+        @Field(() => [String])
+        tags!: string[];
+      }
+    `,
+    // ID 类型
+    /* typescript */ `
+      @ObjectType()
+      class User {
+        @Field(() => ID)
+        id!: string;
+      }
+    `,
+    // 自定义类型
+    /* typescript */ `
+      @ObjectType()
+      class User {
+        @Field(() => Profile)
+        profile!: Profile;
+      }
+    `,
+    // 带有 HideField 装饰器的属性不需要 @Field
+    /* typescript */ `
+      @ObjectType()
+      class User {
+        @HideField()
+        password!: string;
+      }
+    `,
+    // 非 GraphQL 模型类不检查
+    /* typescript */ `
+      class NotAGraphQLModel {
+        field: string;
+      }
+    `,
+    // 复杂的配置对象（包含展开运算符和条件表达式）
+    /* typescript */ `
+      @ObjectType()
+      class Connection {
+        @Field(() => String, {
+          nullable: true,
+          ...(filterableFields.length > 0
+            ? {
+                description: \`Apply filters.\`,
+              }
+            : {}),
+        })
+        query?: string;
+      }
+    `,
+  ],
+  invalid: [
+    // @Field 类型不匹配
+    {
+      code: /* typescript */ `
+        @ObjectType()
+        class User {
+          @Field(() => Int)
+          name!: string;
+        }
+      `,
+      output: /* typescript */ `
+        @ObjectType()
+        class User {
+          @Field(() => String)
+          name!: string;
+        }
+      `,
+      errors: [{ messageId: "alignFieldDecoratorWithTsType" }],
+    },
+    // nullable 配置不匹配
+    {
+      code: /* typescript */ `
+        @ObjectType()
+        class User {
+          @Field(() => String)
+          name?: string;
+        }
+      `,
+      output: /* typescript */ `
+        @ObjectType()
+        class User {
+          @Field(() => String, { nullable: true })
+          name?: string;
+        }
+      `,
+      errors: [{ messageId: "alignFieldDecoratorWithTsType" }],
+    },
+    // 不应该有 nullable 但设置了
+    {
+      code: /* typescript */ `
+        @ObjectType()
+        class User {
+          @Field(() => String, { nullable: true })
+          name!: string;
+        }
+      `,
+      output: /* typescript */ `
+        @ObjectType()
+        class User {
+          @Field(() => String)
+          name!: string;
+        }
+      `,
+      errors: [{ messageId: "alignFieldDecoratorWithTsType" }],
+    },
+    // 数组类型不匹配
+    {
+      code: /* typescript */ `
+        @ObjectType()
+        class User {
+          @Field(() => String)
+          tags!: string[];
+        }
+      `,
+      output: /* typescript */ `
+        @ObjectType()
+        class User {
+          @Field(() => [String])
+          tags!: string[];
+        }
+      `,
+      errors: [{ messageId: "alignFieldDecoratorWithTsType" }],
+    },
+    // 缺少 type function 但有其他配置选项（应保留）
+    {
+      code: /* typescript */ `
+        @ObjectType()
+        class PageInfo {
+          @Field({
+            complexity: 0,
+            description: "Whether there are any pages prior to the current page.",
+          })
+          hasPreviousPage!: boolean;
+        }
+      `,
+      output: /* typescript */ `
+        @ObjectType()
+        class PageInfo {
+          @Field(() => Boolean, { complexity: 0, description: "Whether there are any pages prior to the current page." })
+          hasPreviousPage!: boolean;
+        }
+      `,
+      errors: [{ messageId: "alignFieldDecoratorWithTsType" }],
+    },
+    // 配置 nullable 时保留其他选项
+    {
+      code: /* typescript */ `
+        @ObjectType()
+        class User {
+          @Field(() => String, { description: "User name" })
+          name?: string;
+        }
+      `,
+      output: /* typescript */ `
+        @ObjectType()
+        class User {
+          @Field(() => String, { nullable: true, description: "User name" })
+          name?: string;
+        }
+      `,
+      errors: [{ messageId: "alignFieldDecoratorWithTsType" }],
+    },
+    // 复杂配置对象（包含展开运算符）缺少 type function
+    {
+      code: /* typescript */ `
+        @ObjectType()
+        class Connection {
+          @Field({
+            nullable: true,
+            ...(filterableFields.length > 0
+              ? {
+                  description: \`Apply filters.\`,
+                }
+              : {}),
+          })
+          query?: string;
+        }
+      `,
+      output: /* typescript */ `
+        @ObjectType()
+        class Connection {
+          @Field(() => String, { nullable: true, ...(filterableFields.length > 0
+              ? {
+                  description: \`Apply filters.\`,
+                }
+              : {}) })
+          query?: string;
+        }
+      `,
+      errors: [{ messageId: "alignFieldDecoratorWithTsType" }],
+    },
+  ],
+});