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

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

@@ -0,0 +1,141 @@
+import { AST_NODE_TYPES, TSESTree } from "@typescript-eslint/utils";
+
+import { createRule } from "../../utils/createRule";
+import {
+  hasClassDecorator,
+  hasPropertyDecorator,
+} from "../../utils/decorators";
+
+export default createRule({
+  name: "entity-field-definite-assignment",
+  meta: {
+    type: "suggestion",
+    fixable: "code",
+    schema: [],
+    docs: {
+      description: "Avoid looping over enums.",
+    },
+    messages: {
+      addDefiniteAssignment: "Add definite assignment assertion (!).",
+      removeDefiniteAssignment: "Remove definite assignment assertion (!).",
+    },
+  },
+  defaultOptions: [],
+  create(context) {
+    const source = context.sourceCode;
+
+    const isEntityClass = (node: TSESTree.ClassDeclaration): boolean => {
+      return hasClassDecorator(node, "Entity");
+    };
+
+    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 (!isEntityClass(node)) return;
+
+        node.body.body.forEach((member: TSESTree.ClassElement) => {
+          if (member.type !== AST_NODE_TYPES.PropertyDefinition) return;
+          if (!hasPropertyDecorator(member, "Property")) 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/mikro-orm/entity-property-config-from-types.spec.ts

@@ -0,0 +1,262 @@
+import { tester } from "../../utils/tester";
+import rule from "./entity-property-config-from-types";
+
+tester.run("entity-property-config-from-types", rule, {
+  valid: [
+    // 正确的 string 类型
+    /* typescript */ `
+      import { Entity, Property } from "@mikro-orm/core";
+
+      @Entity()
+      class User {
+        @Property({ type: t.string })
+        name!: string;
+      }
+    `,
+    // 正确的 nullable 配置
+    /* typescript */ `
+      import { Entity, Property } from "@mikro-orm/core";
+
+      @Entity()
+      class User {
+        @Property({ type: t.string, nullable: true })
+        name?: string;
+      }
+    `,
+    // 使用 Opt<T> 类型且有初始化值
+    /* typescript */ `
+      import { Entity, Property, Opt } from "@mikro-orm/core";
+
+      @Entity()
+      class User {
+        @Property({ type: t.boolean })
+        isActive: Opt<boolean> = false;
+      }
+    `,
+    // 关系装饰器不需要 @Property
+    /* typescript */ `
+      import { Entity, ManyToOne } from "@mikro-orm/core";
+
+      @Entity()
+      class Post {
+        @ManyToOne()
+        author!: User;
+      }
+    `,
+    // PrimaryKey 不需要 @Property
+    /* typescript */ `
+      import { Entity, PrimaryKey } from "@mikro-orm/core";
+
+      @Entity()
+      class User {
+        @PrimaryKey()
+        id!: number;
+      }
+    `,
+    // 枚举类型使用 @Enum
+    /* typescript */ `
+      import { Entity, Enum } from "@mikro-orm/core";
+
+      enum Role {
+        Admin,
+        User
+      }
+
+      @Entity()
+      class User {
+        @Enum({ items: () => Role })
+        role!: Role;
+      }
+    `,
+    // 数组类型
+    /* typescript */ `
+      import { Entity, Property } from "@mikro-orm/core";
+
+      @Entity()
+      class User {
+        @Property({ type: t.array })
+        tags!: number[];
+      }
+    `,
+    // boolean 类型
+    /* typescript */ `
+      import { Entity, Property } from "@mikro-orm/core";
+
+      @Entity()
+      class User {
+        @Property({ type: t.boolean })
+        isActive!: boolean;
+      }
+    `,
+    // 使用 t.text 代替 t.string（有效的 string 类型配置）
+    /* typescript */ `
+      import { Entity, Property } from "@mikro-orm/core";
+
+      @Entity()
+      class User {
+        @Property({ type: t.text })
+        description!: string;
+      }
+    `,
+    // 非 Entity 类不检查
+    /* typescript */ `
+      class NotAnEntity {
+        field: string;
+      }
+    `,
+  ],
+  invalid: [
+    // type 配置不匹配
+    {
+      code: /* typescript */ `
+        import { Entity, Property } from "@mikro-orm/core";
+
+        @Entity()
+        class User {
+          @Property({ type: t.float })
+          name!: string;
+        }
+      `,
+      output: /* typescript */ `
+        import { Entity, Property } from "@mikro-orm/core";
+
+        @Entity()
+        class User {
+          @Property({ type: t.string })
+          name!: string;
+        }
+      `,
+      errors: [{ messageId: "alignPropertyDecoratorWithTsType" }],
+    },
+    // nullable 配置不匹配
+    {
+      code: /* typescript */ `
+        import { Entity, Property } from "@mikro-orm/core";
+
+        @Entity()
+        class User {
+          @Property({ type: t.string })
+          name?: string;
+        }
+      `,
+      output: /* typescript */ `
+        import { Entity, Property } from "@mikro-orm/core";
+
+        @Entity()
+        class User {
+          @Property({ type: t.string, nullable: true })
+          name?: string;
+        }
+      `,
+      errors: [{ messageId: "alignPropertyDecoratorWithTsType" }],
+    },
+    // 有初始化值但没有使用 Opt<T>
+    {
+      code: /* typescript */ `
+        import { Entity, Property } from "@mikro-orm/core";
+
+        @Entity()
+        class User {
+          @Property({ type: t.boolean })
+          isActive: boolean = false;
+        }
+      `,
+      output: /* typescript */ `
+        import { Entity, Property, Opt } from "@mikro-orm/core";
+
+        @Entity()
+        class User {
+          @Property({ type: t.boolean })
+          isActive: Opt<boolean> = false;
+        }
+      `,
+      errors: [{ messageId: "useOptTypeForInitializedProperty" }],
+    },
+    // 枚举类型应该使用 @Enum 装饰器
+    {
+      code: /* typescript */ `
+        import { Entity, Property } from "@mikro-orm/core";
+
+        enum Role {
+          Admin,
+          User
+        }
+
+        @Entity()
+        class User {
+          @Property()
+          role!: Role;
+        }
+      `,
+      output: /* typescript */ `
+        import { Entity, Property } from "@mikro-orm/core";
+
+        enum Role {
+          Admin,
+          User
+        }
+
+        @Entity()
+        class User {
+          @Enum({ items: () => Role })
+          role!: Role;
+        }
+      `,
+      errors: [{ messageId: "useEnumDecorator" }],
+    },
+    // @Enum 的 nullable 配置不匹配
+    {
+      code: /* typescript */ `
+        import { Entity, Enum } from "@mikro-orm/core";
+
+        enum Role {
+          Admin,
+          User
+        }
+
+        @Entity()
+        class User {
+          @Enum({ items: () => Role })
+          role?: Role;
+        }
+      `,
+      output: /* typescript */ `
+        import { Entity, Enum } from "@mikro-orm/core";
+
+        enum Role {
+          Admin,
+          User
+        }
+
+        @Entity()
+        class User {
+          @Enum({ items: () => Role, nullable: true })
+          role?: Role;
+        }
+      `,
+      errors: [{ messageId: "alignPropertyDecoratorWithTsType" }],
+    },
+    // 数组类型配置不匹配
+    {
+      code: /* typescript */ `
+        import { Entity, Property } from "@mikro-orm/core";
+
+        @Entity()
+        class User {
+          @Property({ type: t.string })
+          tags!: number[];
+        }
+      `,
+      output: /* typescript */ `
+        import { Entity, Property } from "@mikro-orm/core";
+
+        @Entity()
+        class User {
+          @Property({ type: t.array })
+          tags!: number[];
+        }
+      `,
+      errors: [{ messageId: "alignPropertyDecoratorWithTsType" }],
+    },
+  ],
+});