rescript-compiler icon indicating copy to clipboard operation
rescript-compiler copied to clipboard

Document minimum required version of NodeJS for the ReScript CLI tools

Open Minnozz opened this issue 4 years ago • 3 comments

One of the first things in the manual:

Installation

Prerequisite: NPM, which comes with NodeJS. Yarn also works.

Node itself is also a requirement. Some parts of the toolchain, like the rescript tool in the project root, are executed with the system's node binary. What is the minimum required version of this NodeJS?

Minnozz avatar Jun 14 '21 10:06 Minnozz

The machine I developed on Linux used v10 which I think it is a reasonable choice

bobzhang avatar Jun 15 '21 05:06 bobzhang

For the CI, we only need test the oldest supported engine, it is not very economic to test all engines, since in general, rescript compiler is Node version agnostics.

bobzhang avatar Jun 16 '21 02:06 bobzhang

I disagree, because things in Node.js can be deprecated or removed or changed, which may completely break rescript for those users, even though the JavaScript part is only a thin wrapper around the "real" compiler.

As an example, the CI in my PR currently fails only on Node.js v16 and it is unclear why (probably only a problem for CI, but still a potential issue): https://app.circleci.com/pipelines/github/rescript-lang/rescript-compiler/3641/workflows/949d975a-a274-4a70-97ce-e082ea53575a/jobs/3767

But it think this is a separate discussion from the minimum version change and will modify the CI config in that PR to only test Node.js 10 on Linux and macOS.

Minnozz avatar Jun 16 '21 06:06 Minnozz

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Jun 10 '23 00:06 stale[bot]