feat(node-version-file): support parsing devEngines field
#1283
+80
−19
Conversation
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
Signed-off-by: Ferdinand Thiessen <[email protected]>
|
Awsome! Appreciate for your work. |
|
anything I can help with to push this forward? :) |
SunsetTechuila
suggested changes
Jun 5, 2025
Comment on lines
+29
to
+36
| // support devEngines from npm 11 | ||
| if ( | ||
| manifest.devEngines?.runtime?.name === 'node' && | ||
| manifest.devEngines.runtime.version | ||
| ) { | ||
| return manifest.devEngines.runtime.version; | ||
| } | ||
|
|
There was a problem hiding this comment.
manifest.devEngines.runtime can be an array of objects. see: https://docs.npmjs.com/cli/v11/configuring-npm/package-json#devengines
Suggested change
| // support devEngines from npm 11 | |
| if ( | |
| manifest.devEngines?.runtime?.name === 'node' && | |
| manifest.devEngines.runtime.version | |
| ) { | |
| return manifest.devEngines.runtime.version; | |
| } | |
| // support devEngines from npm 11 | |
| if (manifest.devEngines?.runtime) { | |
| const runtimes = [].concat(manifest.devEngines.runtime); | |
| const { version } = runtimes.find( | |
| (runtime) => runtime.name.toLowerCase() === "node" && runtime.version | |
| ); | |
| return version; | |
| } | |
| ${'{"volta": {"node": ">=14.0.0 <=17.0.0"}}'} | ${'>=14.0.0 <=17.0.0'} | ||
| ${'{"volta": {"extends": "./package.json"}}'} | ${'18.0.0'} | ||
| ${'{"engines": {"node": "17.0.0"}}'} | ${'17.0.0'} | ||
| ${'{"devEngines": {"runtime": {"name": "node", "version": "22.0.0"}}}'} | ${'22.0.0'} |
There was a problem hiding this comment.
Suggested change
| ${'{"devEngines": {"runtime": {"name": "node", "version": "22.0.0"}}}'} | ${'22.0.0'} | |
| ${'{"devEngines": {"runtime": {"name": "node", "version": "22.0.0"}}}'} | ${'22.0.0'} | |
| ${'{"devEngines": {"runtime": [{"name": "bun"}, {"name": "node", "version": "22.0.0"}]}}'} | ${'22.0.0'} |
| @@ -0,0 +1,11 @@ | |||
| { | |||
| "engines": { | |||
| "node": "^20 || ^22" | |||
There was a problem hiding this comment.
this would make the test more reliable and easier to understand
Suggested change
| "node": "^20 || ^22" | |
| "node": "^19" |
| node-version-file: '__tests__/data/package-dev-engines.json' | ||
| - name: Verify node | ||
| run: __tests__/verify-node.sh 20 | ||
|
|
There was a problem hiding this comment.
Suggested change
| version-file-dev-engines-array: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, windows-latest, macos-latest, macos-13] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup node from node version file | |
| uses: ./ | |
| with: | |
| node-version-file: '__tests__/data/package-dev-engines-array.json' | |
| - name: Verify node | |
| run: __tests__/verify-node.sh 20 | |
suggested file content:
{
"engines": {
"node": "^19"
},
"devEngines": {
"runtime": [
{
"name": "bun",
"version": "^1"
},
{
"name": "node",
"version": "^20"
}
]
}
}| ```json | ||
| { | ||
| "engines": { | ||
| "node": "^20 || ^22" |
There was a problem hiding this comment.
Suggested change
| "node": "^20 || ^22" | |
| "node": "^19" |
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.
Description:
Currently if you want to support multiple versions for running (e.g. a library) but enforce a specific version for development you can set
devEngineswith npm 11.This PR adds support for parsing the
devEngines.runtimefield (if it is set tonode) for allowing automatic setup.Related issue:
devEnginesfield inpackage.json#1255Check list: