roast-my-codebase 1.1.2 → 1.2.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/README.md +38 -3
- package/dist/index.js +9385 -3138
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -114,12 +114,24 @@ npx roast-my-codebase --markdown-file # Save to .roast-report.md
|
|
|
114
114
|
### Fully Supported
|
|
115
115
|
- **JavaScript** (.js, .jsx, .mjs, .cjs)
|
|
116
116
|
- **TypeScript** (.ts, .tsx)
|
|
117
|
-
- **Python** (.py) — Complexity, type hints, imports
|
|
117
|
+
- **Python** (.py) — Complexity, type hints, imports, docstrings, security, class design
|
|
118
118
|
- **Go** (.go) — Complexity, error handling, lint conventions
|
|
119
119
|
- **Rust** (.rs) — Complexity, unsafe usage, clippy hints
|
|
120
120
|
- **Java** (.java) — Complexity, code smells, naming conventions
|
|
121
121
|
- **C#** (.cs) — Complexity, code smells, async patterns
|
|
122
122
|
|
|
123
|
+
### Framework-Specific Checks
|
|
124
|
+
|
|
125
|
+
| Framework | What's detected |
|
|
126
|
+
|-----------|----------------|
|
|
127
|
+
| **Next.js** | Missing metadata exports, server/client component misuse |
|
|
128
|
+
| **React** | Missing error boundaries |
|
|
129
|
+
| **Vue 3** | Options API in Vue 3, v-for without :key, deep watchers |
|
|
130
|
+
| **Angular** | Missing OnPush strategy, direct DOM manipulation, untyped events |
|
|
131
|
+
| **Svelte** | Reactive side effects, inaccessible buttons |
|
|
132
|
+
| **Express** | Missing error middleware, no rate limiting, sync I/O in routes |
|
|
133
|
+
| **FastAPI** | Missing response_model, sync endpoints, missing status codes |
|
|
134
|
+
|
|
123
135
|
### Language-Specific Checks
|
|
124
136
|
|
|
125
137
|
| Language | Scanners |
|
|
@@ -272,7 +284,12 @@ roast-my-codebase --interactive
|
|
|
272
284
|
- ✅ Remove unused dependencies (`npm uninstall`)
|
|
273
285
|
- ✅ Add issue references to TODO comments
|
|
274
286
|
- ✅ Remove dead exports
|
|
275
|
-
-
|
|
287
|
+
- ✅ Add `'use client'` directive to Next.js components
|
|
288
|
+
- ✅ Add missing metadata export to Next.js pages
|
|
289
|
+
- ✅ Add `.env` files to `.gitignore`
|
|
290
|
+
- ✅ Upgrade `@ts-ignore` to `@ts-expect-error`
|
|
291
|
+
- ✅ Create skeleton test files for untested source files
|
|
292
|
+
- ✅ Add secret files to `.gitignore`
|
|
276
293
|
|
|
277
294
|
**Example session:**
|
|
278
295
|
```
|
|
@@ -296,7 +313,25 @@ Unused dependency `lodash` is installed but never imported
|
|
|
296
313
|
Exit interactive mode
|
|
297
314
|
```
|
|
298
315
|
|
|
299
|
-
###
|
|
316
|
+
### HTML Report
|
|
317
|
+
```bash
|
|
318
|
+
roast-my-codebase --html-file
|
|
319
|
+
```
|
|
320
|
+
- Saves `.roast-report.html` — a beautiful standalone HTML report
|
|
321
|
+
- Dark theme, SVG health gauge, sortable findings table, severity chart
|
|
322
|
+
- Fully self-contained (no CDN, works offline)
|
|
323
|
+
- Perfect for sharing with the team
|
|
324
|
+
|
|
325
|
+
# Incremental Scanning
|
|
326
|
+
```bash
|
|
327
|
+
roast-my-codebase --incremental # Only changed files since last commit
|
|
328
|
+
roast-my-codebase --since main # Only files changed since branching from main
|
|
329
|
+
```
|
|
330
|
+
- Dramatically faster on large repos — only scans changed files
|
|
331
|
+
- Global findings (circular deps, excessive dependencies) are always shown
|
|
332
|
+
- Falls back to full scan if not in a git repository
|
|
333
|
+
|
|
334
|
+
# Watch Mode
|
|
300
335
|
```bash
|
|
301
336
|
roast-my-codebase --watch
|
|
302
337
|
```
|