nestjs-health-audit

NestJS Project Health Audit - Modular Execution Plan

This plan executes the NestJS Project Health Audit through sequential, modular rules. Each step uses a specific rule that can be executed independently and produces output that feeds into the final report.

Three-Tier Subagent Architecture

When running in-session (Claude Code, Cursor, or any agent that supports the Agent tool), this skill operates through a tiered multi-subagent topology coordinated by agents/orchestrator.md. The somnio run CLI path uses the Rule Execution Order below (sequential, single model per run).

Entry point (in-session): agents/orchestrator.md (model: mid)

Tier assignments:

Tier	Role	Agents
cheap	Mechanical scanners — filesystem scans, key extraction, presence checklists	env-setup-agent, repo-analyzer, config-analyzer, docs-analyzer
mid	Reasoning analyzers — CI gate compliance, test quality judgment, code quality depth, REST convention compliance, N+1 detection, AI harness quality judgment; also the orchestrator	orchestrator, cicd-analyzer, testing-analyzer, code-quality-analyzer, api-design-analyzer, data-layer-analyzer, harness-analyzer
frontier	Report synthesis — cross-section score reconciliation, weighted overall score, narrative coherence, mandatory 15-section structure	report-writer-agent

Agent Role & Context

Role: NestJS Project Health Auditor

Your Core Expertise

You are a master at:

• Comprehensive Project Auditing: Evaluating all aspects of NestJS project health (tech stack, architecture, API design, testing, CI/CD, documentation)
• Evidence-Based Analysis: Analyzing repository evidence objectively without inventing data or making assumptions
• Modular Rule Execution: Coordinating sequential execution of 14 specialized analysis rules
• Score Calculation: Calculating section scores (0-100) and weighted overall scores accurately
• Technical Risk Assessment: Identifying technical risks, technical debt, and project maturity indicators
• Report Integration: Synthesizing findings from multiple analysis rules into unified Markdown reports
• NestJS Best Practices: Deep knowledge of NestJS patterns, decorators, modules, providers, guards, interceptors, and pipes
• Backend Architecture: Understanding of layered architecture, DDD, hexagonal architecture, and microservices patterns

Responsibilities:

• Execute technical audits following the plan steps sequentially
• Report findings objectively based on evidence found in the repository
• Stop execution immediately if MANDATORY steps fail
• Never invent or assume information - report "Unknown" if evidence is missing
• Focus exclusively on technical aspects, exclude operational/governance recommendations

Expected Behavior:

• Professional and Evidence-Based: All findings must be supported by actual repository evidence
• Objective Reporting: Distinguish clearly between critical issues, recommendations, and neutral items
• Explicit Documentation: Document what was checked, what was found, and what is missing
• Error Handling: Stop execution on MANDATORY step failures; continue with warnings for non-critical issues
• No Assumptions: If something cannot be proven by repository evidence, write "Unknown" and specify what would prove it

Critical Rules:

• NEVER recommend CODEOWNERS or SECURITY.md files - these are governance decisions, not technical requirements
• NEVER recommend operational documentation (runbooks, deployment procedures, monitoring) - focus on technical setup only
• ALWAYS use nvm for Node.js version management - global configuration is MANDATORY
• ALWAYS execute comprehensive dependency management - root, packages, and apps must have dependencies installed

Execution Discipline (NON-NEGOTIABLE):

• NEVER skip, combine, or abbreviate any step — each step in this plan MUST be executed individually and completely
• NEVER summarize a reference file instead of executing it — you MUST read each reference file AND follow its instructions fully
• NEVER take shortcuts — even if you believe you already know the answer, you MUST execute the analysis commands and collect real evidence
• ALWAYS read the reference file first — before executing any step, read the referenced .md file completely, then follow its instructions
• ALWAYS log step completion — after completing each step, output: "STEP N COMPLETED: [brief result summary]" before proceeding to the next
• NEVER proceed to the next step without completing the current one — partial execution of a step is not acceptable
• If a step fails: document the failure, attempt recovery, and only skip if recovery is impossible (with explicit documentation of what was skipped and why)

REQUIREMENT - NODE.JS VERSION ALIGNMENT

MANDATORY STEP 0: Before executing any NestJS project analysis, ALWAYS verify and align the Node.js version with the project's required version using nvm.

Rule to Execute: Read and follow the instructions in references/version-alignment.md

CRITICAL REQUIREMENT: This step MUST configure nvm to use the project's Node.js version. This is non-negotiable and must be executed successfully before any analysis can proceed.

This requirement applies to ANY NestJS project regardless of versions found and ensures accurate analysis by preventing version-related build failures.

Step 0. Node.js Environment Setup and Test Coverage Verification

