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

package/dist/index.d.ts

@@ -9,6 +9,7 @@ declare const _default: {
         '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>;
+        'dto-filename-match': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"incorrectDtoClassName", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
     };
     configs: {
         recommended: {
@@ -19,6 +20,7 @@ declare const _default: {
                 'class-validator-type-match/validate-nested-match': string;
                 'class-validator-type-match/type-decorator-match': string;
                 'class-validator-type-match/definite-assignment-match': string;
+                'class-validator-type-match/dto-filename-match': string;
             };
         };
         strict: {
@@ -29,6 +31,7 @@ declare const _default: {
                 'class-validator-type-match/validate-nested-match': string;
                 'class-validator-type-match/type-decorator-match': string;
                 'class-validator-type-match/definite-assignment-match': string;
+                'class-validator-type-match/dto-filename-match': string;
             };
         };
         basic: {
@@ -37,6 +40,7 @@ declare const _default: {
                 'class-validator-type-match/decorator-type-match': string;
                 'class-validator-type-match/optional-decorator-match': string;
                 'class-validator-type-match/definite-assignment-match': string;
+                'class-validator-type-match/dto-filename-match': string;
             };
         };
     };

package/dist/index.js

@@ -7,6 +7,7 @@ const optional_decorator_match_1 = __importDefault(require("./rules/optional-dec
 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"));
+const dto_filename_match_1 = __importDefault(require("./rules/dto-filename-match"));
 module.exports = {
     rules: {
         'decorator-type-match': decorator_type_match_1.default,
@@ -14,6 +15,7 @@ module.exports = {
         'validate-nested-match': validate_nested_match_1.default,
         'type-decorator-match': type_decorator_match_1.default,
         'definite-assignment-match': definite_assignment_match_1.default,
+        'dto-filename-match': dto_filename_match_1.default,
     },
     configs: {
         recommended: {
@@ -24,6 +26,7 @@ module.exports = {
                 'class-validator-type-match/validate-nested-match': 'error',
                 'class-validator-type-match/type-decorator-match': 'error',
                 'class-validator-type-match/definite-assignment-match': 'error',
+                'class-validator-type-match/dto-filename-match': 'error',
             },
         },
         strict: {
@@ -34,6 +37,7 @@ module.exports = {
                 'class-validator-type-match/validate-nested-match': 'error',
                 'class-validator-type-match/type-decorator-match': 'error',
                 'class-validator-type-match/definite-assignment-match': 'error',
+                'class-validator-type-match/dto-filename-match': 'error',
             },
         },
         basic: {
@@ -42,6 +46,7 @@ module.exports = {
                 'class-validator-type-match/decorator-type-match': 'error',
                 'class-validator-type-match/optional-decorator-match': 'error',
                 'class-validator-type-match/definite-assignment-match': 'error',
+                'class-validator-type-match/dto-filename-match': 'error',
             },
         },
     },

package/dist/rules/dto-filename-match.d.ts

@@ -0,0 +1,48 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+/**
+ * ESLint rule to ensure DTO class names match their file naming convention.
+ *
+ * This rule enforces consistent naming between DTO files and their class names:
+ * - Files like `.body.dto.ts`, `.query.dto.ts`, `.param.dto.ts` should have classes named `BodyDto`, `QueryDto`, `ParamDto`
+ * - Files like `.dto.ts` should have classes named `Dto`
+ *
+ * The rule extracts the type identifier (body, query, param, etc.) from the filename
+ * and validates that the class name follows the pattern `<Type>Dto` where `<Type>` is capitalized.
+ *
+ * @example
+ * // ✅ Good - file: create-user.body.dto.ts
+ * class CreateUserBodyDto {
+ *   @IsString()
+ *   name!: string;
+ * }
+ *
+ * @example
+ * // ❌ Bad - file: create-user.body.dto.ts
+ * class CreateUserDto { // Error: Expected CreateUserBodyDto
+ *   @IsString()
+ *   name!: string;
+ * }
+ *
+ * @example
+ * // ✅ Good - file: user.dto.ts
+ * class UserDto {
+ *   @IsString()
+ *   name!: string;
+ * }
+ *
+ * @example
+ * // ❌ Bad - file: user.dto.ts
+ * class User { // Error: Expected UserDto
+ *   @IsString()
+ *   name!: string;
+ * }
+ *
+ * @example
+ * // ✅ Good - file: update-profile.query.dto.ts
+ * class UpdateProfileQueryDto {
+ *   @IsString()
+ *   filter?: string;
+ * }
+ */
+declare const _default: ESLintUtils.RuleModule<"incorrectDtoClassName", [], unknown, ESLintUtils.RuleListener>;
+export default _default;

package/dist/rules/dto-filename-match.js

@@ -0,0 +1,157 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@typescript-eslint/utils");
+const path = __importStar(require("path"));
+/**
+ * Creates an ESLint rule with proper documentation URL
+ */
+const createRule = utils_1.ESLintUtils.RuleCreator((name) => `https://github.com/robertlinde/eslint-plugin-class-validator-type-match#${name}`);
+/**
+ * Capitalize first letter of a string
+ */
+function capitalize(str) {
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}
+/**
+ * ESLint rule to ensure DTO class names match their file naming convention.
+ *
+ * This rule enforces consistent naming between DTO files and their class names:
+ * - Files like `.body.dto.ts`, `.query.dto.ts`, `.param.dto.ts` should have classes named `BodyDto`, `QueryDto`, `ParamDto`
+ * - Files like `.dto.ts` should have classes named `Dto`
+ *
+ * The rule extracts the type identifier (body, query, param, etc.) from the filename
+ * and validates that the class name follows the pattern `<Type>Dto` where `<Type>` is capitalized.
+ *
+ * @example
+ * // ✅ Good - file: create-user.body.dto.ts
+ * class CreateUserBodyDto {
+ *   @IsString()
+ *   name!: string;
+ * }
+ *
+ * @example
+ * // ❌ Bad - file: create-user.body.dto.ts
+ * class CreateUserDto { // Error: Expected CreateUserBodyDto
+ *   @IsString()
+ *   name!: string;
+ * }
+ *
+ * @example
+ * // ✅ Good - file: user.dto.ts
+ * class UserDto {
+ *   @IsString()
+ *   name!: string;
+ * }
+ *
+ * @example
+ * // ❌ Bad - file: user.dto.ts
+ * class User { // Error: Expected UserDto
+ *   @IsString()
+ *   name!: string;
+ * }
+ *
+ * @example
+ * // ✅ Good - file: update-profile.query.dto.ts
+ * class UpdateProfileQueryDto {
+ *   @IsString()
+ *   filter?: string;
+ * }
+ */
+exports.default = createRule({
+    name: 'dto-filename-match',
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Ensure DTO class names match their file naming convention. Files structured like .<type>.dto.ts should have class names like <Type>Dto',
+        },
+        messages: {
+            incorrectDtoClassName: 'Class name "{{className}}" does not match the DTO file naming convention. Expected class name to end with "{{expectedSuffix}}" based on filename "{{filename}}".',
+        },
+        schema: [],
+        fixable: undefined,
+    },
+    defaultOptions: [],
+    create(context) {
+        // Get the filename of the current file being linted
+        const filename = context.filename || context.getFilename();
+        const basename = path.basename(filename);
+        // Pattern to match DTO files: .<type>.dto.ts or .dto.ts
+        const dtoPatternWithType = /\.([a-zA-Z]+)\.dto\.ts$/;
+        const dtoPatternSimple = /\.dto\.ts$/;
+        let expectedSuffix = null;
+        // Check if file matches .<type>.dto.ts pattern (e.g., .body.dto.ts, .query.dto.ts)
+        const typeMatch = basename.match(dtoPatternWithType);
+        if (typeMatch && typeMatch[1]) {
+            const type = typeMatch[1].toLowerCase();
+            // Only process if the type is not just "dto" itself
+            // (to distinguish .body.dto.ts from .dto.ts)
+            if (type !== 'dto') {
+                expectedSuffix = `${capitalize(type)}Dto`;
+            }
+        }
+        // Check if file matches .dto.ts pattern (e.g., user.dto.ts)
+        if (expectedSuffix === null && dtoPatternSimple.test(basename)) {
+            expectedSuffix = 'Dto';
+        }
+        // If this is not a DTO file, skip validation
+        if (expectedSuffix === null) {
+            return {};
+        }
+        return {
+            /**
+             * Check class declarations to ensure they end with the expected suffix
+             */
+            ClassDeclaration(node) {
+                // Skip anonymous classes
+                if (!node.id || !node.id.name)
+                    return;
+                const className = node.id.name;
+                // Check if the class name ends with the expected suffix
+                if (!className.endsWith(expectedSuffix)) {
+                    context.report({
+                        node: node.id,
+                        messageId: 'incorrectDtoClassName',
+                        data: {
+                            className,
+                            expectedSuffix: expectedSuffix,
+                            filename: basename,
+                        },
+                    });
+                }
+            },
+        };
+    },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-class-validator-type-match",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "ESLint plugin to ensure class-validator decorators match TypeScript type annotations",
   "keywords": [
     "eslint",

package/readme.md

@@ -31,6 +31,7 @@ module.exports = {
     'class-validator-type-match/validate-nested-match': 'error',
     'class-validator-type-match/type-decorator-match': 'error',
     'class-validator-type-match/definite-assignment-match': 'error',
+    'class-validator-type-match/dto-filename-match': 'error',
   },
 };
 ```
@@ -49,7 +50,7 @@ module.exports = {
 
 - **`recommended`** - All rules enabled (best for most projects)
 - **`strict`** - All rules enabled with strict settings
-- **`basic`** - Only core type matching rules (decorator-type-match, optional-decorator-match, definite-assignment-match)
+- **`basic`** - Only core type matching rules (decorator-type-match, optional-decorator-match, definite-assignment-match, dto-filename-match)
 
 ```javascript
 // Use basic preset for less strict validation
@@ -200,6 +201,66 @@ class User {
 }
 ```
 
+### `dto-filename-match`
+
+Ensures DTO class names match their file naming convention.
+
+**File Naming Rules:**
+
+- Files structured like `.<type>.dto.ts` (e.g., `.body.dto.ts`, `.query.dto.ts`, `.param.dto.ts`) should have class names ending with `<Type>Dto` (e.g., `BodyDto`, `QueryDto`, `ParamDto`)
+- Files structured like `.dto.ts` should have class names ending with `Dto`
+
+**Examples:**
+
+```typescript
+// File: create-user.body.dto.ts
+import {IsString, IsEmail} from 'class-validator';
+
+export class CreateUserBodyDto {
+  // ✅ Correct - ends with BodyDto
+  @IsString()
+  name!: string;
+
+  @IsEmail()
+  email!: string;
+}
+
+// File: create-user.body.dto.ts
+export class CreateUserDto {
+  // ❌ Error: Expected class name to end with "BodyDto"
+  @IsString()
+  name!: string;
+}
+
+// File: update-profile.query.dto.ts
+export class UpdateProfileQueryDto {
+  // ✅ Correct - ends with QueryDto
+  @IsString()
+  filter?: string;
+}
+
+// File: user.dto.ts
+export class UserDto {
+  // ✅ Correct - ends with Dto
+  @IsString()
+  id!: string;
+}
+
+// File: user.dto.ts
+export class User {
+  // ❌ Error: Expected class name to end with "Dto"
+  @IsString()
+  id!: string;
+}
+
+// File: get-user.param.dto.ts
+export class GetUserParamDto {
+  // ✅ Correct - ends with ParamDto
+  @IsString()
+  userId!: string;
+}
+```
+
 ## Supported Decorators
 
 ### Type Validators