Skip to content

Commit f11c9a5

Browse files
committed
docs: v1.5.0 — VS Code extension, npm publish, docs search
1 parent 7f9acbf commit f11c9a5

3 files changed

Lines changed: 40 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,43 @@ Format: [Semantic Versioning](https://semver.org/)
66

77
---
88

9+
## [1.5.0] — 2026-04-04
10+
11+
### Added
12+
- **VS Code extension** (`vscode-extension/`) — zero-dependency extension for VS Code / VS Code-compatible editors:
13+
- **Status bar item** — shows health grade (A/B/C/D) and time since last regeneration; refreshes every 60 s and immediately on file-system change to `copilot-instructions.md`.
14+
- **`ContextForge: Regenerate Context`** command — runs `node gen-context.js` in an integrated terminal from the workspace root.
15+
- **`ContextForge: Open Context File`** command — opens `.github/copilot-instructions.md` in the editor.
16+
- **Stale context notification** — warns when `copilot-instructions.md` is > 24 h old; offers one-click regeneration or "Don't show again" suppression per workspace.
17+
- **`contextforge.scriptPath` setting** — override the path to `gen-context.js` when it is not at the project root.
18+
- `onStartupFinished` activation — loads within 3 s of VS Code opening, does not block startup.
19+
- **Docs site search** — lightweight client-side keyword search added to all 6 HTML docs pages (`index.html`, `quick-start.html`, `strategies.html`, `languages.html`, `roadmap.html`, `repomix.html`):
20+
- Press `/` anywhere to open the search overlay; `Escape` or click outside to close.
21+
- Searches all headings, paragraphs, and list items in the current page.
22+
- Up to 12 results shown with snippet preview; matching text highlighted in amber.
23+
- Click a result to scroll to the exact section with a 2-second amber outline highlight.
24+
- Zero external dependencies — ~60 lines of inline JS per page. Theme-aware (dark/light).
25+
- **`.npmignore`** — excludes `test/`, `docs/`, `scripts/`, `examples/`, `.claude/`, `vscode-extension/`, `.github/workflows/` and planning docs from npm publish. Published package contains only the runtime files listed in `package.json#files`.
26+
- **`test/integration/v1.5.test.js`** — 58 integration tests covering all v1.5 features:
27+
- npm package integrity (name, bin, engines, zero deps, .npmignore exclusions)
28+
- shebang line presence and correctness
29+
- extension manifest structure (commands, configuration, activation)
30+
- extension.js API coverage (status bar, notification, commands, scriptPath)
31+
- search injection verified in all 6 docs pages (overlay, input, keyboard handlers, highlights)
32+
33+
### Notes
34+
- The VS Code extension requires the `vscode` peer dependency at runtime (provided by the editor). It has no npm runtime dependencies of its own.
35+
- `scripts/inject-search.py` is the one-time migration script used to add search to existing HTML pages; it is idempotent (skip if already patched).
36+
37+
### Validation gate
38+
- `node gen-context.js --version``1.5.0`*(note: version bumped separately if desired)*
39+
- `node test/integration/v1.5.test.js` → 58/58 pass ✔
40+
- `node test/run.js` → 21/21 extractor tests pass ✔
41+
- `npm pack --dry-run` → no `test/`, `docs/`, or `vscode-extension/` in artifact ✔
42+
- All 6 docs pages: press `/` → search overlay opens; type "python" → result appears ✔
43+
44+
---
45+
946
## [1.4.0] — 2026-04-04
1047

1148
### Added

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ npx repomix --compress # deep dive sessions
8787

8888
## CLI reference
8989

90-
> **Note:** `node gen-context.js`, `--watch`, `--setup`, `--report`, `--mcp`, `--routing`, `--diff`, and `--init` are live in v1.4.
90+
> **Note:** `node gen-context.js`, `--watch`, `--setup`, `--report`, `--mcp`, `--routing`, `--diff`, and `--init` are live in v1.5.
9191
> Features marked `(v0.x)` or `(v1.x)` were added incrementally — see [CHANGELOG.md](CHANGELOG.md) for when each shipped.
9292
9393
```

TIMELINE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ A version is NOT done until its validation gate is 100% green.
3535
| v1.2 | Version bump + test hardening | 1 day | correctness + npm discoverability |
3636
| v1.3 | `--diff` flag + watch debounce | 2 days | −50–90% tokens during active PR work |
3737
| v1.4 ✅ | MCP `explain_file` + strategy-aware health | 2 days | precision queries, accurate scoring |
38-
| v1.5 | VS Code extension + npm publish + docs search | 1 week | 10× adoption surface |
38+
| v1.5 | VS Code extension + npm publish + docs search | 1 week | 10× adoption surface |
3939

4040
---
4141

@@ -891,7 +891,7 @@ node test/run.js
891891
---
892892

893893
## v1.5 — VS Code extension + npm publish + docs search
894-
**Status: 📋 PLANNED**
894+
**Status: ✅ SHIPPED — v1.5.0**
895895
**Duration: 1 week | Owner: Platform + DevEx**
896896

897897
### What ships

0 commit comments

Comments
 (0)