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

package/src/rules/graphql/graphql-field-definite-assignment.ts

@@ -0,0 +1,147 @@
+import { AST_NODE_TYPES, TSESTree } from "@typescript-eslint/utils";
+
+import { createRule } from "../../utils/createRule";
+import {
+  hasClassDecorator,
+  hasPropertyDecorator,
+} from "../../utils/decorators";
+
+export default createRule<
+  [],
+  "addDefiniteAssignment" | "removeDefiniteAssignment"
+>({
+  name: "graphql-field-definite-assignment",
+  meta: {
+    type: "problem",
+    docs: {
+      description:
+        "确保 GraphQL @Field 装饰器的属性正确使用 definite assignment assertion (!)。没有初始化值的属性应添加 !，有初始化值的属性应移除 !。",
+    },
+    fixable: "code",
+    schema: [],
+    messages: {
+      addDefiniteAssignment:
+        "属性 '{{propertyName}}' 使用了 @Field 装饰器但没有初始化值，应添加 definite assignment assertion (!)。",
+      removeDefiniteAssignment:
+        "属性 '{{propertyName}}' 使用了 @Field 装饰器且有初始化值，应移除 definite assignment assertion (!)。",
+    },
+  },
+  defaultOptions: [],
+  create(context) {
+    const source = context.sourceCode;
+
+    const isGraphqlModelClass = (node: TSESTree.ClassDeclaration): boolean => {
+      return hasClassDecorator(node, ["ObjectType", "InputType", "ArgsType"]);
+    };
+
+    const getPropertyName = (
+      member: TSESTree.PropertyDefinition,
+    ): string | null => {
+      if (member.key.type === AST_NODE_TYPES.Identifier) {
+        return member.key.name;
+      }
+      return null;
+    };
+
+    const hasInitializer = (member: TSESTree.PropertyDefinition): boolean => {
+      return !!member.value;
+    };
+
+    const hasDefiniteAssignment = (
+      member: TSESTree.PropertyDefinition,
+    ): boolean => {
+      return member.definite;
+    };
+
+    const isOptionalProperty = (
+      member: TSESTree.PropertyDefinition,
+    ): boolean => {
+      // 检查 AST 节点的 optional 标记
+      if (member.optional) return true;
+
+      // 检查源代码中是否有 ? 符号（在属性名和冒号之间）
+      const keyEnd = member.key.range[1];
+      const text = source.text;
+      for (let i = keyEnd; i < member.range[1]; i++) {
+        if (text[i] === "?") return true;
+        if (text[i] === ":" || text[i] === "!") break;
+      }
+
+      return false;
+    };
+
+    return {
+      ClassDeclaration(node) {
+        if (!isGraphqlModelClass(node)) return;
+
+        node.body.body.forEach((member: TSESTree.ClassElement) => {
+          if (member.type !== AST_NODE_TYPES.PropertyDefinition) return;
+          if (!hasPropertyDecorator(member, "Field")) return;
+
+          const propertyName = getPropertyName(member);
+          if (!propertyName) return;
+
+          // 可选属性（?:）不需要 definite assignment assertion
+          if (isOptionalProperty(member)) return;
+
+          const hasInit = hasInitializer(member);
+          const hasDefinite = hasDefiniteAssignment(member);
+
+          // 情况1: 没有初始化值，但也没有 definite assignment assertion
+          if (!hasInit && !hasDefinite) {
+            context.report({
+              node: member,
+              messageId: "addDefiniteAssignment",
+              data: {
+                propertyName,
+              },
+              fix: (fixer) => {
+                // 找到属性名称的结束位置
+                const keyEnd = member.key.range[1];
+                // 在属性名称后添加 !
+                return fixer.insertTextAfterRange([keyEnd, keyEnd], "!");
+              },
+            });
+          }
+
+          // 情况2: 有初始化值，但也有 definite assignment assertion
+          if (hasInit && hasDefinite) {
+            context.report({
+              node: member,
+              messageId: "removeDefiniteAssignment",
+              data: {
+                propertyName,
+              },
+              fix: (fixer) => {
+                // 找到 ! 的位置并移除
+                const keyEnd = member.key.range[1];
+                const text = source.text;
+
+                // 查找 ! 的位置（在属性名称和冒号之间）
+                let exclamationPos = -1;
+                for (let i = keyEnd; i < member.range[1]; i++) {
+                  if (text[i] === "!") {
+                    exclamationPos = i;
+                    break;
+                  }
+                  // 如果遇到冒号，说明没有 !
+                  if (text[i] === ":") {
+                    break;
+                  }
+                }
+
+                if (exclamationPos !== -1) {
+                  return fixer.removeRange([
+                    exclamationPos,
+                    exclamationPos + 1,
+                  ]);
+                }
+                return null;
+              },
+            });
+          }
+        });
+      },
+    };
+  },
+});

