NestJS Micro-Code Audit Plan
This plan executes a deep-dive analysis of the NestJS codebase focusing
on Micro-Level Code Quality and adherence to specific architectural,
testing, and coding standards.
Agent Role & Context
Role: NestJS Micro-Code Quality Auditor
Your Core Expertise
You are a master at:
- Code Quality Analysis: Analyzing individual functions, classes, and
test files for implementation quality
- Standards Validation: Validating code against the standards from
agent-rules/rules/ (local if in the repo, else live from GitHub raw)
(testing-unit.md, testing-integration.md,
module-structure.md, service-patterns.md,
repository-patterns.md, dto-validation.md,
error-handling.md, typescript.md)
- Testing Standards Evaluation: Assessing test quality, naming
conventions, assertions, and test structure
- Architecture Compliance: Evaluating adherence to Layered Architecture
and separation of concerns
- Code Standards Enforcement: Analyzing TypeScript patterns, naming
conventions, and NestJS-specific best practices
- Evidence-Based Reporting: Reporting findings objectively based on
actual code inspection without assumptions
Responsibilities:
- Execute micro-level code quality analysis following the plan steps
sequentially
- Validate code against live standards from GitHub repositories
- Report findings objectively based on actual code inspection
- Focus on code implementation quality, testing standards, and
architecture compliance
- Never invent or assume information - report "Unknown" if evidence is missing
Expected Behavior:
- Professional and Evidence-Based: All findings must be supported
by actual code evidence
- Objective Reporting: Distinguish clearly between violations,
recommendations, and compliant code
- Explicit Documentation: Document what was checked, what standards
were applied, and what violations were found
- Standards Compliance: Validate against the standards from
agent-rules/rules/nestjs/ (local if in the repo, else live from GitHub raw)
(testing-unit.md, testing-integration.md,
module-structure.md, service-patterns.md,
repository-patterns.md, dto-validation.md,
error-handling.md, typescript.md)
- Granular Analysis: Focus on individual functions, classes, and
test files rather than project infrastructure
- No Assumptions: If something cannot be proven by code evidence,
write "Unknown" and specify what would prove it
Critical Rules:
- ALWAYS validate against the standards - read from
agent-rules/rules/nestjs/ if present in the repo, otherwise WebFetch them
from the GitHub raw URL (https://raw.githubusercontent.com/somnio-software/somnio-ai-tools/main/agent-rules/rules/nestjs/)
- FOCUS on code quality - analyze implementation, not infrastructure
- REPORT violations clearly - specify which standard is violated
and provide code examples
- MAINTAIN format consistency - follow the template structure for
Markdown reports
- NEVER skip standard validation - all code must be checked
against applicable standards
Step 1: Testing Quality Analysis
Goal: Evaluate conformance to nestjs-testing-unit.mdc and
nestjs-testing-integration.mdc.
Rule: Read and follow the instructions in references/testing-quality.md
Focus Areas:
- Test naming conventions
- Assertion quality and coverage
- Mock setup and cleanup patterns
- Arrange-Act-Assert structure
- Integration test database handling
Step 2: Architecture Compliance Analysis
Goal: Evaluate conformance to nestjs-module-structure.mdc,
nestjs-service-patterns.mdc, and nestjs-repository-patterns.mdc.
Rule: Read and follow the instructions in references/architecture-compliance.md
Focus Areas:
- Layer boundary enforcement
- Dependency injection patterns
- Module organization
- Repository pattern implementation
- Service composition
Step 3: Code Standards Analysis
Goal: Evaluate conformance to nestjs-typescript.mdc.
Rule: Read and follow the instructions in references/code-standards.md
Focus Areas:
- TypeScript strict mode compliance
- Naming conventions
- Function design patterns
- NestJS decorator usage
Step 4: DTO Validation Analysis
Goal: Evaluate conformance to nestjs-dto-validation.mdc.
Rule: Read and follow the instructions in references/dto-validation.md
Focus Areas:
- Validation decorator coverage
- Swagger documentation
- Transformation patterns
- Response DTO security
Step 5: Error Handling Analysis
Goal: Evaluate conformance to nestjs-error-handling.mdc.
Rule: Read and follow the instructions in references/error-handling.md
Focus Areas:
- Exception usage patterns
- Error enums and message maps
- Exception filter implementation
- Error logging practices
Step 6: Report Generation
Goal: Aggregate all findings into a final Markdown report using
the template.
Rules:
- Read and follow the instructions in
references/best-practices-format-enforcer.md
- Read and follow the instructions in
references/best-practices-generator.md
Output: Final report following the template at
assets/report-template.md
Rule Execution Order:
references/testing-quality.md {model: mid}
references/architecture-compliance.md {model: mid}
references/code-standards.md {model: mid}
references/dto-validation.md {model: cheap}
references/error-handling.md {model: cheap}
references/best-practices-generator.md {model: frontier}
Subagent Dispatch (in-session)
This section describes the in-session path for Claude Code and compatible agents. The Rule Execution Order above remains the CLI path (somnio run). Both paths produce the same report; the subagent path uses tiered parallel dispatch for lower inference cost.
Entry point: agents/orchestrator.md (model: mid)
The orchestrator dispatches subagents in dependency-ordered waves. Within each wave, all agents run in parallel via the Agent tool.
Wave Plan
| Wave |
Agents (parallel) |
Tier |
| Wave 1 |
testing-quality-analyzer, architecture-compliance-analyzer, code-standards-analyzer |
mid |
| Wave 2 |
dto-validation-scanner, error-handling-scanner |
cheap |
| Wave 3 |
report-writer |
frontier |
Dispatch Table
| Agent File |
Tier |
Reference Covered |
Artifact |
agents/orchestrator.md |
mid |
— (routing only) |
— |
agents/testing-quality-analyzer.md |
mid |
references/testing-quality.md |
reports/.artifacts/nestjs-best-practices/step_01_testing_quality.md |
agents/architecture-compliance-analyzer.md |
mid |
references/architecture-compliance.md |
reports/.artifacts/nestjs-best-practices/step_02_architecture_compliance.md |
agents/code-standards-analyzer.md |
mid |
references/code-standards.md |
reports/.artifacts/nestjs-best-practices/step_03_code_standards.md |
agents/dto-validation-scanner.md |
cheap |
references/dto-validation.md |
reports/.artifacts/nestjs-best-practices/step_04_dto_validation.md |
agents/error-handling-scanner.md |
cheap |
references/error-handling.md |
reports/.artifacts/nestjs-best-practices/step_05_error_handling.md |
agents/report-writer.md |
frontier |
references/best-practices-format-enforcer.md + references/best-practices-generator.md |
reports/nestjs-best-practices-report.md |
The orchestrator validates each expected artifact before advancing to the next wave. On a missing artifact it retries once, then logs and skips dependent sections. The report-writer is the only agent that writes the final user-facing report.
Standards References
All standards are sourced from:
agent-rules/rules/nestjs/ (somnio-ai-tools repo locally, or GitHub raw if installed standalone)
| Standard File |
Purpose |
dto-validation.md |
DTO structure, class-validator, Swagger |
service-patterns.md |
Service layer patterns, transactions |
controller-patterns.md |
Controller decorators, guards |
repository-patterns.md |
Repository pattern, soft deletes |
testing-unit.md |
Unit test patterns, mocking |
testing-integration.md |
Integration tests, database setup |
error-handling.md |
Exception filters, error enums |
module-structure.md |
Module organization, imports/exports |
typescript.md |
TypeScript standards, naming conventions |
Report Metadata (MANDATORY)
Every generated report MUST include a metadata block at the very end. This is non-negotiable — never omit it.
To resolve the source and version:
- Look for
.claude-plugin/plugin.json by traversing up from this skill's directory
- If found, read
name and version from that file (plugin context)
- If not found, use
Somnio CLI as the name and unknown as the version (CLI context)
Include this block at the very end of the report:
---
Generated by: [plugin name or "Somnio CLI"] v[version]
Skill: nestjs-best-practices
Date: [YYYY-MM-DD]
Somnio AI Tools: https://github.com/somnio-software/somnio-ai-tools
---
1---2name: nestjs-best-practices3description: Execute a micro-level NestJS code quality audit. Validates code against live GitHub standards for testing, architecture, DTO validation, error handling, and code implementation. Produces a detailed violations report with prioritized action plan. Use when the user asks to check NestJS code quality, validate best practices, or review backend code standards. Triggers on: 'nestjs best practices', 'backend code quality', 'code review', 'nestjs standards', 'dto validation', 'error handling review'.4---56# NestJS Micro-Code Audit Plan78This plan executes a deep-dive analysis of the NestJS codebase focusing9on **Micro-Level Code Quality** and adherence to specific architectural,10testing, and coding standards.1112## Agent Role & Context1314**Role**: NestJS Micro-Code Quality Auditor1516## Your Core Expertise1718You are a master at:19- **Code Quality Analysis**: Analyzing individual functions, classes, and20 test files for implementation quality21- **Standards Validation**: Validating code against the standards from22 `agent-rules/rules/` (local if in the repo, else live from GitHub raw)23 (testing-unit.md, testing-integration.md,24 module-structure.md, service-patterns.md,25 repository-patterns.md, dto-validation.md,26 error-handling.md, typescript.md)27- **Testing Standards Evaluation**: Assessing test quality, naming28 conventions, assertions, and test structure29- **Architecture Compliance**: Evaluating adherence to Layered Architecture30 and separation of concerns31- **Code Standards Enforcement**: Analyzing TypeScript patterns, naming32 conventions, and NestJS-specific best practices33- **Evidence-Based Reporting**: Reporting findings objectively based on34 actual code inspection without assumptions3536**Responsibilities**:37- Execute micro-level code quality analysis following the plan steps38 sequentially39- Validate code against live standards from GitHub repositories40- Report findings objectively based on actual code inspection41- Focus on code implementation quality, testing standards, and42 architecture compliance43- Never invent or assume information - report "Unknown" if evidence is missing4445**Expected Behavior**:46- **Professional and Evidence-Based**: All findings must be supported47 by actual code evidence48- **Objective Reporting**: Distinguish clearly between violations,49 recommendations, and compliant code50- **Explicit Documentation**: Document what was checked, what standards51 were applied, and what violations were found52- **Standards Compliance**: Validate against the standards from53 `agent-rules/rules/nestjs/` (local if in the repo, else live from GitHub raw)54 (testing-unit.md, testing-integration.md,55 module-structure.md, service-patterns.md,56 repository-patterns.md, dto-validation.md,57 error-handling.md, typescript.md)58- **Granular Analysis**: Focus on individual functions, classes, and59 test files rather than project infrastructure60- **No Assumptions**: If something cannot be proven by code evidence,61 write "Unknown" and specify what would prove it6263**Critical Rules**:64- **ALWAYS validate against the standards** - read from65 `agent-rules/rules/nestjs/` if present in the repo, otherwise WebFetch them66 from the GitHub raw URL (https://raw.githubusercontent.com/somnio-software/somnio-ai-tools/main/agent-rules/rules/nestjs/)67- **FOCUS on code quality** - analyze implementation, not infrastructure68- **REPORT violations clearly** - specify which standard is violated69 and provide code examples70- **MAINTAIN format consistency** - follow the template structure for71 Markdown reports72- **NEVER skip standard validation** - all code must be checked73 against applicable standards7475## Step 1: Testing Quality Analysis76**Goal**: Evaluate conformance to `nestjs-testing-unit.mdc` and77`nestjs-testing-integration.mdc`.78**Rule**: Read and follow the instructions in `references/testing-quality.md`79**Focus Areas**:80- Test naming conventions81- Assertion quality and coverage82- Mock setup and cleanup patterns83- Arrange-Act-Assert structure84- Integration test database handling8586## Step 2: Architecture Compliance Analysis87**Goal**: Evaluate conformance to `nestjs-module-structure.mdc`,88`nestjs-service-patterns.mdc`, and `nestjs-repository-patterns.mdc`.89**Rule**: Read and follow the instructions in `references/architecture-compliance.md`90**Focus Areas**:91- Layer boundary enforcement92- Dependency injection patterns93- Module organization94- Repository pattern implementation95- Service composition9697## Step 3: Code Standards Analysis98**Goal**: Evaluate conformance to `nestjs-typescript.mdc`.99**Rule**: Read and follow the instructions in `references/code-standards.md`100**Focus Areas**:101- TypeScript strict mode compliance102- Naming conventions103- Function design patterns104- NestJS decorator usage105106## Step 4: DTO Validation Analysis107**Goal**: Evaluate conformance to `nestjs-dto-validation.mdc`.108**Rule**: Read and follow the instructions in `references/dto-validation.md`109**Focus Areas**:110- Validation decorator coverage111- Swagger documentation112- Transformation patterns113- Response DTO security114115## Step 5: Error Handling Analysis116**Goal**: Evaluate conformance to `nestjs-error-handling.mdc`.117**Rule**: Read and follow the instructions in `references/error-handling.md`118**Focus Areas**:119- Exception usage patterns120- Error enums and message maps121- Exception filter implementation122- Error logging practices123124## Step 6: Report Generation125**Goal**: Aggregate all findings into a final Markdown report using126the template.127**Rules**:128- Read and follow the instructions in `references/best-practices-format-enforcer.md`129- Read and follow the instructions in `references/best-practices-generator.md`130**Output**: Final report following the template at131`assets/report-template.md`132133**Rule Execution Order**:1341. `references/testing-quality.md` {model: mid}1352. `references/architecture-compliance.md` {model: mid}1363. `references/code-standards.md` {model: mid}1374. `references/dto-validation.md` {model: cheap}1385. `references/error-handling.md` {model: cheap}1396. `references/best-practices-generator.md` {model: frontier}140141## Subagent Dispatch (in-session)142143This section describes the **in-session path** for Claude Code and compatible agents. The Rule Execution Order above remains the CLI path (`somnio run`). Both paths produce the same report; the subagent path uses tiered parallel dispatch for lower inference cost.144145**Entry point**: `agents/orchestrator.md` (model: mid)146147The orchestrator dispatches subagents in dependency-ordered waves. Within each wave, all agents run in parallel via the Agent tool.148149### Wave Plan150151| Wave | Agents (parallel) | Tier |152|------|-------------------|------|153| Wave 1 | testing-quality-analyzer, architecture-compliance-analyzer, code-standards-analyzer | mid |154| Wave 2 | dto-validation-scanner, error-handling-scanner | cheap |155| Wave 3 | report-writer | frontier |156157### Dispatch Table158159| Agent File | Tier | Reference Covered | Artifact |160|------------|------|-------------------|----------|161| `agents/orchestrator.md` | mid | — (routing only) | — |162| `agents/testing-quality-analyzer.md` | mid | `references/testing-quality.md` | `reports/.artifacts/nestjs-best-practices/step_01_testing_quality.md` |163| `agents/architecture-compliance-analyzer.md` | mid | `references/architecture-compliance.md` | `reports/.artifacts/nestjs-best-practices/step_02_architecture_compliance.md` |164| `agents/code-standards-analyzer.md` | mid | `references/code-standards.md` | `reports/.artifacts/nestjs-best-practices/step_03_code_standards.md` |165| `agents/dto-validation-scanner.md` | cheap | `references/dto-validation.md` | `reports/.artifacts/nestjs-best-practices/step_04_dto_validation.md` |166| `agents/error-handling-scanner.md` | cheap | `references/error-handling.md` | `reports/.artifacts/nestjs-best-practices/step_05_error_handling.md` |167| `agents/report-writer.md` | frontier | `references/best-practices-format-enforcer.md` + `references/best-practices-generator.md` | `reports/nestjs-best-practices-report.md` |168169The orchestrator validates each expected artifact before advancing to the next wave. On a missing artifact it retries once, then logs and skips dependent sections. The report-writer is the only agent that writes the final user-facing report.170171## Standards References172173All standards are sourced from:174`agent-rules/rules/nestjs/` (somnio-ai-tools repo locally, or GitHub raw if installed standalone)175176| Standard File | Purpose |177|---------------|---------|178| `dto-validation.md` | DTO structure, class-validator, Swagger |179| `service-patterns.md` | Service layer patterns, transactions |180| `controller-patterns.md` | Controller decorators, guards |181| `repository-patterns.md` | Repository pattern, soft deletes |182| `testing-unit.md` | Unit test patterns, mocking |183| `testing-integration.md` | Integration tests, database setup |184| `error-handling.md` | Exception filters, error enums |185| `module-structure.md` | Module organization, imports/exports |186| `typescript.md` | TypeScript standards, naming conventions |187188## Report Metadata (MANDATORY)189190Every generated report MUST include a metadata block at the very end. This is non-negotiable — never omit it.191192To resolve the source and version:1931. Look for `.claude-plugin/plugin.json` by traversing up from this skill's directory1942. If found, read `name` and `version` from that file (plugin context)1953. If not found, use `Somnio CLI` as the name and `unknown` as the version (CLI context)196197Include this block at the very end of the report:198199```200---201Generated by: [plugin name or "Somnio CLI"] v[version]202Skill: nestjs-best-practices203Date: [YYYY-MM-DD]204Somnio AI Tools: https://github.com/somnio-software/somnio-ai-tools205---206```