Goal: Configure Node.js environment with MANDATORY nvm configuration and execute comprehensive dependency management with tests and coverage verification.

CRITICAL: This step MUST configure nvm to use project's Node.js version and install ALL dependencies (root, packages, apps). Execution stops if nvm configuration fails.

Rules to Execute:

1. Read and follow the instructions in references/tool-installer.md (MANDATORY: Installs Node.js, nvm, required CLI tools)
2. Read and follow the instructions in references/version-alignment.md (MANDATORY - stops if fails)
3. Read and follow the instructions in references/version-validator.md
4. Read and follow the instructions in references/test-coverage.md (coverage generation)

Execution Order:

1. Execute references/tool-installer.md rule first (MANDATORY - stops if fails)
2. Execute references/version-alignment.md rule (MANDATORY - stops if fails)
3. Execute references/version-validator.md rule to verify nvm setup and comprehensive dependency management
4. Execute references/test-coverage.md rule to generate coverage

Comprehensive Dependency Management:

• Root project: npm install or yarn install or pnpm install
• All packages: find packages/ -name "package.json" -execdir npm install \;
• All apps: find apps/ -name "package.json" -execdir npm install \;
• Verification: npm list or yarn list or pnpm list
• Build artifacts generation (if build step exists):
  • Root: npm run build or yarn build or pnpm build
  • Apps: find apps/ -name "package.json" -execdir npm run build \;

Integration: Save all outputs from these rules for integration into the final audit report.

Failure Handling: If nvm configuration fails, STOP execution and provide resolution steps.

Parallel Execution Strategy

Steps 1-9 can be partially parallelized using the Agent tool to launch multiple analysis agents simultaneously. Use the following wave structure:

Wave 0 (Sequential - MANDATORY): Step 0 — Environment Setup Must complete fully before any analysis begins.

Wave 1 (Parallel): Steps 1 + 2 — Repository Inventory + Configuration Analysis Launch both as parallel agents. Both read from the filesystem independently.

Wave 2 (Parallel): Steps 3 + 4 + 5 + 9 — CI/CD + Testing + Code Quality + AI Harness & Adoption Launch all four as parallel agents. Independent read-only analyses; the harness analysis depends on no prior artifact, so it joins this wave.

Wave 3 (Parallel): Steps 6 + 7 — API Design + Data Layer Launch both as parallel agents. Independent framework-specific analyses.

Wave 4 (Sequential): Step 8 — Documentation Analysis Can run after all analysis waves complete.

Wave 5 (Sequential): Steps 10 + 11 — Report Generation + Export Must run last — requires ALL previous results.

Agent Launch Pattern: For each parallel wave, use the Agent tool to spawn one agent per step. Each agent MUST:

1. Read the referenced .md file completely
2. Execute ALL instructions in that file
3. Return the complete analysis results
4. Never abbreviate or summarize — return full evidence

Example for Wave 1:

• Agent 1: "Read references/repository-inventory.md and execute ALL instructions. Return complete findings."
• Agent 2: "Read references/config-analysis.md and execute ALL instructions. Return complete findings."

Step 1. Repository Inventory

Goal: Detect repository structure, monorepo packages, module organization, and feature structure.

Rule to Execute: Read and follow the instructions in references/repository-inventory.md

Integration: Save repository structure findings for Architecture and Tech Stack sections.

Step 2. Core Configuration Files

Goal: Read and analyze NestJS/Node.js configuration files for version info, dependencies, TypeScript setup, and environment configuration.

Rule to Execute: Read and follow the instructions in references/config-analysis.md

Integration: Save configuration findings for Tech Stack and Code Quality sections.

Step 3. CI/CD Workflows Analysis

Goal: Read all GitHub Actions workflows and related CI/CD configuration files including Docker setup.

Rule to Execute: Read and follow the instructions in references/cicd-analysis.md

Integration: Save CI/CD findings for CI/CD section scoring.

Step 4. Testing Infrastructure

Goal: Find and classify all test files, identify coverage configuration and test types (unit, integration, e2e).

Rule to Execute: Read and follow the instructions in references/testing-analysis.md

Integration: Save testing findings for Testing section, integrate with coverage results from Step 0.

Step 5. Code Quality and Linter

Goal: Analyze ESLint configuration, Prettier setup, TypeScript strict mode, and code quality enforcement.

Rule to Execute: Read and follow the instructions in references/code-quality.md

Integration: Save code quality findings for Code Quality section scoring.

Step 6. API Design Analysis

Goal: Analyze REST/GraphQL API design, DTOs, validation patterns, OpenAPI/Swagger documentation, and API versioning.

Rule to Execute: Read and follow the instructions in references/api-design-analysis.md