package/src/rules/import/import-bullmq.spec.ts

@@ -0,0 +1,69 @@
+import { tester } from "../../utils/tester";
+import rule from "./import-bullmq";
+
+tester.run("import-bullmq", rule, {
+  valid: [
+    // 正确的导入来源
+    /* typescript */ `
+      import { BullModule } from "@nest-boot/bullmq";
+    `,
+    // 从其他包导入
+    /* typescript */ `
+      import { Module } from "@nestjs/common";
+    `,
+    // 命名导入
+    /* typescript */ `
+      import { InjectQueue, Processor } from "@nest-boot/bullmq";
+    `,
+    // 默认导入
+    /* typescript */ `
+      import BullMQ from "@nest-boot/bullmq";
+    `,
+    // 从 bullmq 核心包导入（不应该被替换）
+    /* typescript */ `
+      import { Queue, Worker } from "bullmq";
+    `,
+  ],
+  invalid: [
+    // 从 @nestjs/bullmq 导入，应该替换为 @nest-boot/bullmq
+    {
+      code: /* typescript */ `
+        import { BullModule } from "@nestjs/bullmq";
+      `,
+      output: /* typescript */ `
+        import { BullModule } from "@nest-boot/bullmq";
+      `,
+      errors: [{ messageId: "replaceBullmqImport" }],
+    },
+    // Processor 相关导入
+    {
+      code: /* typescript */ `
+        import { Processor, InjectQueue } from "@nestjs/bullmq";
+      `,
+      output: /* typescript */ `
+        import { Processor, InjectQueue } from "@nest-boot/bullmq";
+      `,
+      errors: [{ messageId: "replaceBullmqImport" }],
+    },
+    // 类型导入
+    {
+      code: /* typescript */ `
+        import type { BullModuleOptions } from "@nestjs/bullmq";
+      `,
+      output: /* typescript */ `
+        import type { BullModuleOptions } from "@nest-boot/bullmq";
+      `,
+      errors: [{ messageId: "replaceBullmqImport" }],
+    },
+    // 装饰器导入
+    {
+      code: /* typescript */ `
+        import { OnQueueActive, OnQueueCompleted } from "@nestjs/bullmq";
+      `,
+      output: /* typescript */ `
+        import { OnQueueActive, OnQueueCompleted } from "@nest-boot/bullmq";
+      `,
+      errors: [{ messageId: "replaceBullmqImport" }],
+    },
+  ],
+});

package/src/rules/import/import-bullmq.ts

@@ -0,0 +1,35 @@
+import { createRule } from "../../utils/createRule";
+
+export default createRule({
+  name: "import-bullmq",
+  meta: {
+    type: "problem",
+    docs: {
+      description:
+        "将从 @nestjs/bullmq 导入的包修复为从 @nest-boot/bullmq 导入",
+    },
+    fixable: "code",
+    schema: [],
+    messages: {
+      replaceBullmqImport: "应从 @nest-boot/bullmq 导入，而不是 @nestjs/bullmq",
+    },
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        // 检查是否从 @nestjs/bullmq 导入
+        if (node.source.value === "@nestjs/bullmq") {
+          context.report({
+            node,
+            messageId: "replaceBullmqImport",
+            fix(fixer) {
+              // 将导入源替换为 @nest-boot/bullmq
+              return fixer.replaceText(node.source, '"@nest-boot/bullmq"');
+            },
+          });
+        }
+      },
+    };
+  },
+});

package/src/rules/import/import-graphql.spec.ts

@@ -0,0 +1,65 @@
+import { tester } from "../../utils/tester";
+import rule from "./import-graphql";
+
+tester.run("import-graphql", rule, {
+  valid: [
+    // 正确的导入来源
+    /* typescript */ `
+      import { Field, ObjectType } from "@nest-boot/graphql";
+    `,
+    // 从其他包导入
+    /* typescript */ `
+      import { Module } from "@nestjs/common";
+    `,
+    // 命名导入
+    /* typescript */ `
+      import { Resolver, Query } from "@nest-boot/graphql";
+    `,
+    // 默认导入
+    /* typescript */ `
+      import GraphQL from "@nest-boot/graphql";
+    `,
+  ],
+  invalid: [
+    // 从 @nestjs/graphql 导入，应该替换为 @nest-boot/graphql
+    {
+      code: /* typescript */ `
+        import { Field, ObjectType } from "@nestjs/graphql";
+      `,
+      output: /* typescript */ `
+        import { Field, ObjectType } from "@nest-boot/graphql";
+      `,
+      errors: [{ messageId: "replaceGraphqlImport" }],
+    },
+    // Resolver 相关导入
+    {
+      code: /* typescript */ `
+        import { Resolver, Query, Mutation } from "@nestjs/graphql";
+      `,
+      output: /* typescript */ `
+        import { Resolver, Query, Mutation } from "@nest-boot/graphql";
+      `,
+      errors: [{ messageId: "replaceGraphqlImport" }],
+    },
+    // 类型导入
+    {
+      code: /* typescript */ `
+        import type { GraphQLModule } from "@nestjs/graphql";
+      `,
+      output: /* typescript */ `
+        import type { GraphQLModule } from "@nest-boot/graphql";
+      `,
+      errors: [{ messageId: "replaceGraphqlImport" }],
+    },
+    // 混合导入
+    {
+      code: /* typescript */ `
+        import { Args, Int } from "@nestjs/graphql";
+      `,
+      output: /* typescript */ `
+        import { Args, Int } from "@nest-boot/graphql";
+      `,
+      errors: [{ messageId: "replaceGraphqlImport" }],
+    },
+  ],
+});

