docs: separate the dev and consumer Node floors - #57
Merged
Conversation
The root package.json requires Node >= 22.13 (pnpm 11 will not run below that) while the six published packages declare >= 20. That reads like an oversight, so record why it is not: the root is private and constrains contributors, the packages describe what their built output needs, and CI verifies the >= 20 claim by loading every bundle on Node 20. Also flags a stale changelog entry for whoever cuts the next release. Commit 4c0a23c carries "BREAKING CHANGE: minimum supported Node.js is now 22.13 (was 20)", but it only touched the private root and the CI runner — no published package ever dropped Node 20. Left in place it would announce a consumer-facing break that never happened, so the release checklist now says to strike that bullet. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MsFZHTnQmAUMjtLUegFRPL
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #57 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 11 11
Lines 695 695
Branches 167 167
=========================================
Hits 695 695
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Follow-up to #56. Documentation only — no code or config changes.
While cleaning up after #56 merged, a
release-it --dry-runsurfaced a contradiction waiting for the next release.The problem
Commit
4c0a23c(July 7, unreleased) carries:But it only changed two things: the private root
package.jsonand the CI runner version. No published package was touched — all six still declareengines: >=20, and #56 added a compat job that verifies that claim by loading every built bundle on Node 20.So the next release would announce a consumer-facing break that never happened, while shipping packages that say the opposite.
The resolution
The two floors are both correct, because they describe different audiences:
node:sqlite, which doesn't exist before 22.13The root
package.jsonisprivate: true, so itsenginesnever reaches consumers. Raising the packages to match it would drop Node 20 users on a toolchain-parity argument rather than a technical one.This PR records that reasoning so the mismatch doesn't read as an oversight and get "fixed" later, and adds a release checklist item to strike the stale bullet from the generated
CHANGELOG.mdbefore the next release goes out.Changes
CONTRIBUTING.md— a Node versions section explaining the split, and a Releasing section documentingpnpm release/--dry-runplus the one-time changelog note.README.md— the requirements section now distinguishes the consumer floor from the contributor one. The>=20badge is unchanged and correct.Verification
pnpm format:checkandpnpm lintclean.scripts/smoke-test.mjsre-run against real Node 20.19.1 to confirm the>=20claim still holds.Also worth a decision (not in this PR)
The same dry run computes the next version as 1.0.0 — conventional-changelog treats the breaking changes from #56 as major even at
0.x. If you'd rather ship0.3.0, that needs a--preRelease-style override or an explicit version at release time; it isn't something this PR changes.🤖 Generated with Claude Code
https://claude.ai/code/session_01MsFZHTnQmAUMjtLUegFRPL