npm - roast-my-codebase - Versions diffs - 1.3.5 → 1.3.6 - Mend

roast-my-codebase 1.3.5 → 1.3.6

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.

Files changed (2) hide show

package/README.md +203 -385
package/package.json +1 -1

package/README.md CHANGED Viewed

@@ -2,427 +2,256 @@
 > Get roasted. Get better. Ship faster.
-A zero-config CLI that analyzes your codebase and delivers brutally honest (but funny) feedback. Every roast is backed by a real finding — no random nonsense.
+A zero-config CLI that scans your codebase and delivers brutally honest (but funny) feedback. Every roast is backed by a real finding — not random noise.
-```
+```bash
 npx roast-my-codebase
 ```
-## What it does
-Scans your project in seconds and produces:
+---
-- **Health Score** (0–100) based on real code quality signals
-- **Project Statistics** — files, lines, dependencies
-- **Actionable Findings** — large files, circular deps, unused packages, TODOs
-- **Roasts** — humorous commentary tied to actual issues
-- **Verdict** — a one-liner summary of your codebase's state
-## Screenshot
+## What it looks like
 ```
 ╔═════════════════════════════╗
 ║    Roast My Codebase    🔥  ║
 ╚═════════════════════════════╝
-  Project Health: 72/100  C  Fair
+  Project: my-app
-  [██████████████████████░░░░░░░░]
+  Health Score: 42/100  F  Chaotic
-  Files Scanned      438
-  Lines of Code      64,112
-  Dependencies       87
+  [████████████░░░░░░░░░░░░░░░░░░]
-  ⚠ 14 TODOs
-  ⚠ 7 Large Files (500+ lines)
-  ⚠ 2 Circular Dependencies
+  Some findings require immediate attention.
-  🔥 Roast
+  Project Summary
+  ────────────────────────────────────────
+  Files Scanned      138
+  Total Files        412
+  Lines of Code      28,904
+  Dependencies       54
+  Dev Dependencies   21
-  auth.service.ts (1,847 lines)
-  This file contains several geological layers.
+  Findings
+  ────────────────────────────────────────
+  ● 3 critical
+  ● 18 warnings
+  ● 11 info
-  Verdict:
-  Your codebase is at that stage where 'refactor sprint'
-  keeps getting postponed.
-```
+  ✗ AuthService in src/auth/auth.service.ts has cyclomatic complexity of 34
+     Gru's plan: write simple function → add one more condition → this.
+  ✗ .env is tracked in git — secrets may be exposed
+     Little Bobby Tables visited your repo. He felt at home.
+  ⚠ src/auth/auth.service.ts is 1,847 lines
+     Nobody: ... This file: *adds 200 more lines*
+  ⚠ "lodash" appears unused — paying rent for no reason
+     node_modules: the folder that makes SSD manufacturers nervous.
+  ⚠ src/utils/helpers.ts has cyclomatic complexity of 22
+     I've seen smaller decision trees at the DMV.
-## Installation
+  The findings have formed a coalition.
-```bash
-# Run directly (no install needed)
-npx roast-my-codebase
+  ────────────────────────────────────────
-# Or install globally
-npm install -g roast-my-codebase
-roast-my-codebase
-```
+  Verdict
-## Usage
+  Functional code with security issues is a solved problem waiting to be exploited.
-```bash
-# Basic scan
-npx roast-my-codebase
+  ────────────────────────────────────────
-# Scan specific path
-npx roast-my-codebase ./path/to/project
+  Share your roast → https://x.com/intent/tweet?text=My%20codebase%20just%20got%20roasted...
-# Get actionable fix suggestions
-npx roast-my-codebase --fix
+  roast-my-codebase · github.com/rahuldk1105/roast-my-codebase
+```
-# AI-powered contextual roasts
-npx roast-my-codebase --ai-roasts
+---
-# Interactive mode - walk through fixing issues
-npx roast-my-codebase --interactive
+## Add it to your CI in 30 seconds
-# Preview fixes without applying them
-npx roast-my-codebase --interactive --dry-run
+Every PR gets a roast comment automatically. Teams screenshot them. They spread.
-# Watch mode (re-run on file changes)
-npx roast-my-codebase --watch
+**Step 1** — create `.github/workflows/roast.yml` in your repo:
-# JSON output for CI/CD
-npx roast-my-codebase --json --threshold 80
+```yaml
+name: Roast My Codebase
-# Compare against a git branch
-npx roast-my-codebase --compare main
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
-# Viral features for sharing
-npx roast-my-codebase --ascii          # Big ASCII art grade
-npx roast-my-codebase --badge          # Generate SVG badge
-npx roast-my-codebase --markdown       # Markdown for PRs
-npx roast-my-codebase --markdown-file  # Save to .roast-report.md
-```
+permissions:
+  pull-requests: write
-## What gets analyzed
+jobs:
+  roast:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
-| Check | What it finds |
-|-------|--------------|
-| **File Size** | Files over 500/1000/2000 lines |
-| **TODOs** | TODO, FIXME, HACK, XXX comments |
-| **Dependencies** | Excessive or unused packages |
-| **Circular Deps** | Import cycles between modules |
-| **Structure** | Deep nesting, bloated folders, utils explosion |
-| **Complexity** | Functions with high cyclomatic complexity (15+) |
-| **Duplicates** | Copy-pasted code blocks across files |
-| **Dead Exports** | Exports that are never imported |
-| **Type Safety** | `any` usage, `@ts-ignore`, type bypasses |
-## Supported Languages
-### Fully Supported
-- **JavaScript** (.js, .jsx, .mjs, .cjs)
-- **TypeScript** (.ts, .tsx)
-- **Python** (.py) — Complexity, type hints, imports, docstrings, security, class design
-- **Go** (.go) — Complexity, error handling, lint conventions
-- **Rust** (.rs) — Complexity, unsafe usage, clippy hints
-- **Java** (.java) — Complexity, code smells, naming conventions
-- **C#** (.cs) — Complexity, code smells, async patterns
-### Framework-Specific Checks
-| Framework | What's detected |
-|-----------|----------------|
-| **Next.js** | Missing metadata exports, server/client component misuse |
-| **React** | Missing error boundaries |
-| **Vue 3** | Options API in Vue 3, v-for without :key, deep watchers |
-| **Angular** | Missing OnPush strategy, direct DOM manipulation, untyped events |
-| **Svelte** | Reactive side effects, inaccessible buttons |
-| **Express** | Missing error middleware, no rate limiting, sync I/O in routes |
-| **FastAPI** | Missing response_model, sync endpoints, missing status codes |
-### Language-Specific Checks
-| Language | Scanners |
-|----------|----------|
-| Python | Cyclomatic complexity, type hints, imports, docstrings, code smells, security, class design |
-| Go | Complexity, ignored errors, panic usage, undocumented exports, init() |
-| Rust | Complexity, unsafe blocks, .unwrap() overuse, .clone() overuse, dead_code |
-| Java | Complexity, God classes, raw types, empty catches, System.out, naming |
-| C# | Complexity, God classes, #regions, async void, sync-over-async, empty catches |
-### Universal Features (All Languages)
-- File size analysis
-- TODO/FIXME detection
-- Git insights (churn, PR size, stale branches)
-- Security scans (secrets, .env in git, eval)
-- Test coverage gaps
-- Framework best practices (Next.js, React)
-Language detection is automatic! The tool detects your project's languages via package files and runs appropriate scanners.
+      - uses: rahuldk1105/roast-my-codebase@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+```
-## Design principles
+That's it. No secrets to configure. `GITHUB_TOKEN` is provided automatically by GitHub.
-1. **Real value** — Humor is the presentation layer. Analysis is the product.
-2. **Completely offline** — No APIs, no cloud, no telemetry, no data collection.
-3. **Fast** — Under 3 seconds for repos with < 1000 files.
-4. **Beautiful output** — Designed to be screenshot-worthy.
+**What the PR comment looks like:**
-## Health Score
+```
+## 🔥 Roast My Codebase — Health: 42/100 🔴
-Starts at 100. Deductions for:
+[████████████░░░░░░░░░░░░░░░░░░] 42/100
-| Issue | Deduction |
-|-------|-----------|
-| Large file (1000+ lines) | -3 |
-| Extreme file (2000+ lines) | -5 |
-| Circular dependency | -5 |
-| Unused dependency | -2 |
-| TODO/FIXME (per occurrence) | -0.25 |
-| Excessive total dependencies | -5 |
-| Deep nesting | -2 |
+| Metric | Value |
+|--------|-------|
+| Files  | 138   |
+| Lines  | 28k   |
+| Deps   | 54    |
-Grades:
-- **90–100** Excellent
-- **80–89** Good
-- **70–79** Fair
-- **60–69** Risky
-- **0–59** Chaotic
+🔴 3 critical  ⚠️ 18 warnings  ℹ️ 11 info
-## Viral / Shareable Features
+- 🔴 `src/auth/auth.service.ts` — cyclomatic complexity of 34
+- 🔴 `.env` is tracked in git — secrets may be exposed
+- ⚠️ `src/auth/auth.service.ts` is 1,847 lines
+- ⚠️ "lodash" appears unused — paying rent for no reason
-### ASCII Art Grade
-```bash
-roast-my-codebase --ascii
-```
-- Big, colorful letter grade at the top (A/B/C/D/F)
-- Perfect for screenshots and social media
-- Color-coded based on health score
+> 🔥 **src/auth/auth.service.ts**: Nobody: ... This file: *adds 200 more lines*
+> 🔥 **.env**: Little Bobby Tables visited your repo. He felt at home.
+> 🔥 **codebase**: The findings have formed a coalition.
-### SVG Badge Generation
-```bash
-roast-my-codebase --badge
-```
-- Generates `.roast-badge.svg` for your README
-- Shields.io-style badge showing "Health: 82/100"
-- Color-coded: green (90+), yellow-green (80+), yellow (70+), orange (60+), red (<60)
-- Embed in your README:
-  ```markdown
-  ![Codebase Health](.roast-badge.svg)
-  ```
-### Markdown Output
-```bash
-roast-my-codebase --markdown           # Output to stdout
-roast-my-codebase --markdown-file      # Save to .roast-report.md
+*Functional code with security issues is a solved problem waiting to be exploited.*
+Generated by roast-my-codebase
 ```
-- Beautiful markdown with collapsible sections
-- Perfect for GitHub PRs, Notion, and documentation
-- Includes emoji severity indicators (🔴/⚠️/ℹ️)
-- Tables for stats, blockquotes for roasts
-## Developer Experience Features
+**Optional: fail PRs below a score threshold**
-### JSON Output for CI/CD
-```bash
-roast-my-codebase --json --threshold 80
+```yaml
+- uses: rahuldk1105/roast-my-codebase@v1
+  with:
+    github-token: ${{ secrets.GITHUB_TOKEN }}
+    fail-below: "60"
 ```
