How can I specify the required Node js version in package json

Question

I have a Node js project that requires Node version 12 or higher  Is there a way to specify this in the packages json file  so that the installer will automatically check and inform the users if they need to upgrade

User · Answer

nvmrc  If you are using NVM like this  which you likely should  then you can indicate the nodejs version required for given project in a git-tracked  nvmrc file   echo v10 15 1  gt   nvmrc   This does not take effect automatically on cd  which is sane  the user must then do a   nvm use   and now that version of node will be used for the current shell   You can list the versions of node that you have with   nvm list    nvmrc is documented at  https   github com creationix nvm tree 02997b0753f66c9790c6016ed022ed2072c22603 nvmrc  How to automatically select that node version on cd was asked at  Automatically switch to correct version of Node based on project  Tested with NVM 0 33 11

User · Answer

A Mocha test case example   describe  Check version of node   function          it  Should test version assert   async function                   var version   process version              var check   parseFloat version substr 1 version length    gt  12 0              console log  version    version               console log  check     check                        assert equal check  true

User · Answer

Just like said Ibam  engineStrict is now deprecated  But I ve found this solution   check-version js   import semver from  semver   import   engines   from    package    const version   engines node  if   semver satisfies process version  version       console log  Required node version   version  not satisfied with current version   process version        process exit 1       package json        name    my package      engines          node     gt  50 9     intentionally so big version number         scripts          requirements-check    babel-node check-version js        postinstall    npm run requirements-check          Find out more here   https   medium com  adambisek how-to-check-minimum-required-node-js-version-4a78a8855a0f  3oslqmig4   nvmrc  And one more thing  A dotfile   nvmrc  can be used for requiring specific node version - https   github com creationix nvm nvmrc  But  it is only respected by npm scripts  and yarn scripts

User · Answer

There s another  simpler way to do this    npm install Node 8  saves Node 8 as dependency in package json  Your app will run using Node 8 for anyone - even Yarn users    This works because node is just a package that ships node as its package binary  It just  includes as node module  bin which means it only makes node available to package scripts  Not main shell   See discussion on Twitter here  https   twitter com housecor status 962347301456015360

User · Answer

I think you can use the  engines  field      engines       node      gt  0 12        As you re saying your code definitely won t work with any lower versions  you probably want the  engineStrict  flag too      engineStrict    true     Documentation for the package json file can be found on the npmjs site  Update  engineStrict is now deprecated  so this will only give a warning   It s now down to the user to run npm config set engine-strict true if they want this   Update 2  As ben pointed out below  creating a  npmrc file at the root of your project  the same level as your package json file  with the text engine-strict true will force an error during installation if the Node version is not compatible

User · Answer

Add the following to package json     quot engines quot          quot node quot    quot  gt  10 0 0 quot        quot npm quot    quot  gt  6 0 0 quot        Add the following to  npmrc  same directory as package json   engine-strict true

[node.js] How can I specify the required Node.js version in package.json?

Examples related to node.js

Examples related to npm

Examples related to package

Examples related to version