@alimaandev/ripple 0.1.0 → 0.2.0

package/README.md

@@ -1,6 +1,6 @@
 <div align="center">
 
-  <img src="assets/ripple-logo.png" alt="Ripple" width="120" />
+  <img src="https://raw.githubusercontent.com/alimaandev/ripple/main/assets/ripple-logo.png" alt="Ripple" width="120" />
 
 # Ripple
 
@@ -16,7 +16,9 @@ Change less. Break less. Know the blast radius of any file before you touch it.
     &nbsp;<a href="package.json"><img alt="Node.js >= 22" src="https://img.shields.io/badge/Node.js-%3E%3D22-339933?logo=nodedotjs&logoColor=white&style=for-the-badge"/></a>&nbsp;
   </p>
 
-  <img src="assets/hero.svg" alt="Terminal output of `ripple analyze` — risk, affected files, routes, components, tests, and confidence score" title="ripple analyze" width="100%" />
+  <pre><code>npm install -g @alimaandev/ripple</code></pre>
+
+  <img src="https://raw.githubusercontent.com/alimaandev/ripple/main/assets/hero.svg" alt="Terminal output of `ripple analyze` — risk, affected files, routes, components, tests, and confidence score" title="ripple analyze" width="100%" />
 
 </div>
 
@@ -42,13 +44,12 @@ exactly how a change propagates through your codebase:
 ```text
 $ ripple analyze src/authentication/login.ts
 
-Risk            MEDIUM
-Affected Files  7 files
-API Routes      4
-Components      2
-Tests           1
-Max Depth       2
-Confidence      100%
+File        src/authentication/login.ts
+Risk        MEDIUM · 34.7/100 ███░░░░░░░
+Impact      4 routes · 2 components · 1 test
+Affected    7 files
+Max depth   2
+Confidence  100%
 ```
 
 No black box.
@@ -92,7 +93,7 @@ Everything below is real output against a shipped example project in `tests/fixt
 ```bash
 npm install -g @alimaandev/ripple
 
-ripple version                  # → 0.1.0
+ripple version                  # → 0.1.1
 ```
 
 Or install from source:
@@ -115,30 +116,32 @@ ripple analyze src/authentication/login.ts
 Expected output:
 
 ```text
-🌊 Ripple Analysis
-
-File            src/authentication/login.ts
-Risk            MEDIUM
-Affected Files  7 files
-Components      2
-API Routes      4
-Tests           1
-Utilities       0
-Max Depth       2
-Confidence      100%
-
-Top Impact
-• Dashboard (2)
-• Admin (1)
-• Index TS (1)
-
-Circular Dependencies
-⭕ src/circular/a.ts → src/circular/c.ts → src/circular/b.ts → src/circular/a.ts
-
-Affected Files (7)
-├─ src/admin/page.tsx (depth 1)
-├─ src/dashboard/page.tsx (depth 1)
-└─ src/main.ts (depth 2)
+╭ ripple ────────────────────────────╮
+│  ❯ impact analysis · v0.2.0        │
+╰────────────────────────────────────╯
+
+File        src/authentication/login.ts
+Risk        MEDIUM · 34.7/100 ███░░░░░░░
+Impact      4 routes · 2 components · 1 test
+Affected    7 files
+Max depth   2
+Confidence  100%
+
+────────────────────────────────────
+Top impact
+● Dashboard (2)
+● Admin (1)
+● Index TS (1)
+
+────────────────────────────────────
+Circular dependencies
+◯ src/circular/a.ts → src/circular/c.ts → src/circular/b.ts → src/circular/a.ts
+
+────────────────────────────────────
+Affected files (7)
+├─ src/admin/page.tsx · depth 1
+├─ src/dashboard/page.tsx · depth 1
+└─ src/main.ts · depth 2
 ```
 
 ### See more of the project
@@ -151,7 +154,9 @@ ripple graph
 ```
 
 ```text
-🌊 Dependency Graph
+╭ ripple ────────────────────────────╮
+│  ❯ dependency graph · v0.2.0       │
+╰────────────────────────────────────╯
 
 Files            25
 Edges            28
@@ -159,8 +164,9 @@ External         4
 Unresolved       0
 Circular groups  1
 
-Circular Dependencies
-⭕ src/circular/a.ts → src/circular/c.ts → src/circular/b.ts → src/circular/a.ts
+────────────────────────────────────
+Circular dependencies
+◯ src/circular/a.ts → src/circular/c.ts → src/circular/b.ts → src/circular/a.ts
 ```
 
 Point it at a file to see its dependency tree — forwards (what it imports)
@@ -294,7 +300,7 @@ That yields a score from 0–100 and a level at thresholds 30, 55, 80 — the
 same colors the CLI prints on your terminal:
 
 <p align="center">
-  <img src="assets/risk-levels.svg" alt="Risk levels: LOW, MEDIUM, HIGH, CRITICAL" title="Risk levels" width="440" />
+  <img src="https://raw.githubusercontent.com/alimaandev/ripple/main/assets/risk-levels.svg" alt="Risk levels: LOW, MEDIUM, HIGH, CRITICAL" title="Risk levels" width="440" />
 </p>
 
 Confidence (0–100) is separate — how trustworthy the analysis is. It drops
@@ -448,6 +454,13 @@ pnpm run build          # tsup
 Architecture and design decisions live in [docs/architecture.md](docs/architecture.md).
 Before contributing, read [CONTRIBUTING.md](CONTRIBUTING.md).
 
+## Get started
+
+```bash
+npm install -g @alimaandev/ripple
+ripple analyze src/your-file.ts --json | jq -r .risk.level   # MEDIUM, HIGH, ...
+```
+
 ## License
 
 MIT — see [LICENSE](LICENSE).

package/dist/bin.d.ts

@@ -0,0 +1,2 @@
+
+export {  }