Skip to content

Commit 25df5cd

Browse files
test: adjust for array like devEngines
Co-authored-by: Grigory <grigory.orlov.set@gmail.com> Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
1 parent 88483fd commit 25df5cd

File tree

6 files changed

+61
-24
lines changed

6 files changed

+61
-24
lines changed

.github/workflows/versions.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,21 @@ jobs:
183183
- name: Verify node
184184
run: __tests__/verify-node.sh 20
185185

186+
version-file-dev-engines-array:
187+
runs-on: ${{ matrix.os }}
188+
strategy:
189+
fail-fast: false
190+
matrix:
191+
os: [ubuntu-latest, windows-latest, macos-latest, macos-13]
192+
steps:
193+
- uses: actions/checkout@v4
194+
- name: Setup node from node version file
195+
uses: ./
196+
with:
197+
node-version-file: '__tests__/data/package-dev-engines-array.json'
198+
- name: Verify node
199+
run: __tests__/verify-node.sh 20
200+
186201
version-file-volta:
187202
runs-on: ${{ matrix.os }}
188203
strategy:
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"engines": {
3+
"node": "^19"
4+
},
5+
"devEngines": {
6+
"runtime": [
7+
{
8+
"name": "bun",
9+
"version": "^1"
10+
},
11+
{
12+
"name": "node",
13+
"version": "^20"
14+
}
15+
]
16+
}
17+
}

__tests__/data/package-dev-engines.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"engines": {
3-
"node": "^20 || ^22"
3+
"node": "^19"
44
},
55
"devEngines": {
66
"runtime": {

__tests__/main.test.ts

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -91,23 +91,24 @@ describe('main tests', () => {
9191

9292
describe('getNodeVersionFromFile', () => {
9393
each`
94-
contents | expected
95-
${'12'} | ${'12'}
96-
${'12.3'} | ${'12.3'}
97-
${'12.3.4'} | ${'12.3.4'}
98-
${'v12.3.4'} | ${'12.3.4'}
99-
${'lts/erbium'} | ${'lts/erbium'}
100-
${'lts/*'} | ${'lts/*'}
101-
${'nodejs 12.3.4'} | ${'12.3.4'}
102-
${'ruby 2.3.4\nnodejs 12.3.4\npython 3.4.5'} | ${'12.3.4'}
103-
${''} | ${''}
104-
${'unknown format'} | ${'unknown format'}
105-
${' 14.1.0 '} | ${'14.1.0'}
106-
${'{"volta": {"node": ">=14.0.0 <=17.0.0"}}'} | ${'>=14.0.0 <=17.0.0'}
107-
${'{"volta": {"extends": "./package.json"}}'} | ${'18.0.0'}
108-
${'{"engines": {"node": "17.0.0"}}'} | ${'17.0.0'}
109-
${'{"devEngines": {"runtime": {"name": "node", "version": "22.0.0"}}}'} | ${'22.0.0'}
110-
${'{}'} | ${null}
94+
contents | expected
95+
${'12'} | ${'12'}
96+
${'12.3'} | ${'12.3'}
97+
${'12.3.4'} | ${'12.3.4'}
98+
${'v12.3.4'} | ${'12.3.4'}
99+
${'lts/erbium'} | ${'lts/erbium'}
100+
${'lts/*'} | ${'lts/*'}
101+
${'nodejs 12.3.4'} | ${'12.3.4'}
102+
${'ruby 2.3.4\nnodejs 12.3.4\npython 3.4.5'} | ${'12.3.4'}
103+
${''} | ${''}
104+
${'unknown format'} | ${'unknown format'}
105+
${' 14.1.0 '} | ${'14.1.0'}
106+
${'{}'} | ${null}
107+
${'{"volta": {"node": ">=14.0.0 <=17.0.0"}}'} | ${'>=14.0.0 <=17.0.0'}
108+
${'{"volta": {"extends": "./package.json"}}'} | ${'18.0.0'}
109+
${'{"engines": {"node": "17.0.0"}}'} | ${'17.0.0'}
110+
${'{"devEngines": {"runtime": {"name": "node", "version": "22.0.0"}}}'} | ${'22.0.0'}
111+
${'{"devEngines": {"runtime": [{"name": "bun"}, {"name": "node", "version": "22.0.0"}]}}'} | ${'22.0.0'}
111112
`.it('parses "$contents"', ({contents, expected}) => {
112113
const existsSpy = jest.spyOn(fs, 'existsSync');
113114
existsSpy.mockImplementation(() => true);

docs/advanced-usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ This example will install a Node version based on the `^20.10` pattern.
8686
```json
8787
{
8888
"engines": {
89-
"node": "^20 || ^22"
89+
"node": "^19"
9090
},
9191
"devEngines": {
9292
"runtime": {

src/util.ts

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,15 @@ export function getNodeVersionFromFile(versionFilePath: string): string | null {
2727
}
2828

2929
// support devEngines from npm 11
30-
if (
31-
manifest.devEngines?.runtime?.name === 'node' &&
32-
manifest.devEngines.runtime.version
33-
) {
34-
return manifest.devEngines.runtime.version;
30+
if (manifest.devEngines?.runtime) {
31+
// find an entry with name set to node and having set a version.
32+
// the devEngines.runtime can either be an object or an array of objects
33+
const nodeEntry = [manifest.devEngines.runtime]
34+
.flat()
35+
.find(({name, version}) => name.toLowerCase() === 'node' && version);
36+
if (nodeEntry) {
37+
return nodeEntry.version;
38+
}
3539
}
3640

3741
if (manifest.engines?.node) {

0 commit comments

Comments
 (0)