omp-vcc 0.1.0 → 0.1.2

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.
Files changed (2) hide show
  1. package/README.md +5 -6
  2. package/package.json +17 -8
package/README.md CHANGED
@@ -4,6 +4,8 @@
4
4
 
5
5
  ## Quick start
6
6
 
7
+ > **New here?** → [`docs/setup.md`](docs/setup.md) — 5-minute install with prerequisites, 4 install options (link / npm / git), verify, first `/omp-vcc`, recall, config, and troubleshooting. The commands below are the tldr.
8
+
7
9
  ```sh
8
10
  # from source (local)
9
11
  omp plugin link /Users/zhu/code/projects/omp-vcc
@@ -49,8 +51,6 @@ File `~/.omp/omp-vcc/config.json` (XDG-aware: `$OMP_VCC_CONFIG_PATH` > `$PI_VCC_
49
51
  }
50
52
  ```
51
53
 
52
- Manifest `omp.settings` also exposed (`vccEnabled`, `overrideDefaultCompaction`, `smartKeepTail`, `continueAfterThresholdCompact`, `debug`) — appears under plugin section in `/settings` and via `omp config`. See [`docs/configuration.md`](docs/configuration.md).
53
-
54
54
  ## How it works
55
55
 
56
56
  VCC compiles the raw JSONL trace via **lex → parse IR → monotonic line assignment → view lowering** into three views sharing one coordinate system:
@@ -59,7 +59,7 @@ VCC compiles the raw JSONL trace via **lex → parse IR → monotonic line assig
59
59
  - `V_ui` one-line tool summaries with pointers (`* Read "src/pets.py" (file.txt:18-20)`)
60
60
  - `V_adapt(b, ρ)` projection via predicate `ρ` preserving headers/role tags and `(f:s-e)` pointers, two transposed modalities (document vs index oriented)
61
61
 
62
- `omp-vcc` implements `V_ui` as the structured summary (5 sections + ranked brief transcript) and `V_adapt` as `vcc_recall`. Pointer invariant `V_ui → V_full[s:e]` holds structurally. See [`docs/architecture.md`](docs/architecture.md) and [`docs/paper-notes.md`](docs/paper-notes.md).
62
+ `omp-vcc` implements `V_ui` as the structured summary (5 sections + ranked brief transcript) and `V_adapt` as `vcc_recall`. Pointer invariant `V_ui → V_full[s:e]` holds structurally. Diagrams and pipeline in [`docs/architecture.md`](docs/architecture.md); paper mapping in [`docs/paper-notes.md`](docs/paper-notes.md); setup in [`docs/setup.md`](docs/setup.md).
63
63
 
64
64
  ## Related work
65
65
 
@@ -83,13 +83,12 @@ Capabilities: `extension`, `skill`, `command` — entry `extensions/main.ts`.
83
83
 
84
84
  ```sh
85
85
  bunx tsc --noEmit
86
- bun test # 295 tests across 32 files
86
+ bun test # 310 tests across 33 files, 768 expects
87
87
  bun run smoke # ok: session_before_compact hooked, vcc_recall registered
88
88
  omp plugin link /Users/zhu/code/projects/omp-vcc && omp plugin doctor
89
89
  ```
90
90
 
91
- In a live `omp` session: `/omp-vcc keep:1` shows `[Session Goal]` toast `omp-vcc: kept 1/5 turns, ~2.1k tok`; with `debug:true` check `/tmp/omp-vcc-debug.json`. See [`docs/verification.md`](docs/verification.md).
92
-
91
+ In a live `omp` session: `/omp-vcc keep:1` shows `[Session Goal]` toast `omp-vcc: kept 1/5 turns, ~2.1k tok`; with `debug:true` check `/tmp/omp-vcc-debug.json`. Full proof matrix and mermaid flows in [`docs/verification.md`](docs/verification.md).
93
92
  ## Publish
94
93
 
95
94
  - npmjs (unscoped): `npm publish --registry https://registry.npmjs.org --access public` (package `omp-vcc`)
package/package.json CHANGED
@@ -1,18 +1,27 @@
1
1
  {
2
2
  "name": "omp-vcc",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "Algorithmic VCC compaction for omp - fast lossless no-LLM",
5
- "type": "module",
5
+ "author": "Zhu Lin <zhulin@czl.my>",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "git+https://github.com/zhulinchng/omp-vcc.git"
9
+ },
10
+ "homepage": "https://github.com/zhulinchng/omp-vcc#readme",
11
+ "bugs": {
12
+ "url": "https://github.com/zhulinchng/omp-vcc/issues"
13
+ },
6
14
  "keywords": [
7
15
  "oh-my-pi",
8
16
  "omp",
9
- "plugin"
17
+ "pi",
18
+ "oh-my-pi",
19
+ "plugin",
20
+ "vcc",
21
+ "compaction",
22
+ "pi-package"
10
23
  ],
11
24
  "license": "MIT",
12
- "repository": {
13
- "type": "git",
14
- "url": "https://github.com/zhulinchng/omp-vcc.git"
15
- },
16
25
  "files": [
17
26
  "extensions",
18
27
  "skills",
@@ -99,6 +108,6 @@
99
108
  "test": "bun test",
100
109
  "smoke": "bun run scripts/smoke.ts",
101
110
  "postuninstall": "node scripts/uninstall-reset.js || true",
102
- "prepublishOnly": "npm run typecheck"
111
+ "prepublishOnly": "npm run typecheck && npm test && npm run smoke"
103
112
  }
104
113
  }