@nest-boot/eslint-plugin 7.0.4 → 7.0.6

package/dist/utils/createRule.d.ts

@@ -1,2 +1,4 @@
 import { ESLintUtils } from "@typescript-eslint/utils";
-export declare const createRule: <Options extends readonly unknown[], MessageIds extends string>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, unknown>>) => ESLintUtils.RuleModule<MessageIds, Options, unknown, ESLintUtils.RuleListener>;
+export declare const createRule: <Options extends readonly unknown[], MessageIds extends string>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, unknown>>) => ESLintUtils.RuleModule<MessageIds, Options, unknown, ESLintUtils.RuleListener> & {
+    name: string;
+};

package/dist/utils/decorators.d.ts

@@ -1,29 +1,29 @@
 import { TSESTree } from "@typescript-eslint/utils";
 /**
- * 检查类是否有指定的装饰器
- * @param classDeclaration 类声明节点
- * @param decoratorNames 装饰器名称（可以是字符串或字符串数组）
- * @returns 是否有指定的装饰器
+ * Checks whether a class has the specified decorator(s).
+ * @param classDeclaration - The class declaration node.
+ * @param decoratorNames - Decorator name(s) (can be a string or an array of strings).
+ * @returns Whether the class has the specified decorator(s).
  */
 export declare function hasClassDecorator(classDeclaration: TSESTree.ClassDeclaration, decoratorNames: string | string[]): boolean;
 /**
- * 检查属性是否有指定的装饰器
- * @param propertyDefinition 属性定义节点
- * @param decoratorNames 装饰器名称（可以是字符串或字符串数组）
- * @returns 是否有指定的装饰器
+ * Checks whether a property has the specified decorator(s).
+ * @param propertyDefinition - The property definition node.
+ * @param decoratorNames - Decorator name(s) (can be a string or an array of strings).
+ * @returns Whether the property has the specified decorator(s).
  */
 export declare function hasPropertyDecorator(propertyDefinition: TSESTree.PropertyDefinition, decoratorNames: string | string[]): boolean;
 /**
- * 获取类的装饰器
- * @param classDeclaration 类声明节点
- * @param decoratorName 装饰器名称
- * @returns 装饰器节点，如果不存在则返回 null
+ * Gets a decorator from a class declaration.
+ * @param classDeclaration - The class declaration node.
+ * @param decoratorName - The decorator name.
+ * @returns The decorator node, or null if not found.
  */
 export declare function getClassDecorator(classDeclaration: TSESTree.ClassDeclaration, decoratorName: string): TSESTree.Decorator | null;
 /**
- * 获取属性的装饰器
- * @param propertyDefinition 属性定义节点
- * @param decoratorName 装饰器名称
- * @returns 装饰器节点，如果不存在则返回 null
+ * Gets a decorator from a property definition.
+ * @param propertyDefinition - The property definition node.
+ * @param decoratorName - The decorator name.
+ * @returns The decorator node, or null if not found.
  */
 export declare function getPropertyDecorator(propertyDefinition: TSESTree.PropertyDefinition, decoratorName: string): TSESTree.Decorator | null;

package/dist/utils/decorators.js

