lmiranda
7c8a20c804
Refactored commands to extract reusable skills following the Commands → Skills separation pattern. Each command is now <50 lines and references skill files for detailed knowledge. Plugins refactored: - claude-config-maintainer: 5 commands → 7 skills - code-sentinel: 3 commands → 2 skills - contract-validator: 5 commands → 6 skills - data-platform: 10 commands → 6 skills - doc-guardian: 5 commands → 6 skills (replaced nested dir) - git-flow: 8 commands → 7 skills Skills contain: workflows, validation rules, conventions, reference data, tool documentation Commands now contain: YAML frontmatter, agent assignment, skills list, brief workflow steps, parameters Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
---
|
|
description: Calculate documentation coverage percentage for functions and classes
|
|
---
|
|
|
|
# Documentation Coverage
|
|
|
|
Analyze codebase to calculate documentation coverage metrics.
|
|
|
|
## Skills to Load
|
|
|
|
- skills/coverage-calculation.md
|
|
- skills/doc-patterns.md
|
|
|
|
## Visual Output
|
|
|
|
```
|
|
+------------------------------------------------------------------+
|
|
| DOC-GUARDIAN - Documentation Coverage |
|
|
+------------------------------------------------------------------+
|
|
```
|
|
|
|
## Process
|
|
|
|
1. **Scan Source Files**
|
|
Execute `skills/coverage-calculation.md` - identify documentable items
|
|
|
|
2. **Determine Documentation Status**
|
|
Check each item has meaningful docstring/JSDoc
|
|
|
|
3. **Calculate Metrics**
|
|
Use formula from skill: `Coverage = (Documented / Total) * 100`
|
|
|
|
4. **Output**
|
|
Use format from `skills/coverage-calculation.md`
|
|
|
|
## Options
|
|
|
|
| Flag | Description | Default |
|
|
|------|-------------|---------|
|
|
| `--path <dir>` | Scan specific directory | Project root |
|
|
| `--exclude <glob>` | Exclude pattern | `**/test_*` |
|
|
| `--min-coverage <pct>` | Fail if below | none |
|
|
| `--detailed` | Check params/returns | false |
|
|
|
|
## Exit Codes
|
|
|
|
- 0: Coverage meets threshold
|
|
- 1: Coverage below threshold
|