-- Machine-readable output
-- Exit code 1 if score < threshold
-- Perfect for CI pipelines
-### Fix Suggestions
-```bash
-roast-my-codebase --fix
-```
-- Actionable one-liner fixes for each issue
-- Specific commands (e.g., `npm uninstall unused-package`)
-- Refactoring guidance
+**Optional: AI-powered roasts via Claude**
-### AI-Powered Roasts
-```bash
-roast-my-codebase --ai-roasts
+```yaml
+- uses: rahuldk1105/roast-my-codebase@v1
+  with:
+    github-token: ${{ secrets.GITHUB_TOKEN }}
+    ai-roasts: "true"
+    anthropic-api-key: ${{ secrets.ANTHROPIC_API_KEY }}
 ```
-- 🤖 Context-aware roasts generated by Claude AI
-- 🎯 Specific to your actual code issues
-- 😄 More witty and relevant than generic roasts
-- 💾 Cached for 7 days to minimize API costs
-- 🔒 Requires ANTHROPIC_API_KEY environment variable
-**Example comparison:**
-Generic roast:
-> "This file contains several geological layers."
+---
-AI-powered roast:
-> "This 1,847-line auth service is doing authentication, authorization, password reset, email verification, 2FA, and probably making coffee. Pick a lane."
+## Installation
-**Setup:**
 ```bash
