eslint-plugin-class-validator-type-match 2.1.0 → 3.0.0

package/dist/index.d.ts

@@ -1,11 +1,14 @@
 declare const _default: {
     rules: {
-        'decorator-type-match': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"mismatch" | "nestedArrayMismatch" | "missingValidateNested" | "enumMismatch" | "typeMismatch" | "missingEachOption" | "unnecessaryValidateNested" | "invalidEachOption" | "missingTypeDecorator" | "tupleValidationWarning" | "multiTypeUnionWarning" | "mixedComplexityUnionWarning" | "pickOmitWarning" | "missingDefiniteAssignment", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+        'decorator-type-match': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"mismatch" | "enumMismatch" | "invalidEachOption", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
         'optional-decorator-match': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"missingOptionalDecorator" | "missingOptionalSyntax" | "conflictingDefiniteAssignment" | "undefinedUnionWithoutDecorator" | "undefinedUnionWithoutOptional" | "nullUnionIncorrect" | "redundantUndefinedInType", [{
             strictNullChecks?: boolean;
             checkDefaultValues?: boolean;
             customOptionalDecorators?: string[];
         }], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+        'validate-nested-match': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"nestedArrayMismatch" | "missingValidateNested" | "missingEachOption" | "unnecessaryValidateNested" | "tupleValidationWarning" | "multiTypeUnionWarning" | "mixedComplexityUnionWarning" | "pickOmitWarning", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+        'type-decorator-match': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"typeMismatch" | "missingTypeDecorator", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+        'definite-assignment-match': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"missingDefiniteAssignment", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
     };
     configs: {
         recommended: {
@@ -13,6 +16,27 @@ declare const _default: {
             rules: {
                 'class-validator-type-match/decorator-type-match': string;
                 'class-validator-type-match/optional-decorator-match': string;
+                'class-validator-type-match/validate-nested-match': string;
+                'class-validator-type-match/type-decorator-match': string;
+                'class-validator-type-match/definite-assignment-match': string;
+            };
+        };
+        strict: {
+            plugins: string[];
+            rules: {
+                'class-validator-type-match/decorator-type-match': string;
+                'class-validator-type-match/optional-decorator-match': string;
+                'class-validator-type-match/validate-nested-match': string;
+                'class-validator-type-match/type-decorator-match': string;
+                'class-validator-type-match/definite-assignment-match': string;
+            };
+        };
+        basic: {
+            plugins: string[];
+            rules: {
+                'class-validator-type-match/decorator-type-match': string;
+                'class-validator-type-match/optional-decorator-match': string;
+                'class-validator-type-match/definite-assignment-match': string;
             };
         };
     };

package/dist/index.js

@@ -4,10 +4,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 const decorator_type_match_1 = __importDefault(require("./rules/decorator-type-match"));
 const optional_decorator_match_1 = __importDefault(require("./rules/optional-decorator-match"));
+const validate_nested_match_1 = __importDefault(require("./rules/validate-nested-match"));
+const type_decorator_match_1 = __importDefault(require("./rules/type-decorator-match"));
+const definite_assignment_match_1 = __importDefault(require("./rules/definite-assignment-match"));
 module.exports = {
     rules: {
         'decorator-type-match': decorator_type_match_1.default,
         'optional-decorator-match': optional_decorator_match_1.default,
+        'validate-nested-match': validate_nested_match_1.default,
+        'type-decorator-match': type_decorator_match_1.default,
+        'definite-assignment-match': definite_assignment_match_1.default,
     },
     configs: {
         recommended: {
@@ -15,6 +21,27 @@ module.exports = {
             rules: {
                 'class-validator-type-match/decorator-type-match': 'error',
                 'class-validator-type-match/optional-decorator-match': 'error',
+                'class-validator-type-match/validate-nested-match': 'error',
+                'class-validator-type-match/type-decorator-match': 'error',
+                'class-validator-type-match/definite-assignment-match': 'error',
+            },
+        },
+        strict: {
+            plugins: ['class-validator-type-match'],
+            rules: {
+                'class-validator-type-match/decorator-type-match': 'error',
+                'class-validator-type-match/optional-decorator-match': 'error',
+                'class-validator-type-match/validate-nested-match': 'error',
+                'class-validator-type-match/type-decorator-match': 'error',
+                'class-validator-type-match/definite-assignment-match': 'error',
+            },
+        },
+        basic: {
+            plugins: ['class-validator-type-match'],
+            rules: {
+                'class-validator-type-match/decorator-type-match': 'error',
+                'class-validator-type-match/optional-decorator-match': 'error',
+                'class-validator-type-match/definite-assignment-match': 'error',
             },
         },
     },

package/dist/rules/decorator-type-match.d.ts

@@ -1,38 +1,50 @@
 import { ESLintUtils } from '@typescript-eslint/utils';
-type MessageIds = 'mismatch' | 'nestedArrayMismatch' | 'missingValidateNested' | 'enumMismatch' | 'typeMismatch' | 'missingEachOption' | 'unnecessaryValidateNested' | 'invalidEachOption' | 'missingTypeDecorator' | 'tupleValidationWarning' | 'multiTypeUnionWarning' | 'mixedComplexityUnionWarning' | 'pickOmitWarning' | 'missingDefiniteAssignment';
+type MessageIds = 'mismatch' | 'enumMismatch' | 'invalidEachOption';
 /**
  * ESLint rule to ensure class-validator decorators match TypeScript type annotations.
  *
  * This rule prevents common mistakes where the decorator type (e.g., @IsString)
  * doesn't match the actual TypeScript type annotation (e.g., number).
  *
- * Enhanced to handle:
- * - Arrays of objects requiring @ValidateNested({ each: true })
- * - Nested objects requiring @ValidateNested()
- * - Nullable complex types (Address | null, Address | undefined)
- * - Nested arrays (Address[][])
- * - Type literals
- * - class-transformer decorators
- * - Enum types (both TypeScript enums and union types)
- * - Literal types (e.g., "admin", 25)
- * - Intersection types (e.g., Profile & Settings)
- * - Branded types (string & { __brand: 'UserId' })
- * - @Type(() => ClassName) decorator matching
- * - Readonly arrays (readonly T[])
- * - Tuple types ([T, U])
+ * Handles:
+ * - Basic type validation (string, number, boolean, array, Date, object, enum)
+ * - @IsEnum validation with enum references and union literals
+ * - { each: true } option for array element validation
+ * - Invalid { each: true } usage on non-array types
  * - Nullable unions (T | null | undefined)
- * - Unnecessary @ValidateNested on primitive arrays
- * - Decorators with { each: true } option for array element validation
- * - Template literal types (`user-${string}`)
- * - Namespace/qualified type references (MyNamespace.MyEnum)
- * - Invalid { each: true } on non-array types
- * - Missing @Type decorator when @ValidateNested is present
- * - Type aliases (via TypeScript type checker)
- * - Record<K, V> utility types with primitive values
- * - Utility types: Partial<T>, Required<T>, Pick<T, K>, Omit<T, K>, ReadonlyArray<T>, NonNullable<T>, Extract<T, U>, Exclude<T, U>
- * - Multi-type unions with explicit warnings for complex scenarios
- * - Mixed complexity unions (primitive | complex types)
- * - Missing definite assignment assertion (!) on properties that require it
+ * - Utility types (Partial, Pick, Omit, etc.)
+ * - Template literal types, namespace references, branded types
+ *
+ * @example
+ * // ✅ Good - decorator matches type
+ * class User {
+ *   @IsString()
+ *   name!: string;
+ *
+ *   @IsNumber()
+ *   age!: number;
+ * }
+ *
+ * @example
+ * // ❌ Bad - decorator doesn't match type
+ * class User {
+ *   @IsString()
+ *   age!: number; // Error: @IsString does not match type number
+ * }
+ *
+ * @example
+ * // ✅ Good - { each: true } for array elements
+ * class User {
+ *   @IsString({ each: true })
+ *   tags!: string[];
+ * }
+ *
+ * @example
+ * // ❌ Bad - { each: true } on non-array
+ * class User {
+ *   @IsString({ each: true })
+ *   name!: string; // Error: { each: true } on non-array type
+ * }
  */
 declare const _default: ESLintUtils.RuleModule<MessageIds, [], unknown, ESLintUtils.RuleListener>;
 export default _default;