@@ -6,10 +6,10 @@ exports.getClassDecorator = getClassDecorator;
 exports.getPropertyDecorator = getPropertyDecorator;
 const utils_1 = require("@typescript-eslint/utils");
 /**
- * 检查类是否有指定的装饰器
- * @param classDeclaration 类声明节点
- * @param decoratorNames 装饰器名称（可以是字符串或字符串数组）
- * @returns 是否有指定的装饰器
+ * Checks whether a class has the specified decorator(s).
+ * @param classDeclaration - The class declaration node.
+ * @param decoratorNames - Decorator name(s) (can be a string or an array of strings).
+ * @returns Whether the class has the specified decorator(s).
  */
 function hasClassDecorator(classDeclaration, decoratorNames) {
     const names = Array.isArray(decoratorNames)
@@ -26,10 +26,10 @@ function hasClassDecorator(classDeclaration, decoratorNames) {
     });
 }
 /**
- * 检查属性是否有指定的装饰器
- * @param propertyDefinition 属性定义节点
- * @param decoratorNames 装饰器名称（可以是字符串或字符串数组）
- * @returns 是否有指定的装饰器
+ * Checks whether a property has the specified decorator(s).
+ * @param propertyDefinition - The property definition node.
+ * @param decoratorNames - Decorator name(s) (can be a string or an array of strings).
+ * @returns Whether the property has the specified decorator(s).
  */
 function hasPropertyDecorator(propertyDefinition, decoratorNames) {
     const names = Array.isArray(decoratorNames)
@@ -46,10 +46,10 @@ function hasPropertyDecorator(propertyDefinition, decoratorNames) {
     });
 }
 /**
- * 获取类的装饰器
- * @param classDeclaration 类声明节点
- * @param decoratorName 装饰器名称
- * @returns 装饰器节点，如果不存在则返回 null
+ * Gets a decorator from a class declaration.
+ * @param classDeclaration - The class declaration node.
+ * @param decoratorName - The decorator name.
+ * @returns The decorator node, or null if not found.
  */
 function getClassDecorator(classDeclaration, decoratorName) {
     return (classDeclaration.decorators.find((decorator) => {
@@ -59,10 +59,10 @@ function getClassDecorator(classDeclaration, decoratorName) {
     }) ?? null);
 }
 /**
- * 获取属性的装饰器
- * @param propertyDefinition 属性定义节点
- * @param decoratorName 装饰器名称
- * @returns 装饰器节点，如果不存在则返回 null
+ * Gets a decorator from a property definition.
+ * @param propertyDefinition - The property definition node.
+ * @param decoratorName - The decorator name.
+ * @returns The decorator node, or null if not found.
  */
 function getPropertyDecorator(propertyDefinition, decoratorName) {
     return (propertyDefinition.decorators.find((decorator) => {

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "@nest-boot/eslint-plugin",
-  "version": "7.0.4",
+  "version": "7.0.6",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nest-boot/nest-boot.git",
+    "directory": "packages/eslint-plugin"
+  },
   "license": "MIT",
   "main": "./dist/index.js",
   "exports": "./dist/index.js",
   "dependencies": {
-    "@typescript-eslint/utils": "^8.44.1"
+    "@typescript-eslint/utils": "^8.56.1"
   },
   "peerDependencies": {
     "@typescript-eslint/parser": "^8.0.0",
@@ -13,20 +18,20 @@
     "typescript": "^5.0.0"
   },
   "devDependencies": {
-    "@eslint/eslintrc": "^3.3.1",
-    "@eslint/js": "^9.36.0",
+    "@eslint/eslintrc": "^3.3.3",
+    "@eslint/js": "^9.39.2",
     "@jest/globals": "^30.2.0",
     "@types/node": "^22.18.6",
-    "@typescript-eslint/parser": "^8.44.1",
-    "@typescript-eslint/rule-tester": "^8.44.1",
-    "eslint": "^9.36.0",
+    "@typescript-eslint/parser": "^8.56.1",
+    "@typescript-eslint/rule-tester": "^8.56.1",
+    "eslint": "^9.39.3",
     "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.3",
-    "typescript-eslint": "^8.46.2",
-    "@nest-boot/tsconfig": "^7.0.1"
+    "typescript-eslint": "^8.56.1",
+    "@nest-boot/tsconfig": "^7.0.2"
   },
   "publishConfig": {
     "access": "public"

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

@@ -3,7 +3,7 @@ import rule from "./graphql-field-config-from-types";
 
 tester.run("graphql-field-config-from-types", rule, {
   valid: [
-    // 正确的 string 类型
+    // Correct string type
     /* typescript */ `
       @ObjectType()
       class User {
@@ -11,7 +11,7 @@ tester.run("graphql-field-config-from-types", rule, {
         name!: string;
       }
     `,
-    // 正确的 number 类型（Float）
+    // Correct number type (Float)
     /* typescript */ `
       @ObjectType()
       class User {
@@ -19,7 +19,7 @@ tester.run("graphql-field-config-from-types", rule, {
         score!: number;
       }
     `,
-    // 正确的 number 类型（Int）
+    // Correct number type (Int)
     /* typescript */ `
       @ObjectType()
       class User {
@@ -27,7 +27,7 @@ tester.run("graphql-field-config-from-types", rule, {
         age!: number;
       }
     `,
-    // 正确的 boolean 类型
+    // Correct boolean type
     /* typescript */ `
       @ObjectType()
       class User {
@@ -35,7 +35,7 @@ tester.run("graphql-field-config-from-types", rule, {
         isActive!: boolean;
       }
     `,
-    // 正确的 nullable 配置
+    // Correct nullable configuration
     /* typescript */ `
       @ObjectType()
       class User {
@@ -43,7 +43,7 @@ tester.run("graphql-field-config-from-types", rule, {
         name?: string;
       }
     `,
-    // 正确的数组类型
+    // Correct array type
     /* typescript */ `
       @ObjectType()
       class User {
@@ -51,7 +51,7 @@ tester.run("graphql-field-config-from-types", rule, {
         tags!: string[];
       }
     `,
-    // ID 类型
+    // ID type
     /* typescript */ `
       @ObjectType()
       class User {
@@ -59,7 +59,7 @@ tester.run("graphql-field-config-from-types", rule, {
         id!: string;
       }
     `,
-    // 自定义类型
+    // Custom type
     /* typescript */ `
       @ObjectType()
       class User {
@@ -67,7 +67,7 @@ tester.run("graphql-field-config-from-types", rule, {
         profile!: Profile;
       }
     `,
-    // 带有 HideField 装饰器的属性不需要 @Field
+    // Property with @HideField decorator does not need @Field
     /* typescript */ `
       @ObjectType()
       class User {
@@ -75,13 +75,13 @@ tester.run("graphql-field-config-from-types", rule, {
         password!: string;
       }
     `,
-    // 非 GraphQL 模型类不检查
+    // Non-GraphQL model class is not checked
     /* typescript */ `
       class NotAGraphQLModel {
         field: string;
       }
     `,
-    // 复杂的配置对象（包含展开运算符和条件表达式）
+    // Complex config object (with spread operator and conditional expression)
     /* typescript */ `
       @ObjectType()
       class Connection {
@@ -98,7 +98,7 @@ tester.run("graphql-field-config-from-types", rule, {
     `,
   ],
   invalid: [
-    // @Field 类型不匹配
+    // @Field type mismatch
     {
       code: /* typescript */ `
         @ObjectType()
@@ -116,7 +116,7 @@ tester.run("graphql-field-config-from-types", rule, {
       `,
       errors: [{ messageId: "alignFieldDecoratorWithTsType" }],
     },
-    // nullable 配置不匹配
+    // nullable configuration mismatch
     {
       code: /* typescript */ `
         @ObjectType()
@@ -134,7 +134,7 @@ tester.run("graphql-field-config-from-types", rule, {
       `,
       errors: [{ messageId: "alignFieldDecoratorWithTsType" }],
     },
-    // 不应该有 nullable 但设置了
+    // Should not have nullable but it is set
     {
       code: /* typescript */ `
         @ObjectType()
@@ -152,7 +152,7 @@ tester.run("graphql-field-config-from-types", rule, {
       `,
       errors: [{ messageId: "alignFieldDecoratorWithTsType" }],
     },
-    // 数组类型不匹配
+    // Array type mismatch
     {
       code: /* typescript */ `
         @ObjectType()
@@ -170,7 +170,7 @@ tester.run("graphql-field-config-from-types", rule, {
       `,
       errors: [{ messageId: "alignFieldDecoratorWithTsType" }],
     },
-    // 缺少 type function 但有其他配置选项（应保留）
+    // Missing type function but has other config options (should be preserved)
     {
       code: /* typescript */ `
         @ObjectType()
@@ -191,7 +191,7 @@ tester.run("graphql-field-config-from-types", rule, {
       `,
       errors: [{ messageId: "alignFieldDecoratorWithTsType" }],
     },
-    // 配置 nullable 时保留其他选项
+    // nullable config should preserve other options
     {
       code: /* typescript */ `
         @ObjectType()
@@ -209,7 +209,7 @@ tester.run("graphql-field-config-from-types", rule, {
       `,
       errors: [{ messageId: "alignFieldDecoratorWithTsType" }],
     },
-    // 复杂配置对象（包含展开运算符）缺少 type function
+    // Complex config object (with spread operator) missing type function
     {
       code: /* typescript */ `
         @ObjectType()

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

@@ -7,7 +7,7 @@ import {
   hasClassDecorator,
 } from "../../utils/decorators";
 
-// 自定义 Fix 对象类型,用于延迟应用修复
+// Custom Fix object type for deferred fix application
 interface CustomFix {
   type: "insert" | "replace";
   range: readonly [number, number];
@@ -35,7 +35,7 @@ export default createRule<
     type: "problem",
     docs: {
       description:
-        "根据 TypeScript 类型自动生成或修正 @Field 装饰器的类型与 nullable 配置（支持数组）。",
+        "Automatically generate or fix @Field decorator type and nullable configuration based on TypeScript types (with array support).",
     },
     fixable: "code",
     schema: [
@@ -49,7 +49,7 @@ export default createRule<
               enum: ["ignore", "remove"],
             },
             description:
-              "配置每个装饰器的行为。ignore: 跳过检查；remove: 移除 @Field。默认：{ HideField: 'remove', OneToOne: 'remove', OneToMany: 'remove', ManyToOne: 'remove', ManyToMany: 'remove' }",
+              "Configure behavior for each decorator. ignore: skip checks; remove: remove @Field. Default: { HideField: 'remove', OneToOne: 'remove', OneToMany: 'remove', ManyToOne: 'remove', ManyToMany: 'remove' }",
           },
         },
         additionalProperties: false,
@@ -57,9 +57,9 @@ export default createRule<
     ],
     messages: {
       alignFieldDecoratorWithTsType:
-        "@Field 装饰器应与 TypeScript 类型保持一致（类型与 nullable）。",
+        "@Field decorator should align with the TypeScript type (type and nullable).",
       removeFieldDecorator:
-        "属性带有 @{{decoratorName}} 装饰器，应移除 @Field 装饰器。",
+        "Property has a @{{decoratorName}} decorator, @Field decorator should be removed.",
     },
   },
   defaultOptions: [
@@ -85,7 +85,7 @@ export default createRule<
         case AST_NODE_TYPES.TSStringKeyword:
           return "String";
         case AST_NODE_TYPES.TSNumberKeyword:
-          // 默认 number → Float（GraphQL 默认也是 Float；Int 需显式声明）
+          // Default number → Float (GraphQL default is also Float; Int must be declared explicitly)
           return "Float";
         default:
           return null;
@@ -129,12 +129,12 @@ export default createRule<
           ? property.typeAnnotation.typeAnnotation
           : null;
 
-      // 可选属性（?）视为可空
+      // Optional property (?) is treated as nullable
       if (property.optional) {
         isNullable = true;
       }
 
-      // 处理联合类型中的 null/undefined
+      // Handle null/undefined in union types
       if (baseTypeNode?.type === AST_NODE_TYPES.TSUnionType) {
         const hasNullish = baseTypeNode.types.some((t: TSESTree.TypeNode) => {
           return (
@@ -153,7 +153,7 @@ export default createRule<
           }) ?? null;
       }
 
-      // 先解包 Ref<T> 和 Opt<T> → T，并在内部再次处理 null/undefined
+      // First unwrap Ref<T> and Opt<T> → T, and handle null/undefined within
       if (
         baseTypeNode?.type === AST_NODE_TYPES.TSTypeReference &&
         baseTypeNode.typeName.type === AST_NODE_TYPES.Identifier &&
@@ -161,7 +161,7 @@ export default createRule<
           baseTypeNode.typeName.name === "Opt")
       ) {
         let inner = baseTypeNode.typeArguments?.params[0] ?? null;
-        if (inner && inner.type === AST_NODE_TYPES.TSUnionType) {
+        if (inner?.type === AST_NODE_TYPES.TSUnionType) {
           const hasNullish = inner.types.some((t: TSESTree.TypeNode) => {
             return (
               t.type === AST_NODE_TYPES.TSNullKeyword ||
@@ -180,7 +180,7 @@ export default createRule<
         baseTypeNode = inner ?? baseTypeNode;
       }
 
-      // 数组类型（T[] 或 Array<T>）- 在解包 Opt/Ref 之后检查
+      // Array type (T[] or Array<T>) - checked after unwrapping Opt/Ref
       const elementTypeNode = baseTypeNode
         ? extractArrayElementType(baseTypeNode)
         : null;
@@ -191,7 +191,7 @@ export default createRule<
       const targetTypeNode: TSESTree.TypeNode | null =
         elementTypeNode ?? baseTypeNode;
 
-      // 无显式类型时，尝试从字面量初始值推断
+      // When no explicit type, try to infer from literal initializer
       if (!targetTypeNode) {
         if (property.value?.type === AST_NODE_TYPES.Literal) {
           const value = property.value.value;
@@ -206,7 +206,7 @@ export default createRule<
         return null;
       }
 
-      // id 字段优先使用 GraphQL 标量 ID
+      // id field prefers GraphQL scalar ID
       const propertyName =
         property.key.type === AST_NODE_TYPES.Identifier
           ? property.key.name
@@ -220,7 +220,7 @@ export default createRule<
         return { typeName: "ID", isArray, isNullable };
       }
 
-      // Record<*, *> → GraphQLJSONObject（不限制键值类型）
+      // Record<*, *> → GraphQLJSONObject (no restriction on key/value types)
       if (
         targetTypeNode.type === AST_NODE_TYPES.TSTypeReference &&
         targetTypeNode.typeName.type === AST_NODE_TYPES.Identifier &&
@@ -229,13 +229,13 @@ export default createRule<
         return { typeName: "GraphQLJSONObject", isArray, isNullable };
       }
 
-      // 关键字类型 → GraphQL 标量
+      // Keyword types → GraphQL scalars
       const scalar = scalarFromTsKeyword(targetTypeNode.type);
       if (scalar) {
         return { typeName: scalar, isArray, isNullable };
       }
 
-      // 标识符（类/自定义类型）
+      // Identifier (class/custom type)
       const ident = getIdentifierName(targetTypeNode);
       if (ident) {
         return { typeName: ident, isArray, isNullable };
@@ -313,68 +313,64 @@ export default createRule<
         ? `() => [${typeName}]`
         : `() => ${typeName}`;
 
-      // 提取现有的配置选项（除了 nullable）
+      // Extract existing config options (except nullable)
       const callExpr = fieldDecorator.expression;
       const existingOptions: string[] = [];
 
-      // 检查是否有现有的配置对象
+      // Check if there is an existing config object
       let optionsArg: TSESTree.ObjectExpression | null = null;
       if (
         callExpr.type === AST_NODE_TYPES.CallExpression &&
         callExpr.arguments.length > 0
       ) {
-        // 如果第一个参数是对象表达式（没有 type function）
-        if (
-          callExpr.arguments[0] &&
-          callExpr.arguments[0].type === AST_NODE_TYPES.ObjectExpression
-        ) {
+        // If the first argument is an object expression (no type function)
+        if (callExpr.arguments[0]?.type === AST_NODE_TYPES.ObjectExpression) {
           optionsArg = callExpr.arguments[0];
         }
-        // 如果第二个参数是对象表达式（有 type function）
+        // If the second argument is an object expression (has type function)
         else if (
-          callExpr.arguments[1] &&
-          callExpr.arguments[1].type === AST_NODE_TYPES.ObjectExpression
+          callExpr.arguments[1]?.type === AST_NODE_TYPES.ObjectExpression
         ) {
           optionsArg = callExpr.arguments[1];
         }
       }
 
-      // 提取现有选项，同时处理 nullable
+      // Extract existing options, while handling nullable
       let hasNullableProperty = false;
       if (optionsArg) {
         optionsArg.properties.forEach((prop: TSESTree.ObjectLiteralElement) => {
-          // 处理展开运算符 (SpreadElement)
+          // Handle spread elements (SpreadElement)
           if (prop.type === AST_NODE_TYPES.SpreadElement) {
             const propText = source.getText(prop);
             existingOptions.push(propText);
             return;
           }
-          // 处理普通属性 (Property)
+          // Handle regular properties (Property)
           if (
             prop.key.type === AST_NODE_TYPES.Identifier &&
             prop.key.name === "nullable"
           ) {
             hasNullableProperty = true;
-            // 根据类型决定是否保留或更新 nullable
+            // Decide whether to keep or update nullable based on type
             if (info.isNullable) {
               existingOptions.push("nullable: true");
             }
-            // 如果不需要 nullable，则跳过（不保留）
+            // If nullable is not needed, skip (don't keep)
           } else {
-            // 保留原有的其他配置
+            // Keep other existing config options
             const propText = source.getText(prop);
             existingOptions.push(propText);
           }
         });
       }
 
-      // 如果需要 nullable 但原配置中没有，则添加到最前面
+      // If nullable is needed but not in original config, prepend it
       // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
       if (info.isNullable && !hasNullableProperty) {
         existingOptions.unshift("nullable: true");
       }
 
-      // 构建新的装饰器文本
+      // Build the new decorator text
       const optionsExpr =
         existingOptions.length > 0 ? `, { ${existingOptions.join(", ")} }` : "";
       const newDecoratorText = `@Field(${typeExpr}${optionsExpr})`;
@@ -422,7 +418,7 @@ export default createRule<
             ManyToMany: "remove",
           };
 
-          // 检查是否有配置的装饰器
+          // Check if the property has a configured decorator
           let foundDecoratorName: string | null = null;
           let foundBehavior: DecoratorBehavior | null = null;
 
@@ -440,12 +436,12 @@ export default createRule<
             }
           }
 
-          // 如果是 ignore 行为，直接跳过
+          // If behavior is "ignore", skip directly
           if (foundBehavior === "ignore") return;
 
           const fieldDecorator = getPropertyDecorator(member, "Field");
 
-          // 如果是 remove 行为且有 @Field，则移除 @Field
+          // If behavior is "remove" and has @Field, remove @Field
           if (foundBehavior === "remove" && fieldDecorator) {
             context.report({
               node: fieldDecorator,
@@ -454,11 +450,11 @@ export default createRule<
                 decoratorName: foundDecoratorName ?? "unknown",
               },
               fix: (fixer) => {
-                // 移除整个装饰器行（包括换行）
+                // Remove the entire decorator line (including newline)
                 const decoratorStart = fieldDecorator.range[0];
                 const decoratorEnd = fieldDecorator.range[1];
 
-                // 查找装饰器后的换行符和空格
+                // Find the newline and whitespace after the decorator
                 const textAfter = source.text.slice(
                   decoratorEnd,
                   decoratorEnd + 10,
@@ -474,13 +470,13 @@ export default createRule<
             return;
           }
 
-          // 如果是 remove 行为但没有 @Field，跳过
+          // If behavior is "remove" but no @Field, skip
           if (foundBehavior === "remove") return;
 
           const typeInfo = computeTypeInfo(member);
           if (!typeInfo?.typeName) return;
 
-          // 如果没有 @Field 装饰器，添加它
+          // If there is no @Field decorator, add one
           if (!fieldDecorator) {
             context.report({
               node: member,
@@ -493,7 +489,7 @@ export default createRule<
             return;
           }
 
-          // 若已有 ArrowFunction 但与期望不一致，也进行修正
+          // If there is an existing ArrowFunction but it doesn't match expectations, fix it
           const callExpr = fieldDecorator.expression;
           if (callExpr.type !== AST_NODE_TYPES.CallExpression) return;
 
@@ -525,9 +521,9 @@ export default createRule<
                 },
               );
 
-            // 对于 number 类型，Int 和 Float 都是合法的
+            // For number types, both Int and Float are valid
             const isNumberType = typeInfo.typeName === "Float";
-            const actualTypeText = calleeText.replace(/^\[|\]$/g, ""); // 移除数组括号
+            const actualTypeText = calleeText.replace(/^\[|\]$/g, ""); // Remove array brackets
             const isValidNumberType =
               isNumberType &&
               (actualTypeText === "Int" || actualTypeText === "Float");