-# Set API key
-export ANTHROPIC_API_KEY=your_key_here
+# Run without installing
+npx roast-my-codebase
-# Or configure in .roastrc.json
-{
-  "ai": {
-    "enabled": true,
-    "apiKey": "your_key_here",
-    "model": "claude-3-5-sonnet-20241022",
-    "cacheEnabled": true
-  }
-}
+# Install globally
+npm install -g roast-my-codebase
+roast-my-codebase
+# Scan a specific path
+roast-my-codebase ./path/to/project
 ```
-**Cost control:**
-- Only roasts top 10 most interesting findings
-- Caches roasts for 7 days
-- Cache stored in `.roast-ai-cache.json`
-- Typical cost: $0.01-0.05 per scan
+---
-### Interactive Mode
-```bash
-roast-my-codebase --interactive
-```
-- 🎯 Walk through issues one by one
-- 💡 See detailed explanations and fix suggestions
-- ✨ Apply automatic fixes where possible
-- ⚡ Preview changes with `--dry-run` flag
-- 🎨 Beautiful interactive UI
-**What can be auto-fixed:**
-- ✅ Remove unused dependencies (`npm uninstall`)
-- ✅ Add issue references to TODO comments
-- ✅ Remove dead exports
-- ✅ Add `'use client'` directive to Next.js components
-- ✅ Add missing metadata export to Next.js pages
-- ✅ Add `.env` files to `.gitignore`
-- ✅ Upgrade `@ts-ignore` to `@ts-expect-error`
-- ✅ Create skeleton test files for untested source files
-- ✅ Add secret files to `.gitignore`
-**Example session:**
-```
-🔧 Interactive Fix Mode
+## What gets analyzed
-Found 12 fixable issues.
+| Check | What it finds |
+|-------|--------------|
+| **File Size** | Files over 500 / 1000 / 2000 lines |
+| **Complexity** | Functions with cyclomatic complexity 15+ |
+| **TODOs** | TODO, FIXME, HACK, XXX comments |
+| **Dependencies** | Unused or excessive packages |
+| **Circular Deps** | Import cycles between modules |
+| **Duplicates** | Copy-pasted code blocks |
+| **Dead Exports** | Exports that are never imported |
+| **Type Safety** | `any`, `@ts-ignore`, type bypasses |
+| **Security** | Secrets in git, hardcoded credentials, eval usage |
+| **Test Coverage** | Source files with no corresponding tests |
+| **Git Insights** | High-churn files, large PRs, stale branches |
+| **Structure** | Deep nesting, utils explosion, bloated folders |
-Issue 1/12 - 🔴 Critical
-─────────────────────────────────────────
-Unused dependency `lodash` is installed but never imported
+---
-💡 Fix suggestion:
-  Remove unused dependency: lodash
+## Supported languages
-✓ This can be fixed automatically!
+**Full support:** JavaScript · TypeScript · Python · Go · Rust · Java · C# · Ruby · PHP · Swift · Kotlin
-? What would you like to do?
-❯ Apply fix automatically
-  Show details
-  Skip
-  Exit interactive mode
-```
+**Framework checks:** Next.js · React · Vue 3 · Angular · Svelte · Express · FastAPI
-### HTML Report
-```bash
-roast-my-codebase --html-file
-```
-- Saves `.roast-report.html` — a beautiful standalone HTML report
-- Dark theme, SVG health gauge, sortable findings table, severity chart
-- Fully self-contained (no CDN, works offline)
-- Perfect for sharing with the team
+Language detection is automatic — no config needed.
-# Incremental Scanning
-```bash
-roast-my-codebase --incremental      # Only changed files since last commit
-roast-my-codebase --since main       # Only files changed since branching from main
-```
-- Dramatically faster on large repos — only scans changed files
-- Global findings (circular deps, excessive dependencies) are always shown
-- Falls back to full scan if not in a git repository
+---
-# Watch Mode
-```bash
-roast-my-codebase --watch
-```
-- Re-runs on file changes
-- Shows score delta
-- Compact summaries for quick feedback
+## Health Score
-### Compare Branches
-```bash
-roast-my-codebase --compare main
-```
-- Diff current code vs. a git branch
-- Shows new issues introduced
-- Shows resolved issues
-- Score delta comparison
+Starts at 100. Deductions for real issues:
-### Historical Health Tracking
-```bash
-roast-my-codebase --track
-```
-- 📊 Track health score over time
-- 📈 See trends (improving/declining/stable)
-- 📉 Visual ASCII charts
-- 💾 Stores in `.roast-history.json` (gitignored)
-- ⏱️ Per-commit snapshots with git info
+| Issue | Points |
+|-------|--------|
+| Extreme file (2000+ lines) | −5 |
+| Circular dependency | −5 |
+| Critical security issue | −10 |
+| Large file (1000+ lines) | −3 |
+| Unused dependency | −2 |
+| Complex function | −2 |
+| TODO/FIXME (each) | −0.25 |
-**View history:**
-```bash
-roast-my-codebase --history        # Last 30 days
-roast-my-codebase --history 7      # Last 7 days
-roast-my-codebase --history 90     # Last 90 days
-```
+**Grades:** 90–100 Excellent · 80–89 Good · 70–79 Fair · 60–69 Risky · 0–59 Chaotic
-**What's tracked:**
-- Health score over time
-- Finding counts by severity
-- Category-level trends
-- Git commit information
-- Score improvement rate
+---
-**Example output:**
-```
-📊 Health History Report
-Project: my-app
-Total snapshots: 45
-Current Health
-  Score: 85/100 (B)
-  Findings: 12
-  ● 2 critical  ● 6 warnings  ● 4 info
-Trend Analysis (Last 30 days)
-  ↗ IMPROVING (+12 points)
-  Statistics:
-    Average score: 78.5/100
-    Best score: 85/100
-    Worst score: 68/100
-    Improvement rate: +0.4 points/day
-  Score Trend
-  100 ┤
-   90 ┤      ●●
-   80 ┤    ●●  ●
-   70 ┤  ●●
-   60 ┼──────────────→
-       Jan 1    Jan 30
-  Category Changes
-  ↓ Improving:
-    ✓ unused-dependencies: -5 issues
-    ✓ todos: -8 issues
-  ↑ Declining:
-    ✗ complexity: +2 issues
-```
+## All options
-**Use in CI:**
 ```bash
