🇰🇷 한국어 README 보기 | 🌐 Try Online Playground

eslint-plugin-nestjs-route

ESLint rules for NestJS route management - ensure proper route ordering and prevent duplicates.

Installation

npm install --save-dev eslint-plugin-nestjs-route

ESLint config example

ESLint v9+ (Flat Config):

// eslint.config.js
const nestjsRoute = require("eslint-plugin-nestjs-route");

module.exports = [
  {
    files: ["**/*.ts"],
    plugins: {
      "nestjs-route": nestjsRoute,
    },
    rules: {
      "nestjs-route/order": "error",
      "nestjs-route/no-duplicates": "error",
    },
  },
];

ESLint v8 and below (Legacy Config):

{
  "plugins": ["nestjs-route"],
  "rules": {
    "nestjs-route/order": "error",
    "nestjs-route/no-duplicates": "error"
  }
}

Rules

nestjs-route/order

Ensures static routes are placed before parameterized routes in NestJS controllers.

• Enforces that static routes (e.g., 'me') are placed before parameterized routes (e.g., ':id') in NestJS controllers.
• Prevents unexpected routing bugs caused by route order.
• Auto-fixable: Routes can be automatically reordered using --fix option.

nestjs-route/no-duplicates

Prevents duplicate route definitions within the same controller.

• Detects when the same HTTP method and path combination is defined multiple times.
• Helps avoid routing conflicts and unexpected behavior.

Supported Decorators

• @Get, @Post, @Put, @Delete, @Patch, @All, @Options, @Head

Auto-fix

The nestjs-route/order rule supports automatic fixing. Use ESLint with the --fix flag to automatically reorder routes:

npx eslint --fix your-file.ts

Rule Examples

Route Order

// Correct
@Get('me')
@Get(':id')

// Incorrect (will be auto-fixed)
@Get(':id')
@Get('me') // Error: static route should be placed before parameter route

No Duplicates

// Correct
@Get('users')
@Post('users') // Different HTTP method - OK

// Incorrect
@Get('users')
@Get('users') // Error: duplicate route

Options

• locale: Set the error message language (default: 'en')
  • "en": English
  • "ko": Korean

Example:

"rules": {
  "nestjs-route/order": ["error", { "locale": "ko" }],
  "nestjs-route/no-duplicates": ["error", { "locale": "ko" }]
}

Error Message Examples

Route Order

• English: Static route ('me') should be placed before parameter route (':id').
• Korean: 고정 라우트('me')는 파라미터 라우트(':id')보다 위에 위치해야 합니다.

No Duplicates

• English: Duplicate route Get('users') found. Each route should be unique within a controller.
• Korean: 중복된 라우트 Get('users')가 발견되었습니다. 컨트롤러 내에서 각 라우트는 고유해야 합니다.

Contributing

Pull requests and issues are welcome!

License

MIT