package/src/rules/import/import-graphql.ts

@@ -0,0 +1,36 @@
+import { createRule } from "../../utils/createRule";
+
+export default createRule({
+  name: "import-graphql",
+  meta: {
+    type: "problem",
+    docs: {
+      description:
+        "将从 @nestjs/graphql 导入的包修复为从 @nest-boot/graphql 导入",
+    },
+    fixable: "code",
+    schema: [],
+    messages: {
+      replaceGraphqlImport:
+        "应从 @nest-boot/graphql 导入，而不是 @nestjs/graphql",
+    },
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        // 检查是否从 @nestjs/graphql 导入
+        if (node.source.value === "@nestjs/graphql") {
+          context.report({
+            node,
+            messageId: "replaceGraphqlImport",
+            fix(fixer) {
+              // 将导入源替换为 @nest-boot/graphql
+              return fixer.replaceText(node.source, '"@nest-boot/graphql"');
+            },
+          });
+        }
+      },
+    };
+  },
+});

package/src/rules/import/import-mikro-orm.spec.ts

@@ -0,0 +1,65 @@
+import { tester } from "../../utils/tester";
+import rule from "./import-mikro-orm";
+
+tester.run("import-mikro-orm", rule, {
+  valid: [
+    // 正确的导入来源
+    /* typescript */ `
+      import { MikroOrmModule } from "@nest-boot/mikro-orm";
+    `,
+    // 从其他包导入
+    /* typescript */ `
+      import { Module } from "@nestjs/common";
+    `,
+    // 从 @mikro-orm/core 导入（不应该被替换）
+    /* typescript */ `
+      import { Entity, Property } from "@mikro-orm/core";
+    `,
+    // 命名导入
+    /* typescript */ `
+      import { InjectRepository } from "@nest-boot/mikro-orm";
+    `,
+  ],
+  invalid: [
+    // 从 @mikro-orm/nestjs 导入，应该替换为 @nest-boot/mikro-orm
+    {
+      code: /* typescript */ `
+        import { MikroOrmModule } from "@mikro-orm/nestjs";
+      `,
+      output: /* typescript */ `
+        import { MikroOrmModule } from "@nest-boot/mikro-orm";
+      `,
+      errors: [{ messageId: "replaceMikroOrmImport" }],
+    },
+    // InjectRepository 导入
+    {
+      code: /* typescript */ `
+        import { InjectRepository } from "@mikro-orm/nestjs";
+      `,
+      output: /* typescript */ `
+        import { InjectRepository } from "@nest-boot/mikro-orm";
+      `,
+      errors: [{ messageId: "replaceMikroOrmImport" }],
+    },
+    // 类型导入
+    {
+      code: /* typescript */ `
+        import type { MikroOrmModuleOptions } from "@mikro-orm/nestjs";
+      `,
+      output: /* typescript */ `
+        import type { MikroOrmModuleOptions } from "@nest-boot/mikro-orm";
+      `,
+      errors: [{ messageId: "replaceMikroOrmImport" }],
+    },
+    // 混合导入
+    {
+      code: /* typescript */ `
+        import { MikroOrmModule, InjectRepository } from "@mikro-orm/nestjs";
+      `,
+      output: /* typescript */ `
+        import { MikroOrmModule, InjectRepository } from "@nest-boot/mikro-orm";
+      `,
+      errors: [{ messageId: "replaceMikroOrmImport" }],
+    },
+  ],
+});

package/src/rules/import/import-mikro-orm.ts