-# Track on every commit
-roast-my-codebase --track
-# Fail if declining trend
-roast-my-codebase --history 7 | grep -q "DECLINING" && exit 1
+# Output formats
+roast-my-codebase --json              # Machine-readable JSON
+roast-my-codebase --markdown          # Markdown to stdout
+roast-my-codebase --markdown-file     # Save to .roast-report.md
+roast-my-codebase --html-file         # Save to .roast-report.html
+roast-my-codebase --ascii             # Big ASCII art grade (screenshot-worthy)
+roast-my-codebase --badge             # Generate .roast-badge.svg for your README
+# CI/CD
+roast-my-codebase --json --threshold 80     # Exit code 1 if score < 80
+roast-my-codebase --pr-comment              # Post GitHub PR comment
+roast-my-codebase --init-ci                 # Drop a CI workflow into your repo
+# AI roasts
+roast-my-codebase --ai-roasts              # Claude-powered contextual roasts
+# Interactive
+roast-my-codebase --fix                    # Show fix suggestions
+roast-my-codebase --interactive            # Walk through and apply fixes
+roast-my-codebase --interactive --dry-run  # Preview fixes without applying
+# Scanning
+roast-my-codebase --incremental            # Only changed files since last commit
+roast-my-codebase --since main             # Only files changed since branching from main
+roast-my-codebase --watch                  # Re-run on file changes
+# History and comparison
+roast-my-codebase --track                  # Save score snapshot
+roast-my-codebase --history                # Show last 30 days
+roast-my-codebase --history 7              # Show last 7 days
+roast-my-codebase --compare main           # Diff against a branch
 ```
-## Customization
+---
-### Config File (`.roastrc.json`)
+## Configuration
-Create a `.roastrc.json` in your project root to customize behavior:
+Create `.roastrc.json` in your project root:
 ```json
 {
@@ -431,80 +260,69 @@ Create a `.roastrc.json` in your project root to customize behavior:
     "extremeFile": 3000
   },
   "scanners": {
-    "disabled": ["test-coverage", "framework"]
+    "disabled": ["test-coverage"]
   },
   "ignore": [
     "**/vendor/**",
     "**/generated/**"
   ],
   "deductions": {
-    "secret": -20,
-    "missingTest": -1
-  },
-  "plugins": [
-    "roast-plugin-graphql"
-  ]
+    "secret": -20
+  }
 }
 ```
-**See [CUSTOMIZATION.md](CUSTOMIZATION.md) for full documentation.**
+See [CUSTOMIZATION.md](CUSTOMIZATION.md) for the full config reference and plugin development guide.
-### Plugin Development
+---
-Create custom scanners as npm packages:
+## AI-Powered Roasts
-```javascript
-// roast-plugin-example/index.js
-export default {
-  name: "roast-plugin-example",
-  version: "1.0.0",
-  scanner: {
-    name: "example",
-    async scan(rootDir) {
-      const findings = [];
-      // Your scanner logic
-      return { findings };
-    }
-  }
-};
+```bash
+export ANTHROPIC_API_KEY=your_key_here
+npx roast-my-codebase --ai-roasts
 ```
