repo-audit
v1.0.0
Published
A multi-step codebase health audit workflow that scans any Node.js or JavaScript project and produces a structured health report. Detects dead exports, large files, circular dependencies, missing JSDoc coverage, high-complexity functions, and unused depen
Downloads
23
Maintainers
Readme
RepoAudit
A fast, zero-dependency codebase health audit tool for JavaScript and Node.js projects. Detect dead exports, circular dependencies, unused packages, and code quality issues without external APIs.
Features
- Dead Export Detection — Find unused exports across your codebase
- Large File Analysis — Identify bloated modules exceeding size thresholds
- Circular Dependency Detection — Spot dependency cycles that cause maintenance headaches
- JSDoc Coverage — Measure documentation completeness
- Complexity Analysis — Flag high-complexity functions
- Unused Dependencies — Remove packages you're not actually using
- Zero External Dependencies — Runs entirely offline, no API keys needed
Installation
npm install -g repoauditOr use directly:
npx repoauditQuick Start
Run an audit on your current project:
repoauditScan a specific directory:
repoaudit ./srcUsage Examples
Basic audit with terminal output
repoauditAudit with custom thresholds
repoaudit --max-file-size 50kb --complexity-threshold 15Generate JSON for CI pipelines
repoaudit --format json --output report.jsonFail on health issues (for CI/CD)
repoaudit --fail-on-issuesExclude directories
repoaudit --ignore node_modules,dist,buildOutput
The free version generates a detailed terminal report showing:
- Health score (0-100)
- Issue breakdown by category
- File-by-file analysis
- Actionable recommendations
Premium Features
- HTML Reports — Interactive charts and visualizations
- CSV/JSON Export — Integrate with dashboards and tracking tools
- CI/CD Integration — Automated health gates with exit codes
- Trend Tracking — Monitor health metrics over time
FAQ
Q: Does RepoAudit require internet?
A: No. It runs completely offline with zero external API calls.
Q: What Node.js versions are supported?
A: Node.js 14.0.0 and above.
Q: Can I use this in CI/CD pipelines?
A: Yes. Use --fail-on-issues to fail builds when health thresholds aren't met.
Q: How long does an audit take?
A: Most projects complete in seconds. Large codebases (10k+ files) may take 30-60 seconds.
Q: Does it support monorepos?
A: Yes. Run audits on individual packages or the entire workspace.
Q: Can I customize which checks run?
A: Yes. Use flags like --skip-complexity, --skip-jsdoc, etc.
Support: [email protected]
Built with AI by Craftpipe
Pro Features
Upgrade to Pro for:
- html report
- json csv export
- ci integration
Get it at: https://craftpipe.gumroad.com
Set PRO_LICENSE=<your-key> to unlock.
