docs(readme): add Supported runtimes section + JSR config helper for bun/node (Group 8)#19
Merged
Merged
Conversation
…bun/node
Group 8 partial — 8.2 + 8.3.
README now documents the cross-runtime story:
- per-runtime SQLite driver matrix (Deno @db/sqlite, Bun bun:sqlite,
Node 22+ node:sqlite + better-sqlite3 fallback)
- explicit non-support for browsers + Cloudflare Workers
- same-import example showing the runtime-agnostic library API
- link into openspec/changes/.../specs/runtime-compat/spec.md for the
formal contract (with note that it moves to openspec/specs/ on archive)
Also fixes two stale @ssal/dev-coach references in README → @salmidev/dev-coach.
scripts/configure-jsr-package.sh updated to PATCH runtimeCompat with
deno:true + bun:true + node:true (was deno-only). User runs it after
this PR merges; needs JSR_TOKEN.
Verification: deno fmt + lint + 266/266 tests + 84.7% coverage.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Group 8 partial — closes 8.2 + 8.3. Sets up the JSR flip for the user to execute.
README — new "Supported runtimes" section
jsr:@db/sqlite(FFI)bun:sqlitenode:sqlite(Node ≥ 22.5) orbetter-sqlite3fallbackPlus a same-import example showing the library API is identical on every runtime, and a link into
openspec/changes/.../specs/runtime-compat/spec.mdfor the formal contract (with a note that it moves toopenspec/specs/on archive).Drive-by fix
Two stale
@ssal/dev-coachreferences in README →@salmidev/dev-coach(the actual JSR scope).JSR config helper
scripts/configure-jsr-package.shupdated:Same script you ran for Track A — you re-run after this PR merges (needs
JSR_TOKEN).Verification
deno task verify— 266 / 266 tests, 84.7% coverage ✓Next (your hands)
After this merges:
export JSR_TOKEN=… && scripts/configure-jsr-package.sh— flips the JSR-side flag.patchrule in CI doesn't apply for releases triggered manually with a chosen bump level.I'll handle Group 9 (JSDoc polish + archive) once the release is live.
Tasks: 38 / 49 after merge (8.2 + 8.3 add to the 36 from Group 6).