NestJS Project Rules

nestjsnodejsbackend

Enforces NestJS architectural conventions including module organization, dependency injection, guards, pipes, and interceptors for scalable server-side applications.

Целевые файлы

Файл	Формат
.cursorrules	plaintext
CLAUDE.md	markdown

Содержимое

## NestJS Project Rules ### Module Structure - Every feature must have its own module file (e.g., `users.module.ts`) - Modules must be self-contained: declare only what they own, import what they need - Use `forRoot()` / `forRootAsync()` for global configuration modules - Use `forFeature()` for feature-level registrations (e.g., TypeORM entities) - Never import modules circularly — refactor shared logic into a SharedModule ### Naming Conventions - Controllers: `[feature].controller.ts`, class `[Feature]Controller` - Services: `[feature].service.ts`, class `[Feature]Service` - Modules: `[feature].module.ts`, class `[Feature]Module` - DTOs: `create-[feature].dto.ts`, `update-[feature].dto.ts` - Entities: `[feature].entity.ts` - Guards: `[name].guard.ts`, class `[Name]Guard` - Interceptors: `[name].interceptor.ts` - Pipes: `[name].pipe.ts` ### Controllers - Controllers handle HTTP routing only — no business logic - Use `@ApiTags()` and `@ApiOperation()` for every endpoint (Swagger) - Validate all incoming data with class-validator DTOs via `@Body()`, `@Param()`, `@Query()` - Use `@HttpCode()` explicitly when status differs from default - Prefix all routes consistently with `@Controller('[resource]')` - Return plain objects or entities; let interceptors handle transformation ### Services - All business logic lives in services, never in controllers - Services must be stateless — store nothing in instance properties unless it's injected - Use constructor injection exclusively; avoid property injection - Throw `HttpException` subclasses (`NotFoundException`, `BadRequestException`) from services - Keep services focused — split large services into smaller domain services ### Dependency Injection - Use `@Injectable()` on every provider - Prefer interface-based tokens with `useClass` for testability - Use `@Inject(TOKEN)` for non-class tokens - Register global providers in `AppModule`, feature providers in their own module - Use `ConfigService` for all environment variable access — never `process.env` directly in services ### Guards & Authorization - Implement `CanActivate` interface for all guards - Use `@UseGuards()` at controller or method level; use `APP_GUARD` token for global guards - JWT authentication guard must validate token expiry, signature, and user existence - Use `@Public()` decorator with `SetMetadata` to bypass global auth guard on public routes - Role-based guards must use `@Roles()` decorator and `Reflector` to read metadata ### Pipes & Validation - Enable `ValidationPipe` globally with `whitelist: true` and `forbidNonWhitelisted: true` - Use `transform: true` to auto-transform payloads to DTO instances - Create custom pipes by implementing `PipeTransform` — never transform data in controllers - Use `ParseIntPipe`, `ParseUUIDPipe` for URL parameter validation ### Interceptors - Use interceptors for cross-cutting: logging, response transformation, caching - Response interceptor must wrap all responses in a consistent envelope `{ data, meta }` - Logging interceptor must record method, path, duration, and status code - Never throw errors from interceptors — delegate to exception filters ### Exception Filters - Implement a global `HttpExceptionFilter` to normalize error responses - Always return `{ statusCode, message, timestamp, path }` structure - Log server errors (5xx) with full stack; log client errors (4xx) with message only ### Anti-patterns to Avoid - Do not use `any` type — always type request/response shapes - Do not bypass the DI container with `new Service()` - Do not share mutable state between requests via service instance properties - Do not mix infrastructure concerns (DB queries) with business logic in the same class

CLI

npx mindaxis apply nestjs-rules --target cursor --scope project

Используется в паках

NestJS Backend

Production-ready NestJS API toolkit

Открыть пак →

← Правила