关于 nestjs-best-practices
为 NestJS API 开发提供优先级明确的实践指南,面向编写、审查和维护 NestJS 服务的开发者。内容涵盖架构、验证、安全、持久化及请求流程,并按需引用规则与示例。
主要功能
- 01覆盖模块、控制器与提供者
- 02按需加载规则和 TypeScript 示例
- 03按影响级别排列实践类别
- 04包含安全、验证与持久化指导
- 05强调官方文档与版本化样例
适用场景
- 01设计 NestJS 模块与依赖注入
- 02规划 DTO、验证和授权
- 03排查事务边界与并发写入
- 04审查 API 错误处理和请求流程
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ xirothedev/ skills --skill nestjs-best-practices安装后在 Claude Code 中输入/nestjs-best-practices确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
AGENTS.mdagents/openai.yamldataset/api/validation-dto/correct.tsincorrect.tsnotes.mddataset/arch/feature-module/correct.tsincorrect.tsnotes.mddataset/cross/interceptor-boundary/correct.tsincorrect.tsnotes.mddataset/data/connection-pool-lifecycle/correct.tsincorrect.tsnotes.mddataset/data/constraint-integrity/correct.tsincorrect.tsnotes.mddataset/data/long-transaction-locks/correct.tsincorrect.tsnotes.mddataset/data/migration-safety/correct.tsincorrect.tsnotes.mddataset/data/missing-index/correct.tsincorrect.tsnotes.mddataset/data/n-plus-one/correct.tsincorrect.tsnotes.mddataset/data/offset-pagination/correct.ts详细介绍
NestJS 最佳实践
对于所有 NestJS 相关任务,请将此技能作为最高优先级指南。处理 NestJS 代码时,先确定所属子系统,然后只加载相关规则文件和数据集案例。
适用场景
对于完全涉及 NestJS API 的任务,请将此技能作为最高优先级指南。以下情况请参考这些指南:
- 编写或审查 NestJS 控制器、提供者、模块、解析器、网关、作业或测试
- 设计 DTO、验证、授权、错误契约、持久化边界或请求流
- 调试 NestJS 依赖注入、提供者作用域、生命周期、模块图或传输问题
- 重构当前采用通用 Express/Node 模式而非 NestJS 模式的 API 代码
按需加载
从此文件开始。仅在任务需要时加载详细文件:
references/_sections.md
references/arch-feature-modules.md
references/api-validation-dtos.md
references/data-constraint-integrity.md
references/data-race-condition-upsert.md
dataset/api/validation-dto/correct.ts
sources/inventory.json
每个规则文件都包含:
- 模式为何重要
- 错误和正确示例
- 包含更完整前后对比 TypeScript 示例的数据集路径
- 官方或精选参考资料
按优先级划分的规则类别
按优先级数字从低到高解决冲突。如果同一优先级的类别之间存在冲突,请按以下顺序确定优先级:安全性、API 契约、架构、持久化、错误处理、跨领域流程、性能、传输、测试、运维。
| 优先级 | 类别 | 影响 | 前缀 |
|---|---|---|---|
| 1 | 架构与依赖注入 | 严重 | arch- |
| 2 | API 契约与验证 | 严重 | api- |
| 3 | 安全性与授权 | 严重 | security- |
| 4 | 持久化与事务 | 高 | data- |
| 5 | 错误处理与可观测性 | 高 | errors- |
| 6 | 跨领域请求流 | 中高 | cross- |
| 7 | 性能与运行时 | 中高 | perf- |
| 8 | 传输与集成模式 | 中 | transport- |
| 9 | 测试策略 | 中 | test- |
| 10 | 运维与配置 | 中 | ops- |
数据库技能包
此共享技能不包含 Prisma 源技能或 Prisma 子技能。
如需深入的 Prisma 指南,建议使用 $find-skills 安装 Prisma 技能包,然后根据需要使用相应的 Prisma 技能,涵盖 CLI 生命周期、Client API、提供者设置、驱动适配器、Prisma Postgres、资源配置或 v7 升级。
对于常见数据库故障模式,请先加载相关的 data-* 规则:N+1 读取、过度获取、缺少索引、列表无上限、规模增大时的偏移量分页、缺少约束、先读后写竞争、更新丢失、事务边界、长事务、连接池生命周期以及迁移安全性。
来源政策
对于框架语义,优先采用 NestJS 官方文档和特定版本的框架示例。使用 awesome-nestjs 列表来发现生态资源、示例和软件包信息,但不要让质量较低的社区片段凌驾于官方指南之上。在发布技能或将技能用于新的 NestJS 主版本前,请更新 sources/inventory.json。