pruny 1.37.0 → 1.38.0

package/README.md

@@ -1,6 +1,8 @@
 # pruny
 
-Find and remove unused Next.js API routes & Nest.js Controllers. 🪓
+Find and remove unused code in Next.js and NestJS projects.
+
+Pruny scans your codebase using regex-based static analysis to detect unused API routes, page links, exports, files, public assets, and NestJS service methods. Works with monorepos out of the box.
 
 ## Install
 
@@ -10,67 +12,153 @@ npm install -g pruny
 npx pruny
 ```
 
-## Usage
+## What It Detects
+
+| Scanner | What it finds |
+| :------ | :------------ |
+| **API Routes** | Unused Next.js `route.ts` handlers and NestJS controller methods |
+| **Broken Links** | `<Link>`, `router.push()`, `redirect()` pointing to pages that don't exist |
+| **Unused Exports** | Named exports and class methods not imported anywhere |
+| **Unused Files** | Source files not reachable from any entry point |
+| **Unused Services** | NestJS service methods never called by controllers or other services |
+| **Public Assets** | Images/files in `public/` not referenced in code |
+| **Source Assets** | Media files in `src/` not referenced in code |
+| **Missing Assets** | References to files in `public/` that don't exist |
 
 ## CLI Commands
 
-| Command                      | Description                                                                              |
-| :--------------------------- | :--------------------------------------------------------------------------------------- |
-| `pruny`                      | Scan for unused items interactively (monorepo-aware).                                    |
-| `pruny --dir <path>`         | Set the target project directory (default: `./`).                                        |
-| `pruny --app <name>`         | Scan a specific application within a monorepo.                                           |
-| `pruny --folder <path>`      | Scan a specific folder OR sub-directory for routes/controllers.                          |
-| `pruny --fix`                | Automatically delete unused items found during scan.                                     |
-| `pruny --cleanup <items>`    | Quick cleanup: `routes`, `exports`, `public`, `files`. (e.g. `--cleanup routes,exports`) |
-| `pruny --filter <pattern>`   | Filter results by string (app name, file path, etc).                                     |
-| `pruny --ignore-apps <list>` | Comma-separated list of apps to skip in monorepos.                                       |
-| `pruny --no-public`          | Disable scanning of public assets.                                                       |
-| `pruny --json`               | Output scan results as JSON for automation.                                              |
-| `pruny -v, --verbose`        | Show detailed debug logging and trace info.                                              |
-| `pruny init`                 | Create a `pruny.config.json` configuration file.                                         |
+| Command | Description |
+| :------ | :---------- |
+| `pruny` | Interactive scan (auto-detects monorepo apps) |
+| `pruny --all` | CI mode: scan all apps, exit 1 if issues found |
+| `pruny --fix` | Interactively delete unused items |
+| `pruny --dry-run` | Simulate fix mode and output a JSON report |
+| `pruny --app <name>` | Scan a specific app in a monorepo |
+| `pruny --folder <path>` | Scan a specific folder for routes/controllers |
+| `pruny --cleanup <items>` | Quick cleanup: `routes`, `exports`, `public`, `files` |
+| `pruny --filter <pattern>` | Filter results by path or app name |
+| `pruny --ignore-apps <list>` | Skip specific apps (comma-separated) |
+| `pruny --no-public` | Skip public asset scanning |
+| `pruny --json` | Output results as JSON |
+| `pruny -v, --verbose` | Verbose debug logging |
+| `pruny --dir <path>` | Set target directory (default: `./`) |
+| `pruny -c, --config <path>` | Path to config file |
+| `pruny init` | Generate a `pruny.config.json` with defaults |
+
+## Configuration
+
+Create `pruny.config.json` in your project root (or run `pruny init`):
+
+```json
+{
+  "ignore": {
+    "routes": ["/api/webhooks/**", "/api/cron/**"],
+    "folders": ["node_modules", ".next", "dist"],
+    "files": ["*.test.ts", "*.spec.ts"],
+    "links": ["/custom-path", "/legacy/*"]
+  },
+  "extensions": [".ts", ".tsx", ".js", ".jsx"]
+}
+```
+
+### Ignore Options
+
+| Key | What it does | Example |
+| :-- | :----------- | :------ |
+| `ignore.routes` | Skip API routes matching these patterns | `["/api/webhooks/**"]` |
+| `ignore.folders` | Exclude directories from scanning | `["node_modules", "dist"]` |
+| `ignore.files` | Exclude specific files from scanning | `["*.test.ts"]` |
+| `ignore.links` | Suppress broken link warnings for these paths | `["/view_seat", "/admin/*"]` |
+
+All patterns support glob syntax (`*` matches any characters, `**` matches nested paths).
+
+Pruny also reads `.gitignore` and automatically excludes those folders.
+
+### Additional Config Options
+
+| Key | What it does |
+| :-- | :----------- |
+| `nestGlobalPrefix` | NestJS global route prefix (e.g., `"api/v1"`) |
+| `extraRoutePatterns` | Additional glob patterns to detect route files |
+| `excludePublic` | Set `true` to skip public asset scanning |
 
-### Public Asset Scanning (New in v1.1.0)
+### Config File Locations
 
-Pruny automatically scans your `public/` directory for unused images and files.
+Pruny searches for config files recursively across your project:
+- `pruny.config.json`
+- `.prunyrc.json`
+- `.prunyrc`
 
-- **Enabled by default**: Run `npx pruny` and it will show unused assets, excluding ignored folders.
-- **Disable it**: Use `--no-public` flag.
-  ```bash
-  pruny --no-public
-  ```
-- **How it works**: It checks if filenames in `public/` (e.g., `logo.png` or `/images/logo.png`) are referenced in your code.
+In monorepos, configs from multiple apps are merged together. CLI `--config` takes precedence.
 
-## Config
+## Multi-Tenant / Subdomain Routing
 
-Create `pruny.config.json` (optional):
+Pruny automatically handles multi-tenant architectures where routes live under dynamic segments like `[domain]`.
+
+For example, if your file structure is:
+```
+app/(code)/tenant_sites/[domain]/view_seat/page.tsx
+```
+
+And your components reference `/view_seat` (resolved at runtime via subdomain), Pruny recognizes this as a valid route and will **not** report it as a broken link.
+
+If auto-detection doesn't cover your case, use `ignore.links` in config:
 
 ```json
 {
-  "dir": "./",
   "ignore": {
-    "routes": ["/api/webhooks/**", "/api/cron/**"],
-    "folders": ["node_modules", ".next", "dist"],
-    "files": ["*.test.ts", "*.spec.ts"]
-  },
-  "extensions": [".ts", ".tsx", ".js", ".jsx"]
+    "links": ["/view_seat", "/review", "/custom-path"]
+  }
 }
 ```
 
-## Features
+## Monorepo Support
+
+Pruny auto-detects monorepos by looking for an `apps/` directory. It scans each app independently but checks references across the entire monorepo root.
+
+```bash
+# Scan all apps (CI-friendly, exits 1 on issues)
+pruny --all
+
+# Scan a specific app
+pruny --app web
+
+# Skip certain apps
+pruny --ignore-apps admin,docs
+```
+
+## CI Integration
 
-- 🔍 Detects unused Next.js API routes & Nest.js Controller methods
-- 🗑️ `--fix` flag to delete unused routes
-- ⚡ Auto-detects `vercel.json` cron routes
-- 📁 Default ignores: `node_modules`, `.next`, `dist`, `.git`
-- 🎨 Beautiful CLI output
+Add to your CI pipeline to catch unused code before merging:
 
-## How it works
+```bash
+npx pruny --all
+```
+
+This scans all monorepo apps and exits with code 1 if any issues are found. Combine with `--json` for machine-readable output.
+
+## How It Works
+
+1. **Route Detection**: Finds all `app/api/**/route.ts` (Next.js) and `*.controller.ts` (NestJS) files
+2. **Link Detection**: Finds `<Link>`, `router.push()`, `redirect()`, `href:` patterns and validates against known page routes
+3. **Reference Scanning**: Searches the entire codebase for string references to routes, exports, and assets
+4. **Dynamic Route Matching**: Understands `[id]`, `[...slug]`, `[[...slug]]` dynamic segments
+5. **Fix Mode**: Removes unused methods, exports, and files with a cascading second pass to catch newly dead code
+
+### Vercel Cron Detection
+
+Routes listed in `vercel.json` cron jobs are automatically marked as used:
+```json
+{ "crons": [{ "path": "/api/cron/cleanup", "schedule": "0 0 * * *" }] }
+```
+
+## Debug Mode
+
+```bash
+DEBUG_PRUNY=1 pruny
+```
 
-1. **Next.js**: Finds all `app/api/**/route.ts` files.
-2. **Nest.js**: Finds all `*.controller.ts` files and extracts mapped routes (e.g., `@Get('users')`).
-3. Scans codebase for client-side usages (e.g., `fetch`, `axios`, or string literals matching the route).
-4. Reports routes with no detected references.
-5. `--fix` deletes the unused route file or method.
+Enables verbose logging across all scanners.
 
 ## License
 

package/dist/index.js

@@ -15791,9 +15791,21 @@ function matchesRoute(refPath, routes, routeSegments) {
   for (const routeSeg of routeSegments) {
     if (matchSegments(refSegments, routeSeg))
       return true;
+    if (matchesDynamicSuffix(refSegments, routeSeg))
+      return true;
   }
   return false;
 }
+function matchesDynamicSuffix(refSegments, routeSegments) {
+  if (refSegments.length >= routeSegments.length)
+    return false;
+  const prefixLen = routeSegments.length - refSegments.length;
+  const prefix = routeSegments.slice(0, prefixLen);
+  if (!prefix.some((s) => /^\[.+\]$/.test(s)))
+    return false;
+  const tail = routeSegments.slice(prefixLen);
+  return matchSegments(refSegments, tail);
+}
 function matchSegments(refSegments, routeSegments) {
   let ri = 0;
   let si = 0;
@@ -15868,7 +15880,11 @@ async function scanBrokenLinks(config) {
           if (!cleaned || cleaned === "/")
             continue;
           if (!matchesRoute(cleaned, knownRoutes, routeSegmentsList)) {
-            const isIgnored = config.ignore.routes.some((ignorePath) => {
+            const ignorePatterns = [
+              ...config.ignore.links || [],
+              ...config.ignore.routes
+            ];
+            const isIgnored = ignorePatterns.some((ignorePath) => {
               const pattern2 = ignorePath.replace(/\*/g, ".*");
               return new RegExp(`^${pattern2}$`).test(cleaned);
             });
@@ -16263,7 +16279,8 @@ var DEFAULT_CONFIG = {
       "**/.git/**",
       "**/coverage/**"
     ],
-    files: []
+    files: [],
+    links: []
   },
   extensions: [".ts", ".tsx", ".js", ".jsx"],
   nestGlobalPrefix: "",
@@ -16289,7 +16306,8 @@ function loadConfig(options) {
   const mergedIgnore = {
     routes: [...DEFAULT_CONFIG.ignore.routes || []],
     folders: [...DEFAULT_CONFIG.ignore.folders || []],
-    files: [...DEFAULT_CONFIG.ignore.files || []]
+    files: [...DEFAULT_CONFIG.ignore.files || []],
+    links: [...DEFAULT_CONFIG.ignore.links || []]
   };
   let mergedExtensions = [...DEFAULT_CONFIG.extensions];
   let nestGlobalPrefix = DEFAULT_CONFIG.nestGlobalPrefix;
@@ -16313,6 +16331,8 @@ function loadConfig(options) {
         mergedIgnore.folders.push(...config.ignore.folders.map(prefixPattern));
       if (config.ignore?.files)
         mergedIgnore.files.push(...config.ignore.files.map(prefixPattern));
+      if (config.ignore?.links)
+        mergedIgnore.links.push(...config.ignore.links);
       if (config.extensions)
         mergedExtensions = [...new Set([...mergedExtensions, ...config.extensions])];
       if (config.nestGlobalPrefix)
@@ -16330,6 +16350,7 @@ function loadConfig(options) {
   mergedIgnore.routes = [...new Set(mergedIgnore.routes)];
   mergedIgnore.folders = [...new Set(mergedIgnore.folders)];
   mergedIgnore.files = [...new Set(mergedIgnore.files)];
+  mergedIgnore.links = [...new Set(mergedIgnore.links)];
   return {
     dir: cwd,
     ignore: mergedIgnore,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pruny",
-  "version": "1.37.0",
+  "version": "1.38.0",
   "description": "Find and remove unused Next.js API routes & Nest.js Controllers",
   "type": "module",
   "files": [