Skip to content

docs: bring the README in step with the code #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kkdev92 merged 1 commit into from
Aug 13, 2026
Merged

docs: bring the README in step with the code #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,8 @@ trusted for things it cannot do.
- **Leak detection has the same boundary**: it sees what the framework tracks, and nothing else
- **Cancellation is cooperative**: aborting a signal asks a handler to stop; one that ignores its signal keeps running, and the framework cannot terminate it
- **The Test Host does not reproduce VS Code**: it renders no UI, interprets no contribution point, and does not substitute a direct `import "vscode"`
- **No editor events yet**: `Editors` hands you the active editor and cross-file edits, but there is no `onDidChangeActive` / `onDidChangeSelection` / `onDidChangeDocument`; subscribing means reaching for `vscode` directly and disposing by hand, which is the one place the single-cleanup-owner rule leaks
- **No log-level filtering, deliberately**: the framework writes to a `LogOutputChannel` and VS Code owns the level — per channel, persisted, in the Output panel. An extension cannot raise its own channel's level, so a `logLevel` setting of your own can only ever make the log quieter
- **No generated API reference yet**, and no step-by-step migration guide from 2.x

---
Expand Down Expand Up @@ -393,9 +395,9 @@ For vulnerability reporting, see [SECURITY.md](SECURITY.md).
Contributions are welcome — thank you for helping make this better 🙌
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

`npm run quality` is the gate: typecheck, lint, tests with per-layer coverage
floors, and dead-code detection. Two more lanes run the framework in a real
desktop Extension Host and a real browser worker.
`npm run quality` is the gate: formatting, typecheck, lint, tests with per-layer
coverage floors, and dead-code detection. Two more lanes run the framework in a
real desktop Extension Host and a real browser worker.

If you're planning a larger change, opening an issue first is appreciated. One
thing to know about direction: adding a second way to do something that already
Expand All @@ -409,9 +411,10 @@ This is a personal project maintained in spare time. It is active, but support
is best-effort: I'll do my best to review issues and PRs, and releases may be a
bit slow sometimes — thank you for your patience.

The `3.x` line is pre-release. Breaking changes are expected between alphas and
are listed in the [CHANGELOG](CHANGELOG.md). `2.x` remains `latest` on npm and
still takes bug fixes.
`3.0.0` is the current release and holds `latest` on npm, so a fresh
`npm install` gets the framework. `2.x` continues on `v2-maintenance` and still
takes bug fixes; anything pinned to `^2.x` resolves there and is unaffected.
Breaking changes are listed in the [CHANGELOG](CHANGELOG.md).

Helpful things when reporting bugs:

Expand Down