-**See [CUSTOMIZATION.md](CUSTOMIZATION.md) for plugin development guide.**
+Uses Claude to generate context-aware roasts specific to your actual code. Cached for 7 days. Typical cost: $0.01–0.05 per scan.
+**Generic roast:** `"This file contains several geological layers."`
+**AI roast:** `"This 1,847-line auth service handles authentication, authorization, password reset, email verification, 2FA, and probably your taxes. Pick a lane."`
+---
 ## VS Code Extension
-Bring roast-my-codebase directly into your editor! The VS Code extension provides:
+Search **"Roast My Codebase"** in the VS Code marketplace for inline diagnostics, a live health score in the status bar, and findings in the Problems panel.
-- **Real-time analysis** with inline diagnostics
-- **Status bar widget** showing live health score
-- **Tree view panels** for browsing findings and stats
-- **Interactive HTML reports** in VS Code
-- **Badge generation** from the command palette
-- **Configurable** - reads `.roastrc.json` and VS Code settings
+---
-### Installation
+## Design principles
-1. Search for "Roast My Codebase" in VS Code Extensions marketplace
-2. Install the CLI: `npm install -g roast-my-codebase`
-3. Open any workspace and run: `Roast: Scan Workspace`
+1. **Real value** — humor is the presentation layer; analysis is the product
+2. **Zero config** — works on any codebase with no setup
+3. **Completely offline** — no telemetry, no data collection, no cloud
+4. **Fast** — under 3 seconds on repos with fewer than 1000 files
-See [vscode-extension/README.md](vscode-extension/README.md) for full documentation.
+---
 ## Contributing
-PRs welcome. The architecture is modular — each scanner is independent and easy to add to.
+PRs welcome. Each scanner is independent and easy to add to.
 ```
 src/
 ├── cli/          # Command setup
 ├── scanners/     # Modular analysis passes
 ├── scoring/      # Health score calculation
-├── roasts/       # Roast generation
-├── report/       # Terminal rendering
+├── roasts/       # Roast message pools
+├── report/       # Terminal + HTML rendering
 ├── types/        # Shared interfaces
 └── utils/        # Shared helpers
 ```
+---
 ## License
 MIT

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "roast-my-codebase",
-  "version": "1.3.5",
+  "version": "1.3.6",
   "description": "Get roasted. Get better. Ship faster. A CLI that analyzes your codebase and delivers brutally honest (but funny) feedback.",
   "type": "module",
   "main": "dist/index.js",