Misleading minimum Node version in README

[MikeMcC399]

Documentation bug report

start-server-and-test v1.15.3 migrated to wait-on v7.0.1 with a minimum Node.js version 12. This is not reflected in README: Install.

Problem description

README: Install says

"Requires Node version 8.9 or above."

however since start-server-and-test uses

start-server-and-test/package.json

Line 134 in 9e8713b

"wait-on": "7.0.1"

and wait-on: README: Installation says:

"Latest wait-on version 7+ requires Node.js 12+
wait-on versions 4-6 requires Node.js 10+

(Node.js v8 users can use wait-on@5.3.0, v4 users can still use wait-on@2.1.2, and older Node.js
engines, use wait-on@1.5.4)"

then it should list Node.js 12 as the current minimum version for start-server-and-test.

Suggested change

Add the information to README: Install that the current version of start-server-and-test requires a minimum version 12 of Node.js.

Optionally also add information that start-server-and-test v1.10.7 (which updated wait-on to v4) would require a minimum version 10 of Node.js, according to the wait-on documentation. (According to the Release Schedule Node.js 10 entered End-of-Life on Apr 30, 2021, so I don't know if Node.js 10 needs to be mentioned any more here, even if wait-on mentions it.)

Edit: Node.js 18 is now the earliest version still supported according to the Node.js Release Schedule.

[MikeMcC399]

@bahmutov

What do you think about implementing the suggestion from this issue?

[bahmutov]

Sure, but also I would point at the package.json and have minimum node engine version there

[MikeMcC399]

@bahmutov

Sure, but also I would point at the package.json and have minimum node engine version there

Currently

start-server-and-test/package.json

Lines 30 to 31 in a9e395c

	"engines": {
	"node": ">=6"

so would you want to bump that to >=12 to match wait-on?

$ npm install start-server-and-test
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN notsup Unsupported engine for wait-on@7.0.1: wanted: {"node":">=12.0.0"} (current: {"node":"10.24.1","npm":"6.14.12"})
npm WARN notsup Not compatible with your version of node/npm: wait-on@7.0.1
npm WARN start-server-and-test-minimum@1.0.0 No description
npm WARN start-server-and-test-minimum@1.0.0 No repository field.

+ start-server-and-test@2.0.0
added 51 packages from 43 contributors and audited 51 packages in 14.477s

6 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

[bahmutov]

YeahSent from my iPhoneOn Mar 27, 2023, at 14:37, Mike McCready ***@***.***> wrote: @bahmutov Sure, but also I would point at the package.json and have minimum node engine version there Currently https://github.com/bahmutov/start-server-and-test/blob/a9e395c248b6ed9f6be0704038d3d048c8ff8684/package.json#L30-L31 so would you want to bump that to >=12 to match wait-on? $ npm install start-server-and-test npm notice created a lockfile as package-lock.json. You should commit this file. npm WARN notsup Unsupported engine for ***@***.***: wanted: {"node":">=12.0.0"} (current: {"node":"10.24.1","npm":"6.14.12"}) npm WARN notsup Not compatible with your version of node/npm: ***@***.*** npm WARN ***@***.*** No description npm WARN ***@***.*** No repository field. + ***@***.*** added 51 packages from 43 contributors and audited 51 packages in 14.477s 6 packages are looking for funding run `npm fund` for details found 0 vulnerabilities —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: ***@***.***>

[MikeMcC399]

It would be safer not to change

start-server-and-test/package.json

Lines 30 to 31 in a9e395c

	"engines": {
	"node": ">=6"

until the release of the next major version in case it causes a breaking change.

The README can be updated at any time however.

Edit: According to npm package,json engines this produces only a warning by default. Yarn is however stricter about this and throws an error.

[github-actions]

🎉 This issue has been resolved in version 2.0.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