Scooop & Security Analyzer
A lightweight VS Code extension that analyzes your codebase against user-defined rules and generates a clear, actionable health & security report.
Features
- Custom Rules: Define your own checks via
.scooop.json (regex, imports, naming, line length, complexity, nesting, structure).
- Security-Focused: Catch common issues like
eval(), SQL injection patterns, hardcoded secrets, weak crypto, and more.
- Code Quality: Enforce naming conventions, complexity limits, nesting depth, and project structure.
- Interactive Dashboard: View issues grouped by severity with file links to jump directly to the problem.
- Export Reports: Save results as Markdown or JSON for CI, reviews, or documentation.
- Works Offline: Runs entirely locally on your machine - no data leaves your environment.
Quick Start
- Install the extension in VS Code.
- Open a project/workspace.
- Run
Scooop: Open Config (.scooop.json) from the Command Palette (Ctrl+Shift+P).
- Customize your rules (see GUIDANCE.md for help).
- Analyze with
Ctrl+Shift+H (Cmd+Shift+H on macOS). The dashboard will open automatically.
Configuration
Create a .scooop.json file in your project root. Check GUIDANCE.md for a full guide, rule types, examples, and a ready-to-copy starter config.
Example snippets are also available in examples/.
Commands
| Command |
Shortcut |
Description |
Scooop: Run Analysis |
Ctrl+Shift+H / Cmd+Shift+H |
Run analysis on the current workspace. |
Scooop: Show Dashboard |
Ctrl+Shift+J / Cmd+Shift+J |
Show the latest report. |
Scooop: Export Report (Markdown) |
- |
Export as code-health-report-YYYY-MM-DD.md. |
Scooop: Export Report (JSON) |
- |
Export as JSON. |
Scooop: Open Config (.scooop.json) |
- |
Create/edit your config file. |
Scooop: Go To Issue |
- |
Jump from the Issues tree to the code location. |
Development
npm install
npm run compile
npm run watch
npm run typecheck
npm run lint
npm test
License
MIT
| |