@@ -0,0 +1,36 @@
+import { createRule } from "../../utils/createRule";
+
+export default createRule({
+  name: "import-mikro-orm",
+  meta: {
+    type: "problem",
+    docs: {
+      description:
+        "将从 @mikro-orm/nestjs 导入的包修复为从 @nest-boot/mikro-orm 导入",
+    },
+    fixable: "code",
+    schema: [],
+    messages: {
+      replaceMikroOrmImport:
+        "应从 @nest-boot/mikro-orm 导入，而不是 @mikro-orm/nestjs",
+    },
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        // 检查是否从 @mikro-orm/nestjs 导入
+        if (node.source.value === "@mikro-orm/nestjs") {
+          context.report({
+            node,
+            messageId: "replaceMikroOrmImport",
+            fix(fixer) {
+              // 将导入源替换为 @nest-boot/mikro-orm
+              return fixer.replaceText(node.source, '"@nest-boot/mikro-orm"');
+            },
+          });
+        }
+      },
+    };
+  },
+});

package/src/rules/index.ts

@@ -1,15 +1,17 @@
-import entityConstructor from "./entity-constructor";
-import entityPropertyNoOptionalOrNonNullAssertion from "./entity-property-no-optional-or-non-null-assertion";
-import entityPropertyNullable from "./entity-property-nullable";
-import graphqlFieldArgumentsMatchPropertyType from "./graphql-field-arguments-match-property-type";
-import graphqlResolverMethodReturnType from "./graphql-resolver-method-return-type";
+import graphqlFieldConfigFromTypes from "./graphql/graphql-field-config-from-types";
+import graphqlFieldDefiniteAssignment from "./graphql/graphql-field-definite-assignment";
+import importBullmq from "./import/import-bullmq";
+import importGraphql from "./import/import-graphql";
+import importMikroOrm from "./import/import-mikro-orm";
+import entityFieldDefiniteAssignment from "./mikro-orm/entity-field-definite-assignment";
+import entityPropertyConfigFromTypes from "./mikro-orm/entity-property-config-from-types";
 
-export default {
-  "entity-constructor": entityConstructor,
-  "entity-property-no-optional-or-non-null-assertion":
-    entityPropertyNoOptionalOrNonNullAssertion,
-  "entity-property-nullable": entityPropertyNullable,
-  "graphql-field-arguments-match-property-type":
-    graphqlFieldArgumentsMatchPropertyType,
-  "graphql-resolver-method-return-type": graphqlResolverMethodReturnType,
+export const rules = {
+  "graphql-field-config-from-types": graphqlFieldConfigFromTypes,
+  "entity-property-config-from-types": entityPropertyConfigFromTypes,
+  "graphql-field-definite-assignment": graphqlFieldDefiniteAssignment,
+  "entity-field-definite-assignment": entityFieldDefiniteAssignment,
+  "import-bullmq": importBullmq,
+  "import-graphql": importGraphql,
+  "import-mikro-orm": importMikroOrm,
 };

package/src/rules/mikro-orm/entity-field-definite-assignment.spec.ts

@@ -0,0 +1,91 @@
+import { tester } from "../../utils/tester";
+import rule from "./entity-field-definite-assignment";
+
+tester.run("entity-field-definite-assignment", rule, {
+  valid: [
+    // 有初始化值的属性，不需要 !
+    /* typescript */ `
+      @Entity()
+      class User {
+        @Property()
+        createdAt: Date = new Date();
+      }
+    `,
+    // 有 ! 的属性，没有初始化值
+    /* typescript */ `
+      @Entity()
+      class User {
+        @Property()
+        name!: string;
+      }
+    `,
+    // 可选属性，不需要 !
+    /* typescript */ `
+      @Entity()
+      class User {
+        @Property()
+        age?: number;
+      }
+    `,
+    // 可空属性且有初始化值
+    /* typescript */ `
+      @Entity()
+      class User {
+        @Property({ nullable: true })
+        name: string | null = null;
+      }
+    `,
+    // 非 Entity 类不检查
+    /* typescript */ `
+      class NotAnEntity {
+        @Property()
+        field: string;
+      }
+    `,
+    // 没有 @Property 装饰器不检查
+    /* typescript */ `
+      @Entity()
+      class User {
+        field: string;
+      }
+    `,
+  ],
+  invalid: [
+    // 没有初始化值，也没有 !
+    {
+      code: /* typescript */ `
+        @Entity()
+        class User {
+          @Property()
+          name: string;
+        }
+      `,
+      output: /* typescript */ `
+        @Entity()
+        class User {
+          @Property()
+          name!: string;
+        }
+      `,
+      errors: [{ messageId: "addDefiniteAssignment" }],
+    },
+    // 有初始化值，但也有 !
+    {
+      code: /* typescript */ `
+        @Entity()
+        class User {
+          @Property()
+          createdAt!: Date = new Date();
+        }
+      `,
+      output: /* typescript */ `
+        @Entity()
+        class User {
+          @Property()
+          createdAt: Date = new Date();
+        }
+      `,
+      errors: [{ messageId: "removeDefiniteAssignment" }],
+    },
+  ],
+});