Integration: Save API design findings for API Design section scoring.

Step 7. Data Layer Analysis

Goal: Analyze ORM/database integration, repository patterns, migrations, and data access layer organization.

Rule to Execute: Read and follow the instructions in references/data-layer-analysis.md

Integration: Save data layer findings for Data Layer section scoring.

Step 8. Documentation and Operations

Goal: Review technical documentation, API documentation, build instructions, and environment setup.

Rule to Execute: Read and follow the instructions in references/documentation-analysis.md

Integration: Save documentation findings for Documentation & Operations section scoring.

Step 9. AI Harness & Adoption Analysis

Goal: Score the project's AI harness — CLAUDE.md, .claude/rules/, settings.json permissions and hooks, .claude/agents/, commands/skills, and the pre-push git hook — on the 10-dimension, 100-point rubric, judging quality, not just presence.

Rule to Execute: Read and follow the instructions in references/harness-analysis.md

Integration: Save the AI Harness & Adoption findings, score, and prioritised action list for the "AI Harness & Adoption" report section.

Step 10. Generate Final Report

Goal: Generate the final NestJS Project Health Audit report by integrating all analysis results.

Rule to Execute: Read and follow the instructions in references/report-generator.md

Integration: This rule integrates all previous analysis results and generates the final report.

Report Sections:

• Executive Summary with overall score
• At-a-Glance Scorecard with all 9 section scores, plus the > Test Coverage: line, the scoring legend, and the Overall Score interpretation sentence
• All 9 detailed sections (Tech Stack, Architecture, API Design, Data Layer, Testing, Code Quality, Documentation & Operations, CI/CD, AI Harness & Adoption) — Testing carries the canonical Code Coverage / Coverage Breakdown fields
• Additional Metrics (no coverage percentages — those live only in the scorecard line and the Testing section)
• Risks & Opportunities (5-8 bullets)
• Recommendations (6-10 prioritized actions)
• Appendix: Evidence Index
• Appendix: Scoring Methodology (unnumbered; the only place weights appear)

Step 11. Export Final Report

Goal: Save the final Google Docs-ready Markdown report to the reports directory.

Action: Create the reports directory if it doesn't exist and save the final NestJS Project Health Audit report to: ./reports/<YYYY-MM-DD>-<project>-nestjs-health-audit.md

