nestjs-best-practices
NestJS best practices and architecture patterns for building production-ready applications. This skill should be used when writing, reviewing, or refactoring NestJS code to ensure proper patterns for modules, dependency injection, security, and performance.
- License 许可
- MIT
- 最近更新
- 2026-10-17
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- nestjs-best-practices
- license
- MIT
- metadata
- { "author": "Kadajett", "version": "1.2.0" }
- description
- NestJS best practices and architecture patterns for building production-ready applications. This skill should be used when writing, reviewing, or refactoring NestJS code to ensure proper patterns for modules, dependency injection, security, and performance.
02 资源文件 42
- 参考文档rules/_sections.md2.1 KB
- 参考文档rules/_template.md631 B
- 参考文档rules/api-use-dto-serialization.md4.3 KB
- 参考文档rules/api-use-interceptors.md5.4 KB
- 参考文档rules/api-use-pipes.md5.3 KB
- 参考文档rules/api-versioning.md4.9 KB
- 参考文档rules/arch-avoid-circular-deps.md2.0 KB
- 参考文档rules/arch-feature-modules.md2.3 KB
- 参考文档rules/arch-module-sharing.md3.8 KB
- 参考文档rules/arch-single-responsibility.md2.9 KB
- 参考文档rules/arch-use-events.md3.0 KB
- 参考文档rules/arch-use-repository-pattern.md2.8 KB
- 参考文档rules/db-avoid-n-plus-one.md3.8 KB
- 参考文档rules/db-use-migrations.md3.7 KB
- 参考文档rules/db-use-transactions.md3.9 KB
- 参考文档rules/devops-graceful-shutdown.md5.8 KB
- 参考文档rules/devops-use-config-module.md4.3 KB
- 参考文档rules/devops-use-logging.md5.6 KB
- 参考文档rules/di-avoid-service-locator.md2.9 KB
- 参考文档rules/di-interface-segregation.md5.1 KB
- 参考文档rules/di-liskov-substitution.md7.1 KB
- 参考文档rules/di-prefer-constructor-injection.md2.3 KB
- 参考文档rules/di-scope-awareness.md2.6 KB
- 参考文档rules/di-use-interfaces-tokens.md2.5 KB
- 参考文档rules/error-handle-async-errors.md3.4 KB
- 参考文档rules/error-throw-http-exceptions.md3.1 KB
- 参考文档rules/error-use-exception-filters.md3.6 KB
- 参考文档rules/micro-use-health-checks.md5.8 KB
- 参考文档rules/micro-use-patterns.md5.0 KB
- 参考文档rules/micro-use-queues.md6.1 KB
- 参考文档rules/perf-async-hooks.md2.8 KB
- 参考文档rules/perf-lazy-loading.md3.7 KB
- 参考文档rules/perf-optimize-database.md3.2 KB
- 参考文档rules/perf-use-caching.md3.4 KB
- 参考文档rules/security-auth-jwt.md4.0 KB
- 参考文档rules/security-rate-limiting.md3.2 KB
- 参考文档rules/security-sanitize-output.md3.7 KB
- 参考文档rules/security-use-guards.md3.6 KB
- 参考文档rules/security-validate-all-input.md3.3 KB
- 参考文档rules/test-e2e-supertest.md4.7 KB
- 参考文档rules/test-mock-external-services.md4.5 KB
- 参考文档rules/test-use-testing-module.md4.3 KB
03 SKILL.md 正文
NestJS Best Practices
Comprehensive best practices guide for NestJS applications. Contains 40 rules across 10 categories, prioritized by impact to guide automated refactoring and code generation.
When to Apply
Reference these guidelines when:
- Writing new NestJS modules, controllers, or services
- Implementing authentication and authorization
- Reviewing code for architecture and security issues
- Refactoring existing NestJS codebases
- Optimizing performance or database queries
- Building microservices architectures
Rule Categories by Priority
| Priority | Category | Impact | Prefix |
|---|---|---|---|
| 1 | Architecture | CRITICAL | arch- |
| 2 | Dependency Injection | CRITICAL | di- |
| 3 | Error Handling | HIGH | error- |
| 4 | Security | HIGH | security- |
| 5 | Performance | HIGH | perf- |
| 6 | Testing | MEDIUM-HIGH | test- |
| 7 | Database & ORM | MEDIUM-HIGH | db- |
| 8 | API Design | MEDIUM | api- |
| 9 | Microservices | MEDIUM | micro- |
| 10 | DevOps & Deployment | LOW-MEDIUM | devops- |
Quick Reference
1. Architecture (CRITICAL)
arch-avoid-circular-deps- Avoid circular module dependenciesarch-feature-modules- Organize by feature, not technical layerarch-module-sharing- Proper module exports/imports, avoid duplicate providersarch-single-responsibility- Focused services over "god services"arch-use-repository-pattern- Abstract database logic for testabilityarch-use-events- Event-driven architecture for decoupling
2. Dependency Injection (CRITICAL)
di-avoid-service-locator- Avoid service locator anti-patterndi-interface-segregation- Interface Segregation Principle (ISP)di-liskov-substitution- Liskov Substitution Principle (LSP)di-prefer-constructor-injection- Constructor over property injectiondi-scope-awareness- Understand singleton/request/transient scopesdi-use-interfaces-tokens- Use injection tokens for interfaces
3. Error Handling (HIGH)
error-use-exception-filters- Centralized exception handlingerror-throw-http-exceptions- Use NestJS HTTP exceptionserror-handle-async-errors- Handle async errors properly
4. Security (HIGH)
security-auth-jwt- Secure JWT authenticationsecurity-validate-all-input- Validate with class-validatorsecurity-use-guards- Authentication and authorization guardssecurity-sanitize-output- Prevent XSS attackssecurity-rate-limiting- Implement rate limiting
5. Performance (HIGH)
perf-async-hooks- Proper async lifecycle hooksperf-use-caching- Implement caching strategiesperf-optimize-database- Optimize database queriesperf-lazy-loading- Lazy load modules for faster startup
6. Testing (MEDIUM-HIGH)
test-use-testing-module- Use NestJS testing utilitiestest-e2e-supertest- E2E testing with Supertesttest-mock-external-services- Mock external dependencies
7. Database & ORM (MEDIUM-HIGH)
db-use-transactions- Transaction managementdb-avoid-n-plus-one- Avoid N+1 query problemsdb-use-migrations- Use migrations for schema changes
8. API Design (MEDIUM)
api-use-dto-serialization- DTO and response serializationapi-use-interceptors- Cross-cutting concernsapi-versioning- API versioning strategiesapi-use-pipes- Input transformation with pipes
9. Microservices (MEDIUM)
micro-use-patterns- Message and event patternsmicro-use-health-checks- Health checks for orchestrationmicro-use-queues- Background job processing
10. DevOps & Deployment (LOW-MEDIUM)
devops-use-config-module- Environment configurationdevops-use-logging- Structured loggingdevops-graceful-shutdown- Zero-downtime deployments
How to Use
Read individual rule files for detailed explanations and code examples:
rules/arch-avoid-circular-deps.md
rules/security-validate-all-input.md
rules/_sections.md
Each rule file contains:
- Brief explanation of why it matters
- Incorrect code example with explanation
- Correct code example with explanation
- Additional context and references
Full Compiled Document
For the complete guide with all rules expanded in a single document, see AGENTS.md in the repository.
04 同仓库更多 Skills
webapp-testing
Toolkit for interacting with and testing local web applications using Playwright. Supports verifying frontend functionality, debugging UI behavior, capturing browser screenshots, and viewing browser logs.
vercel-react-best-practices
React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.
vercel-composition-patterns
React composition patterns that scale. Use when refactoring components with boolean prop proliferation, building flexible component libraries, or designing reusable APIs. Triggers on tasks involving compound components, render props, context providers, or component architecture. Includes React 19 API changes.
skill-creator
Create new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy.
security-review
Security code review for vulnerabilities. Use when asked to "security review", "find vulnerabilities", "check for security issues", "audit security", "OWASP review", or review code for injection, XSS, authentication, authorization, cryptography issues. Provides systematic review with confidence-based reporting.
resend
Use when working with the Resend email API — sending transactional emails (single or batch), receiving inbound emails via webhooks, managing email templates, tracking delivery events, managing domains, contacts, broadcasts, webhooks, API keys, automations, events, viewing API request logs, checking account usage and quotas, or setting up the Resend SDK. Always use this skill when the user mentions Resend, even for simple tasks like "send an email with Resend" — the skill contains critical gotchas (idempotency keys, webhook verification, template variable syntax) that prevent common production issues.