SuperAPI AI 工具集

nestjs-best-practices

测试与质量

查看项目

更新于 10-16 07:38

技能介绍

用途

本技能执行一次「NestJS 微观代码质量审计」,聚焦于微观层面的代码质量,以及特定架构、测试和编码标准的遵循情况。其角色设定为「NestJS 微观代码质量审计员(NestJS Micro-Code Quality Auditor)」,核心职责包括:代码质量分析、标准验证、测试标准评估、架构合规评估、代码规范执行,以及基于证据的报告。

主要能力

该技能声称擅长以下方面:

  • 代码质量分析:分析单个函数、类和测试文件的实现质量。
  • 标准验证:对照来自 GitHub 仓库的实时标准进行验证,涉及的文件包括 nestjs-testing-unit.mdc、nestjs-testing-integration.mdc、nestjs-module-structure.mdc、nestjs-service-patterns.mdc、nestjs-repository-patterns.mdc、nestjs-dto-validation.mdc、nestjs-error-handling.mdc、nestjs-typescript.mdc。
  • 测试标准评估:评估测试质量、命名约定、断言和测试结构。
  • 架构合规:评估对分层架构(Layered Architecture)和关注点分离的遵循情况。
  • 代码规范执行:分析 TypeScript 模式、命名约定和 NestJS 特有的最佳实践。
  • 基于证据的报告:基于实际代码检查客观报告发现,不做假设。

使用方式

该技能以分步执行计划的形式组织,按顺序执行以下步骤:

Step 1:测试质量分析 目标:评估对 nestjs-testing-unit.mdc 和 nestjs-testing-integration.mdc 的符合度。规则:阅读并遵循 references/testing-quality.md 中的说明。关注点:测试命名约定、断言质量与覆盖率、Mock 设置与清理模式、Arrange-Act-Assert 结构、集成测试数据库处理。

Step 2:架构合规分析 目标:评估对 nestjs-module-structure.mdc、nestjs-service-patterns.mdc 和 nestjs-repository-patterns.mdc 的符合度。规则:阅读并遵循 references/architecture-compliance.md 中的说明。关注点:层边界执行、依赖注入模式、模块组织、仓库模式实现、服务组合。

Step 3:代码规范分析 目标:评估对 nestjs-typescript.mdc 的符合度。规则:阅读并遵循 references/code-standards.md 中的说明。关注点:TypeScript 严格模式合规、命名约定、函数设计模式、NestJS 装饰器使用。

Step 4:DTO 验证分析 目标:评估对 nestjs-dto-validation.mdc 的符合度。规则:阅读并遵循 references/dto-validation.md 中的说明。关注点:验证装饰器覆盖、Swagger 文档、转换模式、响应 DTO 安全。

Step 5:错误处理分析 目标:评估对 nestjs-error-handling.mdc 的符合度。规则:阅读并遵循 references/error-handling.md 中的说明。关注点:异常使用模式、错误枚举与消息映射、异常过滤器实现、错误日志实践。

Step 6:报告生成 目标:使用模板将所有发现汇总为最终的纯文本报告。规则:阅读并遵循 references/best-practices-format-enforcer.md 与 references/best-practices-generator.md 中的说明。输出:遵循 assets/report-template.txt 模板的最终报告。

规则执行顺序依次为:references/testing-quality.md、references/architecture-compliance.md、references/code-standards.md、references/dto-validation.md、references/error-handling.md、references/best-practices-format-enforcer.md、references/best-practices-generator.md。

行为要求

技能要求执行时保持专业且基于证据,所有发现必须有实际代码证据支持;客观报告,明确区分违规、建议与合规代码;明确记录检查了什么、应用了什么标准、发现了什么违规;使用 GitHub 上实时的 .mdc 标准进行验证;进行细粒度分析,聚焦单个函数、类和测试文件而非项目基础设施;不做假设,如果无法通过代码证据证明,则写「Unknown」并说明需要什么来证明。

关键规则

  • 始终对照实时标准验证:从 GitHub 仓库获取最新标准。
  • 聚焦代码质量:分析实现,而非基础设施。
  • 清晰报告违规:指明违反的是哪项标准,并提供代码示例。
  • 保持格式一致性:遵循纯文本报告的模板结构。
  • 绝不跳过标准验证:所有代码都必须对照适用标准检查。

标准来源

所有标准来自:https://github.com/somnio-software/cursor-rules/tree/main/.cursor/rules/nestjs/

标准文件及其用途:

  • nestjs-dto-validation.mdc:DTO 结构、class-validator、Swagger。
  • nestjs-service-patterns.mdc:服务层模式、事务。
  • nestjs-controller-patterns.mdc:控制器装饰器、守卫。
  • nestjs-repository-patterns.mdc:仓库模式、软删除。
  • nestjs-testing-unit.mdc:单元测试模式、Mock。
  • nestjs-testing-integration.mdc:集成测试、数据库设置。
  • nestjs-error-handling.mdc:异常过滤器、错误枚举。
  • nestjs-module-structure.mdc:模块组织、导入/导出。
  • nestjs-typescript.mdc:TypeScript 标准、命名约定。

适用场景

适用于需要对 NestJS 代码库进行深入、细粒度的代码质量审计,并对照最新 GitHub 标准验证测试、架构、代码规范、DTO 验证和错误处理的开发团队或代码审查流程。

限制

该技能是一套审计计划与智能体行为说明,资料未提供其具体安装命令、运行环境、依赖项、收费或价格信息,也未说明其执行所需的工具或平台细节,这些内容暂未提供。