docs: match Node.js version requirement to package.json engines#3714
Open
andromia3 wants to merge 1 commit intoShopify:mainfrom
Open
docs: match Node.js version requirement to package.json engines#3714andromia3 wants to merge 1 commit intoShopify:mainfrom
andromia3 wants to merge 1 commit intoShopify:mainfrom
Conversation
The root package.json declares "engines": { "node": "^22 || ^24" },
but three user-facing docs claimed a much older minimum:
- README.md -> "Node.js version 18.0.0 or higher"
- CONTRIBUTING.md -> "Node.js version 16.14.0 or higher"
- templates/skeleton/README.md -> "Node.js version 18.0.0 or higher"
Users following any of these will fail install because ^22 || ^24
excludes Node 16, 18, 20, and 23. Updated all three to "Node.js 22.x
or 24.x" to match the engines field.
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.
The root `package.json` declares `"engines": { "node": "^22 || ^24" }`, but three user-facing docs claim older, incorrect minimums. Users following any of these hit a hard install failure because the engines constraint excludes Node 16, 18, 20, and 23.
Changes
```diff
```
The wording `22.x or 24.x` was chosen to match the shape of `^22 || ^24` precisely (LTS-only, Node 23 excluded).
Scope limited to authoritative user-facing docs. Cookbook recipe READMEs and LLM prompt files also carry the old `18.0.0 or higher` string, but those are generated by `cookbook.ts` from the skeleton template, so they should refresh on the next regeneration rather than be edited by hand.
No code or functional changes, no changeset needed.