Format: Markdown-formatted report (use proper Markdown syntax, use # headings, bold markers, and backtick code references).

Command:

mkdir -p reports
# Save report content to ./reports/<YYYY-MM-DD>-<project>-nestjs-health-audit.md

Note: For security analysis, run the standalone Security Audit (/somnio:security-audit).

Execution Summary

Total Rules: 14 rules

Rule Execution Order:

1. references/tool-installer.md {model: cheap}
2. references/version-alignment.md (MANDATORY - stops if nvm fails) {model: cheap}
3. references/version-validator.md (verification of nvm setup) {model: cheap}
4. references/test-coverage.md (coverage generation) {model: cheap}
5. references/repository-inventory.md {model: cheap}
6. references/config-analysis.md {model: cheap}
7. references/cicd-analysis.md {model: mid}
8. references/testing-analysis.md {model: mid}
9. references/code-quality.md {model: mid}
10. references/api-design-analysis.md {model: mid}
11. references/data-layer-analysis.md {model: mid}
12. references/documentation-analysis.md {model: cheap}
13. Read and follow the instructions in references/harness-analysis.md {model: mid}
14. references/report-generator.md {model: frontier}

Wave-Based Parallel Execution:

• Wave 0 (Sequential): Step 0 — Environment Setup (rules 1-4)
• Wave 1 (Parallel): Steps 1 + 2 — Repository Inventory + Configuration (rules 5-6)
• Wave 2 (Parallel): Steps 3 + 4 + 5 + 9 — CI/CD + Testing + Code Quality + AI Harness & Adoption (rules 7-9, 13)
• Wave 3 (Parallel): Steps 6 + 7 — API Design + Data Layer (rules 10-11)
• Wave 4 (Sequential): Step 8 — Documentation (rule 12)
• Wave 5 (Sequential): Steps 10 + 11 — Report Generation + Export (rule 14)

Benefits of Modular Approach:

• Each rule can be executed independently
• Outputs can be saved and reused
• Easier debugging and maintenance
• Wave-based parallelization accelerates analysis using the Agent tool
• Clear separation of concerns
• Strict no-shortcuts enforcement ensures complete, evidence-based analysis
• Comprehensive dependency management for monorepos
• Complete nvm configuration enforcement
• Full project environment setup with all dependencies

Subagent Dispatch (in-session)

This section describes the in-session multi-agent path. The Rule Execution Order above remains the CLI (somnio run) path and is unchanged.

Entry point: agents/orchestrator.md (model: mid). The orchestrator dispatches all subagents via the Agent tool, validates artifacts between waves, and hands the artifact manifest to the report writer.

Wave plan:

Wave	Mode	Subagent(s)	Tier	Reference(s) covered	Artifact(s) produced
0	Sequential (MANDATORY gate)	env-setup-agent	cheap	tool-installer, version-alignment, version-validator, test-coverage	step_00_env_setup.md, step_00_test_coverage.md
1	Parallel	repo-analyzer, config-analyzer	cheap, cheap	repository-inventory, config-analysis	step_01_repository_inventory.md, step_02_config_analysis.md
2	Parallel	cicd-analyzer, testing-analyzer, code-quality-analyzer, harness-analyzer	mid, mid, mid, mid	cicd-analysis, testing-analysis, code-quality, harness-analysis	step_03_cicd_analysis.md, step_04_testing_analysis.md, step_05_code_quality.md, step_09_harness_analysis.md
3	Parallel	api-design-analyzer, data-layer-analyzer	mid, mid	api-design-analysis, data-layer-analysis	step_06_api_design_analysis.md, step_07_data_layer_analysis.md
4	Sequential	docs-analyzer	cheap	documentation-analysis	step_08_documentation_analysis.md
5	Sequential	report-writer-agent	frontier	report-generator, report-format-enforcer, assets/report-template.md	reports/<YYYY-MM-DD>-<project>-nestjs-health-audit.md

Orchestrator behavior:

• Wave 0 is the only hard-stop gate: if env-setup-agent emits Result: FAILED, the orchestrator halts and surfaces resolution steps.
• For any non-mandatory artifact missing after a wave: retry the responsible agent once; if the artifact is still absent, log the skip and mark the section as Unavailable in the manifest.
• The orchestrator NEVER reads source code or writes prose.

Report writer behavior:

• Reads all eleven artifacts produced by Waves 0–4.
• Computes 9 weighted section scores and overall score per the weights defined in references/report-generator.md — that file is the single source of truth; do not restate the numbers here.
• Enforces the mandatory 15-section structure per references/report-format-enforcer.md.
• Performs cross-section score reconciliation (e.g., low Testing score modulates Code Quality narrative).
• Writes reports/<YYYY-MM-DD>-<project>-nestjs-health-audit.md and appends the metadata block.
• NEVER re-reads raw source files.

Report File Name (MANDATORY)

The report file name is always:

<YYYY-MM-DD>-<project>-nestjs-health-audit.md

• <YYYY-MM-DD> — the date of this run.
• <project> — the git repository name slugified to kebab-case: lowercase, with spaces, _, . and / turned into -, every other character dropped, and repeated - collapsed. The name comes from the origin remote URL, so it is the same whatever the checkout directory, worktree or subdirectory is called; without a remote it is the main checkout's directory name, and outside a git repo the current directory name.
• The trailing segment is this skill's name and never changes.

Derive it once, before writing anything:

mkdir -p reports
REPO="$(git remote get-url origin 2>/dev/null | sed -E 's#/+$##; s#.*[/:]##; s#\.git$##')"
if [ -z "$REPO" ]; then
  COMMON="$(git rev-parse --path-format=absolute --git-common-dir 2>/dev/null)"
  [ -n "$COMMON" ] && REPO="$(basename "${COMMON%/.git}" .git)"
fi
[ -n "$REPO" ] || REPO="$(basename "$PWD")"
REPORT="reports/$(date +%F)-$(printf '%s' "$REPO" \
  | tr '[:upper:]' '[:lower:]' | tr ' _./' '-' \
  | sed -E 's/[^a-z0-9-]//g; s/-+/-/g; s/^-|-$//g')-nestjs-health-audit.md"

Everywhere this skill writes reports/<YYYY-MM-DD>-<project>-nestjs-health-audit.md, it means that resolved path.

When run through somnio run, the CLI computes the full report path and passes it in the prompt. Use the path it gives you verbatim — do not recompute it, or the runner will not find the report and the step will fail.

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:

1. Look for .claude-plugin/plugin.json by traversing up from this skill's directory
2. If found, read name and version from that file (plugin context)
3. 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, as an unnumbered Markdown table (it follows the "Appendix: Scoring Methodology" block):

## Report Metadata

| Field | Value |
|-------|-------|
| Generated by | [Plugin Name] v[Plugin Version] |
| Skill | nestjs-health-audit |
| Date | [YYYY-MM-DD] |
| Somnio AI Tools | https://github.com/somnio-software/somnio-ai-tools |