| name | audit-codebase |
| description | Executes project-specific static analysis to detect hardcoded paths, magic numbers, missing docstrings, and commented code. Invoke when asked to code review for code quality. |
DP-EVA Code Audit
This skill runs a custom static analysis tool tailored for the DP-EVA project. It checks for:
- Hardcoded Absolute Paths: Critical for HPC environment portability.
- Missing Docstrings: Enforces documentation on public APIs.
- Magic Numbers: Detects unnamed numeric literals.
- Commented Code: Identifies potential dead code.
Usage
To run the audit on the default source directory (src/dpeva):
python scripts/audit.py
To run in strict mode (fails on warnings):
python scripts/audit.py --strict
To audit a specific directory:
python scripts/audit.py <directory>
Interpretation
- 🔴 ERROR: Blocking violation (e.g., hardcoded path). Must be fixed before merge.
- 🟡 WARNING: High-priority issue (e.g., missing docstring on public class). Should be fixed.
- 🔵 INFO: Code smell (e.g., magic number, commented code). Recommendation for cleanup.