pruneguard 0.6.1 → 0.6.3

package/README.md

@@ -5,12 +5,59 @@
 [![npm version](https://img.shields.io/npm/v/pruneguard)](https://www.npmjs.com/package/pruneguard)
 [![license](https://img.shields.io/npm/l/pruneguard)](https://github.com/ferc/pruneguard/blob/main/LICENSE)
 
+Built on [oxc](https://oxc.rs), pruneguard scans a 5,000+ file repository in under 6 seconds cold, and delivers sub-millisecond responses with the warm daemon. That is 10-50x faster than JS-based alternatives -- fast enough for an AI agent to call on every single code change.
+
+---
+
+## Use with AI agents
+
+pruneguard was designed for AI agents: every command produces structured JSON, findings carry confidence scores, and remediation plans contain step-by-step instructions agents can execute directly. Because it runs in milliseconds, your agent can call it after every code change -- something that is impractical with slower JS-based tools.
+
+### Prompt: find and remove dead code
+
+Copy-paste this into your agent configuration (`CLAUDE.md`, `.cursorrules`, Copilot instructions, etc.):
+
+````markdown
+When asked to clean up dead code, or after making significant refactoring
+changes, run `npx pruneguard --format json scan` to detect unused exports,
+dead files, and phantom dependencies. For each finding with high confidence,
+run `npx pruneguard --format json safe-delete <target>` to confirm it is safe
+to remove. Only delete targets that pruneguard marks as safe. Follow the
+deletionOrder array when removing multiple files. After all deletions, re-run
+the scan with --no-cache to verify no new issues were introduced. Do not
+delete anything with low confidence without asking the user first.
+````
+
+### Prompt: set up pruneguard and guard against new dead code
+
+````markdown
+Add pruneguard as a dev dependency and configure it to catch dead code on
+every change:
+
+1. Run `npm install -D pruneguard` (or the equivalent for the project's
+   package manager).
+2. Add these scripts to package.json:
+   - "review": "pruneguard --changed-since origin/main"
+   - "scan": "pruneguard scan"
+   - "prune:check": "pruneguard --changed-since origin/main --format json"
+3. Run `npx pruneguard init` to generate pruneguard.json with schema
+   reference.
+4. If the project uses CI (GitHub Actions), add a step that runs
+   `npx pruneguard --changed-since origin/main --format json` on pull
+   requests to block PRs that introduce new dead code.
+
+pruneguard is a compiled Rust binary -- scanning takes milliseconds with the
+warm daemon, so it adds no meaningful overhead to the development workflow or
+CI pipeline.
+````
+
 ---
 
 ## Install
 
 ```sh
-npm install -D pruneguard   # or: npx pruneguard scan
+npx pruneguard            # zero-install, scan your repo right now
+npm install -D pruneguard # or add it as a dev dependency
 ```
 
 The package automatically installs the correct platform-specific native binary. No Rust toolchain, no compilation, no native addons -- just `npm install` and go.
@@ -381,6 +428,22 @@ Override with `"frameworks": { "next": "off" }` in config.
 
 ---
 
+## Performance
+
+pruneguard is a compiled Rust binary powered by [oxc](https://oxc.rs) for parsing and module resolution. No V8 or Node.js runtime is on the hot path.
+
+| Scenario | Latency |
+|---|---|
+| Warm daemon (`review`, `impact`, `explain`) on a small repo | < 10 ms |
+| Warm daemon on a medium repo (1,000-2,000 files) | < 50 ms |
+| Warm daemon on a large repo (5,000+ files) | < 150 ms |
+| Cold one-shot scan, medium repo | < 2 s |
+| Cold one-shot scan, 5,000+ file repo | < 6 s |
+
+JS-based alternatives typically take 30-60 seconds on the same large repositories -- making them too slow for an AI agent to call on every code change or for a tight inner development loop. pruneguard's speed means you can treat dead-code detection as a routine check rather than a scheduled chore.
+
+---
+
 ## Requirements
 
 - Node.js >= 18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pruneguard",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "Repo truth engine for JS/TS monorepos",
   "keywords": [
     "javascript",
@@ -45,14 +45,14 @@
     }
   },
   "optionalDependencies": {
-    "@pruneguard/cli-darwin-arm64": "0.6.1",
-    "@pruneguard/cli-darwin-x64": "0.6.1",
-    "@pruneguard/cli-linux-arm64-gnu": "0.6.1",
-    "@pruneguard/cli-linux-arm64-musl": "0.6.1",
-    "@pruneguard/cli-linux-x64-gnu": "0.6.1",
-    "@pruneguard/cli-linux-x64-musl": "0.6.1",
-    "@pruneguard/cli-win32-arm64-msvc": "0.6.1",
-    "@pruneguard/cli-win32-x64-msvc": "0.6.1"
+    "@pruneguard/cli-darwin-arm64": "0.6.3",
+    "@pruneguard/cli-darwin-x64": "0.6.3",
+    "@pruneguard/cli-linux-arm64-gnu": "0.6.3",
+    "@pruneguard/cli-linux-arm64-musl": "0.6.3",
+    "@pruneguard/cli-linux-x64-gnu": "0.6.3",
+    "@pruneguard/cli-linux-x64-musl": "0.6.3",
+    "@pruneguard/cli-win32-arm64-msvc": "0.6.3",
+    "@pruneguard/cli-win32-x64-msvc": "0.6.3"
   },
   "engines": {
     "node": ">=18.0.0"

package/report_schema.json

@@ -646,6 +646,20 @@
           "enum": [
             "duplicate-export"
           ]
+        },
+        {
+          "description": "A dependency is imported in source code but not declared in package.json.",
+          "type": "string",
+          "enum": [
+            "unlisted-dependency"
+          ]
+        },
+        {
+          "description": "An exported type (interface or type alias) is unused.",
+          "type": "string",
+          "enum": [
+            "unused-type"
+          ]
         }
       ]
     },

package/review_report_schema.json

@@ -350,6 +350,20 @@
           "enum": [
             "duplicate-export"
           ]
+        },
+        {
+          "description": "A dependency is imported in source code but not declared in package.json.",
+          "type": "string",
+          "enum": [
+            "unlisted-dependency"
+          ]
+        },
+        {
+          "description": "An exported type (interface or type alias) is unused.",
+          "type": "string",
+          "enum": [
+            "unused-type"
+          ]
         }
       ]
     },