Repository navigation
chore: drop the Bun support claim and its CI job - #60
Merged
Merged
Conversation
Contributor
Author
|
Verify Signed Commit Authors fails on Generated by Claude Code |
There was a problem hiding this comment.
🟢 Approval recommended
No unresolved blocking issues were identified.
No open issues 🎉
What changed in this PR
Removes the inaccurate Bun support claim and ineffective Bun CI coverage.
Changes:
- Retains Node.js 22.x and 24.x support.
- Removes Bun metadata and troubleshooting guidance.
- Deletes the ineffective Bun CI job.
| File | Description |
|---|---|
README.md |
Updates supported runtime documentation. |
package.json |
Removes the Bun engine requirement. |
docs/troubleshooting.md |
Removes Bun-specific guidance. |
.github/workflows/build.yml |
Removes the Bun test job. |
Review effort: Lite
Bun does not load this addon. It refuses any file named
better_sqlite3.node ("'better-sqlite3' is not yet supported in Bun"),
and a renamed copy built for Bun's ABI (137) fails with undefined V8
symbols: Bun 1.3.5's V8 API layer lacks about 30 of the functions the
addon uses, among them FunctionTemplate::InstanceTemplate,
Function::Call, the Exception constructors and weak handles.
The test-bun job still passed because `bun run test` runs mocha through
its `#!/usr/bin/env node` shebang, so the tests ran under Node.
Remove the claim from the README, the bun engine from package.json, the
Bun troubleshooting section and the test-bun job.
arv
force-pushed
the
arv/remove-bun-support
branch
from
October 20, 2026 08:49
802447a to
d34c36e
Compare
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
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.
The README says this package supports Bun. It doesn't, and CI never tested it. This PR removes the claim and the Bun CI job.
Why Bun can't load the addon
Bun doesn't run V8. It runs JavaScriptCore with a partial reimplementation of V8's C++ API. This addon calls V8's C++ API directly, and Bun 1.3.5 is missing 33 of the functions it uses, among them:
Function::CallFunctionTemplate::InstanceTemplateandPrototypeTemplateExceptionconstructorsBigIntDictionaryTemplateI confirmed it by building for Node 24's ABI (137, the one Bun expects) and renaming the file to get past Bun's filename check (Bun refuses
better_sqlite3.nodeby name; see oven-sh/bun#4290). It then fails to load withundefined symbol: v8::FunctionTemplate::InstanceTemplate().Neither the ABI version nor the minimum Node version changes this. The only ways to support Bun are porting the addon to N-API or Bun implementing these functions.
Why CI passed anyway
The
test-bunjob runsbun run test, which runsmocha. Mocha's bin starts with#!/usr/bin/env node, so the tests ran under Node, not Bun.Changes
README.md: the claim now reads "Supports Node.js 22.x and 24.x".package.json: dropengines.bun.docs/troubleshooting.md: drop the Bun section..github/workflows/build.yml: drop thetest-bunjob (nothingneedsit).If the
Testing Bun 1.3.5 on …checks are required in themainruleset, remove them there as well. Otherwise PRs will wait on checks that never run.🤖 Generated with Claude Code
https://claude.ai/code/session_01WCP5vbpvciRmgWBx2b1zKb