technical-debt-radar 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +67 -0
- package/dist/index.js +20661 -0
- package/package.json +69 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Khalid Elattar
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Technical Debt Radar
|
|
2
|
+
|
|
3
|
+
**Stop Node.js production crashes before merge.**
|
|
4
|
+
|
|
5
|
+
Detects event-loop blockers, dangerous ORM patterns, and architecture drift in your PRs. 47 detection patterns across 5 categories. Works with NestJS, Express, Fastify, Koa, Hapi + 7 ORMs.
|
|
6
|
+
|
|
7
|
+
## Quick Start
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx technical-debt-radar scan .
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
First scan is free. No account needed.
|
|
14
|
+
|
|
15
|
+
## What It Finds
|
|
16
|
+
|
|
17
|
+
- **Runtime risks** — sync I/O, crypto, ReDoS in request handlers (11 patterns)
|
|
18
|
+
- **Performance** — N+1 queries, unbounded fetches, missing pagination (9 patterns, volume-aware)
|
|
19
|
+
- **Reliability** — unhandled promises, missing timeouts, empty catches (8 patterns)
|
|
20
|
+
- **Architecture** — layer violations, circular dependencies (4 rules)
|
|
21
|
+
- **Maintainability** — complexity, duplication, dead code, coverage drops (7 patterns)
|
|
22
|
+
|
|
23
|
+
## Commands
|
|
24
|
+
|
|
25
|
+
| Command | Description |
|
|
26
|
+
|---------|-------------|
|
|
27
|
+
| `radar scan .` | Scan project, show violations |
|
|
28
|
+
| `radar check <file>` | Check single file |
|
|
29
|
+
| `radar init` | Auto-detect stack, generate config |
|
|
30
|
+
| `radar fix .` | AI-powered fixes (requires login) |
|
|
31
|
+
| `radar login` | Authenticate for unlimited scans |
|
|
32
|
+
| `radar whoami` | Show account and usage |
|
|
33
|
+
| `radar validate` | Validate radar.yml |
|
|
34
|
+
| `radar badge` | Generate README badge |
|
|
35
|
+
| `radar pack list` | Browse rule packs |
|
|
36
|
+
|
|
37
|
+
## Output Formats
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
radar scan . --format text # Human-readable (default)
|
|
41
|
+
radar scan . --format json # Machine-readable
|
|
42
|
+
radar scan . --format table # Compact table
|
|
43
|
+
radar scan . --format markdown # Markdown report
|
|
44
|
+
radar scan . --format ai-prompt # Paste into Claude/Cursor for fixes
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## CI/CD (GitHub Action)
|
|
48
|
+
|
|
49
|
+
```yaml
|
|
50
|
+
- uses: khalid-Elattar/technical_dept_radar@v1
|
|
51
|
+
with:
|
|
52
|
+
radar-token: ${{ secrets.RADAR_TOKEN }}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Pricing
|
|
56
|
+
|
|
57
|
+
- **Free:** Unlimited scans, PR comments (warn mode)
|
|
58
|
+
- **Solo ($15/mo):** PR merge blocking + 50 AI credits
|
|
59
|
+
- **Pro ($49/mo):** GitLab, cross-file AI, architecture graph
|
|
60
|
+
|
|
61
|
+
https://technical-debt-radar.vercel.app/pricing
|
|
62
|
+
|
|
63
|
+
## Links
|
|
64
|
+
|
|
65
|
+
- Website: https://technical-debt-radar.vercel.app
|
|
66
|
+
- Dashboard: https://technical-debt-radar.vercel.app/dashboard
|
|
67
|
+
- GitHub: https://github.com/khalid-Elattar/technical_dept_radar
|