malhajri07/coverage-report
.claude/skills/coverage-report/SKILL.md
Report TSDoc/JSDoc coverage across the codebase — what % of exported symbols have documentation blocks, and which files have the worst coverage. Use after /comment-batch sessions and as the C20 verification step.
development
Updated Apr 16, 2026
$ install --global
skillsauthnpx skillsauth add malhajri07/real-estate-CRM-project coverage-reportInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 16, 2026, 12:55 AM4.8s1 file scanned
SKILL.md
- name:
- coverage-report
- description:
- Report TSDoc/JSDoc coverage across the codebase — what % of exported symbols have documentation blocks, and which files have the worst coverage. Use after /comment-batch sessions and as the C20 verification step.
coverage-report
A simple, dependency-free way to measure how much of the codebase has TSDoc. Don't wait for full TypeDoc tooling — this skill works today.
Inputs
- Scope (optional) —
web|api|schema|all(defaultall) - Format (optional) —
summary(default) |detailed
Steps
-
Find all source files:
- Web:
apps/web/src/**/*.{ts,tsx}excluding*.test.*,*.spec.*,node_modules,dist - API:
apps/api/{routes,middleware,lib}/**/*.ts - Schema:
data/schema/prisma/schema.prisma(special handling —///triple-slash, not/**)
- Web:
-
For each file, count:
- Exports: lines matching
^export (async )?(function|class|const|default function|default class)or^export default function - React components: lines matching
^export (default )?function [A-Z](PascalCase) - TSDoc blocks: count of
^/\*\*immediately preceded by an export within 10 lines
- Exports: lines matching
-
Compute coverage = (documented exports / total exports) × 100, per file and overall.
-
Format output:
Summary mode:
Coverage report ─────────────── apps/web: 234/812 (29%) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ░░░░░░░░░░░░░░ apps/api: 87/192 (45%) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ░░░ schema: 12/78 (15%) ━━━━━━━━━━━━━━━━━━━━━━━░░░░░░░░░░░░░░░░░░░░░░ ─────────────── Overall: 333/1082 (31%) Worst-covered files: - apps/web/src/pages/admin/system-settings.tsx (0/14) - apps/web/src/components/admin/data-display/AdminTable.tsx (0/9) - apps/api/routes/promotions.ts (1/12)Detailed mode: also list every file with
< 50%coverage and show file:line for each undocumented export. -
Compare to last run if a previous report exists at
Aqarkom_Knowledge/Engineering/Coverage Report.md. -
Save the result to
Aqarkom_Knowledge/Engineering/Coverage Report.mdwith a timestamp so future runs can show deltas. -
Recommend next session — find the C session in [[Sessions/Comment Plan C1-C20]] that targets the worst-covered files and link to it.
Verification
- [ ] All scope files counted
- [ ] Numbers add up (documented + undocumented = total)
- [ ] Output saved to vault
- [ ] Next-session recommendation included
Notes
- This is a heuristic, not a perfect parser — it can miss exotic export styles. If a file looks suspiciously low-coverage, eyeball it manually.
- For more rigorous analysis later, we'll add
typedoc --validation.notDocumentedin C1's tooling step. Until then, this skill is "good enough". - Don't penalize shadcn re-exports or generated files — exclude them from the count.
Exclusions
Always exclude:
node_modules/dist/,build/*.test.ts,*.spec.ts,tests/.next/,.vite/- Files inside
apps/web/src/components/ui/that are pure shadcn re-exports (no project logic) - Generated files (Prisma client, GraphQL codegen)
Related Skills
malhajri07/obsidian-markdown
testing
VerifiedTrustedCommunity
Create and edit Obsidian Flavored Markdown with wikilinks, embeds, callouts, properties, and other Obsidian-specific syntax. Use when working with .md files in Obsidian, or when the user mentions wikilinks, callouts, frontmatter, tags, embeds, or Obsidian notes.
SKILL.mdUpdated Apr 16, 2026
malhajri07/obsidian-cli
tools
VerifiedTrustedCommunity
Interact with Obsidian vaults using the Obsidian CLI to read, create, search, and manage notes, tasks, properties, and more. Also supports plugin and theme development with commands to reload plugins, run JavaScript, capture errors, take screenshots, and inspect the DOM. Use when the user asks to interact with their Obsidian vault, manage notes, search vault content, perform vault operations from the command line, or develop and debug Obsidian plugins and themes.
SKILL.mdUpdated Apr 16, 2026
malhajri07/obsidian-bases
data-ai
VerifiedTrustedCommunity
Create and edit Obsidian Bases (.base files) with views, filters, formulas, and summaries. Use when working with .base files, creating database-like views of notes, or when the user mentions Bases, table views, card views, filters, or formulas in Obsidian.
SKILL.mdUpdated Apr 16, 2026
malhajri07/json-canvas
tools
VerifiedTrustedCommunity
Create and edit JSON Canvas files (.canvas) with nodes, edges, groups, and connections. Use when working with .canvas files, creating visual canvases, mind maps, flowcharts, or when the user mentions Canvas files in Obsidian.
SKILL.mdUpdated Apr 16, 2026