@optiprune/cli 1.2.7 → 1.2.9
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 +113 -0
- package/config.md +108 -0
- package/logo.svg +22 -0
- package/package.json +14 -3
package/README.md
ADDED
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
# 🚀 OptiPrune
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 💎 The Vision
|
|
9
|
+
Most dead-code analyzers just guess. They look at import graphs and hope they don't miss anything critical. This leads to **false positives**, broken builds, and developer frustration.
|
|
10
|
+
|
|
11
|
+
**OptiPrune is different.** We use formal logic, isolated execution, and a high-performance engine to not just find dead code, but to mathematically **prove** it.
|
|
12
|
+
|
|
13
|
+
> **"Stop Guessing, Start Proving."**
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## ⚡ The 3 Pillars of Superiority
|
|
18
|
+
|
|
19
|
+
### 1. Raw Power: The Yuku Engine (Zig)
|
|
20
|
+
While other tools are throttled by the N-API bottleneck, OptiPrune utilizes the **Yuku Engine** written in **Zig**. It minimizes the overhead between native performance and the JavaScript runtime.
|
|
21
|
+
* **The Result:** Up to 3x faster parsing than traditional tools, even in massive monorepos.
|
|
22
|
+
|
|
23
|
+
### 2. Deep Intelligence: SMT & Z3 Solver
|
|
24
|
+
OptiPrune is the first analyzer to use a real **SMT Solver (Z3)**. We don't just analyze if a function is exported; we analyze if the code *inside* the function is logically reachable.
|
|
25
|
+
* **The Result:** Detects dead logic paths (e.g., impossible `if` conditions) that are completely invisible to Knip.
|
|
26
|
+
|
|
27
|
+
### 3. Absolute Precision: WASM Sandbox Execution
|
|
28
|
+
Dynamic imports are the final boss of static analysis. OptiPrune solves this through a **WASM-based QuickJS sandbox**. We securely execute critical code snippets to resolve paths at runtime.
|
|
29
|
+
* **The Result:** Zero false alarms for dynamic paths. If OptiPrune says it's dead, it's dead.
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## 🥊 OptiPrune vs. Knip: The Head-to-Head
|
|
34
|
+
|
|
35
|
+
| Feature | Knip | OptiPrune |
|
|
36
|
+
| :--- | :--- | :--- |
|
|
37
|
+
| **Engine** | Babel / OXC (Standard) | **Yuku / Zig (Hyper-Speed)** |
|
|
38
|
+
| **Logic Analysis** | Heuristics (Guessing) | **Z3 SMT Solver (Proving)** |
|
|
39
|
+
| **Dynamic Paths** | Pattern Matching | **WASM Sandbox Execution** |
|
|
40
|
+
| **Interface Audit** | Ignores Members | **Deep Member-Level Analysis** |
|
|
41
|
+
| **Framework Support** | Plugins (Core-Level) | **7-Layer Semantic Context** |
|
|
42
|
+
| **False Positives** | High (in complex setups) | **Near-Zero (Context Aware)** |
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## 🏗️ The 7-Layer Architecture
|
|
47
|
+
OptiPrune operates in seven specialized layers to guarantee maximum accuracy:
|
|
48
|
+
|
|
49
|
+
1. **Layer 1: Discovery** – Ultra-fast file scanning.
|
|
50
|
+
2. **Layer 2: Basic CFG** – Detects standard dead code after terminal statements.
|
|
51
|
+
3. **Layer 3: SMT Logic** – Mathematical path proofs with Z3.
|
|
52
|
+
4. **Layer 4: WASM Sandbox** – Dynamic path resolution via execution.
|
|
53
|
+
5. **Layer 6: Schema Shield** – Protection for Zod, Decorators & Contracts.
|
|
54
|
+
6. **Layer 6: Dependency Audit** – Scans lockfiles & package.json scripts.
|
|
55
|
+
7. **Layer 7: Topology Engine** – Understands NestJS DI & Event Buses.
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## 📈 Benchmark Numbers (Real-World Test)
|
|
60
|
+
*Tested on a NestJS project with 1000+ files.*
|
|
61
|
+
|
|
62
|
+
* **Knip Speed:** 1.26s (with crash risks on complex types)
|
|
63
|
+
* **OptiPrune Speed:** **0.87s** (Stable & Precise)
|
|
64
|
+
* **Accuracy:** OptiPrune found **15% more** real dead code (unused interface properties & logical errors) that Knip completely missed.
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## Installation
|
|
69
|
+
|
|
70
|
+
Install Optiprune as a dev dependency via pnpm, npm, or yarn:
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
pnpm add -D @optiprune/core
|
|
74
|
+
# or
|
|
75
|
+
npm install --save-dev @optiprune/core
|
|
76
|
+
# or
|
|
77
|
+
yarn add -D @optiprune/core
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Usage
|
|
82
|
+
|
|
83
|
+
Run Optiprune from your project root:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
npx @optiprune/cli
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### CLI Options (@optiprune/cli)
|
|
90
|
+
|
|
91
|
+
| Flag | Description | Default |
|
|
92
|
+
| :--- | :--- | :--- |
|
|
93
|
+
| `-r, --rootDir` | Project root directory | `process.cwd()` |
|
|
94
|
+
| `-e, --entry` | Entry point patterns (glob) | `[]` |
|
|
95
|
+
| `-i, --ignore` | Patterns to ignore | `[]` |
|
|
96
|
+
| `--no-report-unused-exports` | Disable unused export reporting | `false` |
|
|
97
|
+
| `--fail-on` | Fail on confidence (high/medium/low/none) | `high` |
|
|
98
|
+
| `--json` | Output as JSON | `false` |
|
|
99
|
+
| `--sarif` | Output as SARIF | `false` |
|
|
100
|
+
| `--skip-3` | Skip Layer 3 (SMT Constraint Solver) | `false` |
|
|
101
|
+
| `--skip-4` | Skip Layer 4 (Concolic Execution Proofs) | `false` |
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## 🤝 Join the Revolution
|
|
106
|
+
OptiPrune isn't just a tool. It's a technical statement. Help us save the world from dirty code.
|
|
107
|
+
|
|
108
|
+
**GitHub:** [DreamLongYT/optiprune](https://github.com/optiprune/core)
|
|
109
|
+
**Web:** [opti.drml.int.yt](https://opti.drml.int.yt)
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
# Config
|
|
113
|
+
To setup OptiPrune, see [config.md](config.md) for more
|
package/config.md
ADDED
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
# OptiPrune Configuration Example
|
|
2
|
+
|
|
3
|
+
Here is an example of an `optiprune.config.ts` based on the type definitions from the `@optiprune/core` package. This file allows you to customize analyzer behavior, engine parameters, and rule severity levels.
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { defineConfig } from '@optiprune/core';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* OptiPrune Configuration File
|
|
10
|
+
*
|
|
11
|
+
* This file is automatically detected by the CLI when placed
|
|
12
|
+
* in the root directory of your project.
|
|
13
|
+
*/
|
|
14
|
+
export default defineConfig({
|
|
15
|
+
// --- Base Options ---
|
|
16
|
+
|
|
17
|
+
// The root directory of the project (default: current working directory)
|
|
18
|
+
rootDir: '.',
|
|
19
|
+
|
|
20
|
+
// Entry points for analysis. Define the files here from which
|
|
21
|
+
// code reachability will be checked.
|
|
22
|
+
entry: [
|
|
23
|
+
'src/main.ts',
|
|
24
|
+
'src/api/server.ts'
|
|
25
|
+
],
|
|
26
|
+
|
|
27
|
+
// File extensions to scan
|
|
28
|
+
extensions: ['.ts', '.tsx', '.js', '.jsx', '.mjs'],
|
|
29
|
+
|
|
30
|
+
// Glob patterns for files or directories that should be ignored
|
|
31
|
+
ignore: [
|
|
32
|
+
'**/node_modules/**',
|
|
33
|
+
'**/dist/**',
|
|
34
|
+
'**/build/**',
|
|
35
|
+
'**/coverage/**',
|
|
36
|
+
'**/*.test.ts',
|
|
37
|
+
'**/*.spec.ts',
|
|
38
|
+
'**/test/fixtures/**'
|
|
39
|
+
],
|
|
40
|
+
|
|
41
|
+
// --- Analysis Behavior ---
|
|
42
|
+
|
|
43
|
+
// Symbols considered "externally consumed" (e.g., public APIs).
|
|
44
|
+
// These will not be flagged as unused, even if no internal import exists.
|
|
45
|
+
externalContracts: [
|
|
46
|
+
'handleRequest',
|
|
47
|
+
'PluginInterface'
|
|
48
|
+
],
|
|
49
|
+
|
|
50
|
+
// Whether unused exports (functions, classes, types) should be reported
|
|
51
|
+
reportUnusedExports: true,
|
|
52
|
+
|
|
53
|
+
// Whether conventional entry points (like index.ts, main.ts)
|
|
54
|
+
// should automatically be included in the analysis.
|
|
55
|
+
includeConventionalEntries: true,
|
|
56
|
+
|
|
57
|
+
// Failure threshold for the process (exit code 1).
|
|
58
|
+
// Possible values: "high" | "medium" | "low" | "info" | "none"
|
|
59
|
+
failOn: 'high',
|
|
60
|
+
|
|
61
|
+
// --- Engine Layer (Advanced) ---
|
|
62
|
+
|
|
63
|
+
layers: {
|
|
64
|
+
// Timeout for the Z3 SMT solver in milliseconds
|
|
65
|
+
smtTimeoutMs: 5000,
|
|
66
|
+
|
|
67
|
+
// Memory limit for the WASM-based QuickJS sandbox in MB
|
|
68
|
+
isolateMemoryLimitMb: 128,
|
|
69
|
+
|
|
70
|
+
// Enables concolic execution to mathematically prove code path reachability
|
|
71
|
+
// (prevents false positives).
|
|
72
|
+
enableConcolicProof: true,
|
|
73
|
+
|
|
74
|
+
// Skips specific analysis layers (recommended for debugging only)
|
|
75
|
+
skip3: false, // Symbol Propagation
|
|
76
|
+
skip4: false // Concolic Execution
|
|
77
|
+
},
|
|
78
|
+
|
|
79
|
+
// --- Rule Configuration ---
|
|
80
|
+
|
|
81
|
+
// Override severity levels for specific findings.
|
|
82
|
+
// Possible values: "error" | "warning" | "off"
|
|
83
|
+
rules: {
|
|
84
|
+
'unused-dependency': 'warning',
|
|
85
|
+
'unused-dev-dependency': 'info',
|
|
86
|
+
'missing-dependency': 'error',
|
|
87
|
+
'unreachable-file': 'error',
|
|
88
|
+
'unused-export': 'warning',
|
|
89
|
+
'unused-member': 'info',
|
|
90
|
+
'constant-condition': 'off',
|
|
91
|
+
'unresolved-import': 'error'
|
|
92
|
+
},
|
|
93
|
+
|
|
94
|
+
// --- Output ---
|
|
95
|
+
|
|
96
|
+
// Detailed log output for debugging
|
|
97
|
+
verbose: false,
|
|
98
|
+
|
|
99
|
+
// Output results in JSON format
|
|
100
|
+
json: false
|
|
101
|
+
});
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## Usage
|
|
105
|
+
|
|
106
|
+
1. Ensure `@optiprune/core` is installed in your project.
|
|
107
|
+
2. Create the `optiprune.config.ts` file in your root directory.
|
|
108
|
+
3. Run `optiprune` from your terminal. The analyzer will load the configuration automatically.
|
package/logo.svg
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" style="width:100%;height:100%">
|
|
2
|
+
<defs>
|
|
3
|
+
<linearGradient id="opti-grad-1" x1="0%" y1="0%" x2="100%" y2="100%">
|
|
4
|
+
<stop offset="0%" stop-color="#6366F1"></stop>
|
|
5
|
+
<stop offset="50%" stop-color="#8B5CF6"></stop>
|
|
6
|
+
<stop offset="100%" stop-color="#D946EF"></stop>
|
|
7
|
+
</linearGradient>
|
|
8
|
+
<linearGradient id="opti-grad-2" x1="0%" y1="100%" x2="100%" y2="0%">
|
|
9
|
+
<stop offset="0%" stop-color="#06B6D4"></stop>
|
|
10
|
+
<stop offset="100%" stop-color="#3B82F6"></stop>
|
|
11
|
+
</linearGradient>
|
|
12
|
+
<filter id="glow" x="-20%" y="-20%" width="140%" height="140%">
|
|
13
|
+
<feDropShadow dx="0" dy="8" stdDeviation="16" flood-color="#8B5CF6" flood-opacity="0.35"></feDropShadow>
|
|
14
|
+
</filter>
|
|
15
|
+
</defs>
|
|
16
|
+
<g filter="url(#glow)">
|
|
17
|
+
<path d="M 256 64 C 362 64, 448 150, 448 256 C 448 290, 439 322, 423 350 L 340 267 C 352 240, 345 208, 321 184 C 297 160, 265 153, 238 165 L 155 82 C 185 70, 220 64, 256 64 Z" fill="url(#opti-grad-1)"></path>
|
|
18
|
+
<path d="M 256 448 C 150 448, 64 362, 64 256 C 64 222, 73 190, 89 162 L 172 245 C 160 272, 167 304, 191 328 C 215 352, 247 359, 274 347 L 357 430 C 327 442, 292 448, 256 448 Z" fill="url(#opti-grad-1)"></path>
|
|
19
|
+
<polygon points="110,410 410,110 380,80 80,380" fill="url(#opti-grad-2)" opacity="0.9"></polygon>
|
|
20
|
+
</g>
|
|
21
|
+
<circle cx="256" cy="256" r="28" fill="#FFFFFF" opacity="0.95"></circle>
|
|
22
|
+
</svg>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@optiprune/cli",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.9",
|
|
4
4
|
"description": "CLI for resilient static dead-code analyzer for TypeScript and JavaScript workspaces.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -59,10 +59,21 @@
|
|
|
59
59
|
"files": [
|
|
60
60
|
"dist",
|
|
61
61
|
"README.md",
|
|
62
|
-
"LICENSE"
|
|
62
|
+
"LICENSE",
|
|
63
|
+
"config.md",
|
|
64
|
+
"package.json",
|
|
65
|
+
"logo.svg"
|
|
63
66
|
],
|
|
67
|
+
"exports": {
|
|
68
|
+
".": "./dist/cli.js",
|
|
69
|
+
"./package.json": "./package.json"
|
|
70
|
+
},
|
|
71
|
+
"exports": {
|
|
72
|
+
".": "./dist/cli.js",
|
|
73
|
+
"./package.json": "./package.json"
|
|
74
|
+
},
|
|
64
75
|
"dependencies": {
|
|
65
|
-
"@optiprune/core": "
|
|
76
|
+
"@optiprune/core": "^1.8.28",
|
|
66
77
|
"commander": "^15.0.0",
|
|
67
78
|
"pathe": "2.0.3"
|
|
68
79
|
},
|