@getripple/core 1.0.4 → 1.0.5
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/CHANGELOG.md +7 -0
- package/README.md +59 -20
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# @getripple/core Changelog
|
|
2
2
|
|
|
3
|
+
## [1.0.5] - 2026-06-04
|
|
4
|
+
|
|
5
|
+
### Changed
|
|
6
|
+
- Refresh package README wording for npm users.
|
|
7
|
+
- Clarify that the core powers VS Code, CLI, and MCP, while most users should start with `@getripple/cli` or `@getripple/mcp`.
|
|
8
|
+
- Document JavaScript/TypeScript depth, basic Python support, and static-analysis limits more clearly.
|
|
9
|
+
|
|
3
10
|
## [1.0.4] - 2026-06-03
|
|
4
11
|
|
|
5
12
|
### Fixed
|
package/README.md
CHANGED
|
@@ -1,12 +1,16 @@
|
|
|
1
1
|
# @getripple/core
|
|
2
2
|
|
|
3
|
-
The
|
|
4
|
-
It scans a local repository, builds architectural context, and exposes the `GraphEngine`
|
|
5
|
-
used by Ripple's plan-before-edit and check-after-edit workflow.
|
|
3
|
+
The graph engine that powers Ripple's VS Code extension, CLI, and MCP server.
|
|
6
4
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
5
|
+
Scans JavaScript, TypeScript, and basic Python repositories, builds a local
|
|
6
|
+
dependency graph, and exposes the architectural context that AI agents need
|
|
7
|
+
before editing code.
|
|
8
|
+
|
|
9
|
+
**Most users should not start here.**
|
|
10
|
+
Install [`@getripple/cli`](https://npmjs.com/package/@getripple/cli) for terminal
|
|
11
|
+
and CI workflows.
|
|
12
|
+
Install [`@getripple/mcp`](https://npmjs.com/package/@getripple/mcp) to give AI
|
|
13
|
+
agents direct structured access to Ripple's context.
|
|
10
14
|
|
|
11
15
|
## Install
|
|
12
16
|
|
|
@@ -22,31 +26,66 @@ import { GraphEngine } from "@getripple/core";
|
|
|
22
26
|
const engine = new GraphEngine(process.cwd());
|
|
23
27
|
await engine.initialScan();
|
|
24
28
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
);
|
|
29
|
+
// What does this file affect?
|
|
30
|
+
const blastRadius = engine.blastRadius(["src/auth.ts"]);
|
|
31
|
+
|
|
32
|
+
// What depends on this file?
|
|
33
|
+
const importers = engine.downstreamFiles("src/auth.ts");
|
|
34
|
+
|
|
35
|
+
// What does this file import?
|
|
36
|
+
const imports = engine.upstreamFiles("src/auth.ts");
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## What the Engine Tracks
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
File dependency graph — every import and reverse import
|
|
43
|
+
Symbol and call edges — exported functions and who calls them
|
|
44
|
+
Blast radius — all files affected by a change
|
|
45
|
+
Risk signals — dangerous / caution / safe per file
|
|
46
|
+
Focused context — per-file summaries for AI agents
|
|
47
|
+
Change history — structural changes since first install
|
|
48
|
+
Layer classification — logic / ui / handler / state / data / effect
|
|
49
|
+
Framework/config signals — Next.js, Vite, React Router, Turborepo, Tailwind,
|
|
50
|
+
tests, tsconfig paths, and package conventions
|
|
30
51
|
```
|
|
31
52
|
|
|
32
53
|
## What It Powers
|
|
33
54
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
55
|
+
**VS Code extension (`ripple`)** — Impact Lens sidebar, CodeLens caller counts,
|
|
56
|
+
Safety Check pre-commit warnings, and Copy Agent Prompt.
|
|
57
|
+
|
|
58
|
+
**CLI (`@getripple/cli`)** — `ripple plan`, `ripple check`, `ripple gate`, and
|
|
59
|
+
the full CI pipeline integration.
|
|
60
|
+
|
|
61
|
+
**MCP server (`@getripple/mcp`)** — `ripple_plan_context`, `ripple_check_staged`,
|
|
62
|
+
`ripple_gate`, and twelve other tools agents can call directly.
|
|
39
63
|
|
|
40
64
|
## Trust Boundary Contract
|
|
41
65
|
|
|
42
|
-
|
|
66
|
+
The core engine is the single source of truth for control modes, editable files,
|
|
43
67
|
context-only files, human gates, and continue/stop decisions. The CLI and MCP
|
|
44
|
-
packages
|
|
45
|
-
state.
|
|
68
|
+
packages consume this contract directly — humans, CI pipelines, and AI agents
|
|
69
|
+
all see the same workflow state.
|
|
70
|
+
|
|
71
|
+
## Supported Languages
|
|
72
|
+
|
|
73
|
+
Deep support: JavaScript and TypeScript — `.ts`, `.tsx`, `.js`, `.jsx`.
|
|
74
|
+
|
|
75
|
+
Basic support: Python — `.py`.
|
|
76
|
+
|
|
77
|
+
Framework and config signals are heuristic. Ripple detects common files and
|
|
78
|
+
package conventions, then tells agents what to trust and what to verify.
|
|
79
|
+
|
|
80
|
+
## Privacy
|
|
81
|
+
|
|
82
|
+
The engine runs entirely on your machine. No data leaves the local file system.
|
|
83
|
+
No network calls, telemetry, or account required.
|
|
46
84
|
|
|
47
85
|
## Status
|
|
48
86
|
|
|
49
|
-
Public alpha. APIs may change while
|
|
87
|
+
Public alpha. Core APIs may change while the CLI and MCP workflow contracts
|
|
88
|
+
harden toward a stable 1.x release.
|
|
50
89
|
|
|
51
90
|
## License
|
|
52
91
|
|