SuperAPI AI 工具集

nestjs-best-practices

编程与开发

查看项目

更新于 10-15 20:11

技能介绍

用途:为 NestJS 应用提供最佳实践与架构模式指南,包含 40 条规则、10 个类别,按影响程度排序,用于指导自动重构与代码生成。

适用时机:编写新的 NestJS 模块、控制器或服务;实现认证与授权;审查架构与安全问题;重构现有 NestJS 代码库;优化性能或数据库查询;构建微服务架构。

规则类别与优先级:架构(CRITICAL,前缀 arch-)、依赖注入(CRITICAL,di-)、错误处理(HIGH,error-)、安全(HIGH,security-)、性能(HIGH,perf-)、测试(MEDIUM-HIGH,test-)、数据库与 ORM(MEDIUM-HIGH,db-)、API 设计(MEDIUM,api-)、微服务(MEDIUM,micro-)、DevOps 与部署(LOW-MEDIUM,devops-)。

规则示例:架构类含避免循环依赖、按功能而非技术层组织、模块导出导入与避免重复 provider、单一职责、仓储模式、事件驱动解耦;依赖注入类含避免服务定位器、接口隔离、里氏替换、优先构造器注入、作用域认知、接口注入令牌;错误处理含异常过滤器、HTTP 异常、异步错误处理;安全含 JWT 认证、class-validator 输入校验、守卫、输出净化防 XSS、限流;性能含异步生命周期钩子、缓存、数据库查询优化、模块懒加载;测试含 TestingModule、Supertest E2E、模拟外部依赖;数据库含事务、避免 N+1、迁移;API 设计含 DTO 与响应序列化、拦截器、版本控制、管道;微服务含消息与事件模式、健康检查、队列;DevOps 含 ConfigModule、结构化日志、优雅关闭。

使用方式:阅读 rules/ 目录下的单条规则文件(如 rules/arch-avoid-circular-deps.md、rules/security-validate-all-input.md、rules/_sections.md),每条含原因说明、错误代码示例、正确代码示例及补充参考;完整展开版见 AGENTS.md。

限制:资料未提供安装命令、收费方式、支持平台或具体版本要求。