{"_id":"please-upgrade-node","_rev":"88529","name":"please-upgrade-node","description":"Displays a beginner-friendly message telling your user to upgrade their version of Node","dist-tags":{"latest":"3.2.0"},"maintainers":[{"name":"typicode","email":"typicode@gmail.com"}],"time":{"modified":"2021-06-03T10:28:46.000Z","created":"2017-07-08T14:23:22.809Z","3.2.0":"2019-08-08T12:06:54.978Z","3.1.1":"2018-07-05T00:02:16.928Z","3.1.0":"2018-07-02T22:07:34.250Z","3.0.2":"2018-04-25T22:24:46.352Z","3.0.1":"2017-07-31T20:52:03.914Z","3.0.0":"2017-07-31T20:31:08.419Z","2.0.0":"2017-07-24T20:18:56.200Z","1.0.1":"2017-07-10T11:08:07.928Z","1.0.0":"2017-07-08T14:23:22.809Z"},"users":{},"author":{"name":"typicode"},"repository":{"type":"git","url":"git+https://github.com/typicode/please-upgrade-node.git"},"versions":{"3.2.0":{"name":"please-upgrade-node","version":"3.2.0","description":"Displays a beginner-friendly message telling your user to upgrade their version of Node","main":"index.js","scripts":{"test":"node test","lint":"eslint .","fix":"npm run lint -- --fix","prepublishOnly":"npm test && npm run lint && pkg-ok"},"repository":{"type":"git","url":"git+https://github.com/typicode/please-upgrade-node.git"},"keywords":["node","engines","version","check","verify","upgrade"],"author":{"name":"typicode"},"license":"MIT","bugs":{"url":"https://github.com/typicode/please-upgrade-node/issues"},"homepage":"https://github.com/typicode/please-upgrade-node#readme","devDependencies":{"eslint":"^4.19.1","eslint-plugin-prettier":"^2.6.0","husky":"^1.0.0-rc.12","pkg-ok":"^1.1.0","prettier":"1.12.1","tape":"^4.9.1"},"dependencies":{"semver-compare":"^1.0.0"},"husky":{"hooks":{"pre-commit":"npm test && npm run lint"}},"gitHead":"cf4e00d3adced6cbc08411cabba7d35b180eea6f","_id":"please-upgrade-node@3.2.0","_nodeVersion":"12.4.0","_npmVersion":"6.9.0","dist":{"shasum":"aeddd3f994c933e4ad98b99d9a556efa0e2fe942","size":2800,"noattachment":false,"key":"/please-upgrade-node/-/please-upgrade-node-3.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/please-upgrade-node/download/please-upgrade-node-3.2.0.tgz"},"maintainers":[{"name":"typicode","email":"typicode@gmail.com"}],"_npmUser":{"name":"typicode","email":"typicode@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/please-upgrade-node_3.2.0_1565266014834_0.39415581326854676"},"_hasShrinkwrap":false,"publish_time":1565266014978,"_cnpm_publish_time":1565266014978},"3.1.1":{"name":"please-upgrade-node","version":"3.1.1","description":"Displays a beginner-friendly message telling your user to upgrade their version of Node","main":"index.js","scripts":{"test":"node test","lint":"eslint .","fix":"npm run lint -- --fix","prepublishOnly":"npm test && npm run lint && pkg-ok"},"repository":{"type":"git","url":"git+https://github.com/typicode/please-upgrade-node.git"},"keywords":["node","engines","version","check","verify","upgrade"],"author":{"name":"typicode"},"license":"MIT","bugs":{"url":"https://github.com/typicode/please-upgrade-node/issues"},"homepage":"https://github.com/typicode/please-upgrade-node#readme","devDependencies":{"eslint":"^4.19.1","eslint-plugin-prettier":"^2.6.0","pkg-ok":"^1.1.0","prettier":"1.12.1","tape":"^4.9.1"},"dependencies":{"semver-compare":"^1.0.0"},"gitHead":"416a85bbd10518732b477abf548aa7ce07e9a7f6","_id":"please-upgrade-node@3.1.1","_npmVersion":"5.8.0","_nodeVersion":"9.8.0","_npmUser":{"name":"typicode","email":"typicode@gmail.com"},"dist":{"shasum":"ed320051dfcc5024fae696712c8288993595e8ac","size":2514,"noattachment":false,"key":"/please-upgrade-node/-/please-upgrade-node-3.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/please-upgrade-node/download/please-upgrade-node-3.1.1.tgz"},"maintainers":[{"name":"typicode","email":"typicode@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/please-upgrade-node_3.1.1_1530748936851_0.027606491005582656"},"_hasShrinkwrap":false,"publish_time":1530748936928,"_cnpm_publish_time":1530748936928},"3.1.0":{"name":"please-upgrade-node","version":"3.1.0","description":"Displays a beginner-friendly message telling your user to upgrade their version of Node","main":"index.js","scripts":{"test":"node test","lint":"eslint .","fix":"npm run lint -- --fix","prepublishOnly":"npm test && npm run lint && pkg-ok"},"repository":{"type":"git","url":"git+https://github.com/typicode/please-upgrade-node.git"},"keywords":["node","engines","version","check","verify","upgrade"],"author":{"name":"typicode"},"license":"MIT","bugs":{"url":"https://github.com/typicode/please-upgrade-node/issues"},"homepage":"https://github.com/typicode/please-upgrade-node#readme","devDependencies":{"eslint":"^4.19.1","eslint-plugin-prettier":"^2.6.0","pkg-ok":"^1.1.0","prettier":"1.12.1","tape":"^4.9.1"},"dependencies":{"semver-compare":"^1.0.0"},"gitHead":"09cc4352d04fd202564e1ca77cd5662c191b5056","_id":"please-upgrade-node@3.1.0","_npmVersion":"5.8.0","_nodeVersion":"9.8.0","_npmUser":{"name":"typicode","email":"typicode@gmail.com"},"dist":{"shasum":"a2616de1d52b851949f2ab2d89b3e0ba28a02042","size":2495,"noattachment":false,"key":"/please-upgrade-node/-/please-upgrade-node-3.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/please-upgrade-node/download/please-upgrade-node-3.1.0.tgz"},"maintainers":[{"name":"typicode","email":"typicode@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/please-upgrade-node_3.1.0_1530569254191_0.2097485839085591"},"_hasShrinkwrap":false,"publish_time":1530569254250,"_cnpm_publish_time":1530569254250},"3.0.2":{"name":"please-upgrade-node","version":"3.0.2","description":"Displays a beginner-friendly message telling your user to upgrade their version of Node","main":"index.js","scripts":{"test":"node test","prepublishOnly":"pkg-ok","fix":"prettier --write *.js"},"repository":{"type":"git","url":"git+https://github.com/typicode/please-upgrade-node.git"},"keywords":["node","engines","version","check","verify","upgrade"],"author":{"name":"typicode"},"license":"MIT","bugs":{"url":"https://github.com/typicode/please-upgrade-node/issues"},"homepage":"https://github.com/typicode/please-upgrade-node#readme","devDependencies":{"mock-require":"^2.0.2","pkg-ok":"^1.1.0","prettier":"^1.5.2"},"dependencies":{"semver-compare":"^1.0.0"},"gitHead":"d6109c499055e0372cdf62fbdc42781958182a42","_id":"please-upgrade-node@3.0.2","_npmVersion":"5.6.0","_nodeVersion":"9.11.1","_npmUser":{"name":"typicode","email":"typicode@gmail.com"},"dist":{"shasum":"7b9eaeca35aa4a43d6ebdfd10616c042f9a83acc","size":2112,"noattachment":false,"key":"/please-upgrade-node/-/please-upgrade-node-3.0.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/please-upgrade-node/download/please-upgrade-node-3.0.2.tgz"},"maintainers":[{"name":"typicode","email":"typicode@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/please-upgrade-node_3.0.2_1524695086221_0.8313554362912727"},"_hasShrinkwrap":false,"publish_time":1524695086352,"_cnpm_publish_time":1524695086352},"3.0.1":{"name":"please-upgrade-node","version":"3.0.1","description":"Displays a beginner-friendly message telling your user to upgrade their version of Node","main":"index.js","scripts":{"test":"node test","prepublishOnly":"pkg-ok","fix":"prettier --write *.js"},"repository":{"type":"git","url":"git+https://github.com/typicode/please-upgrade-node.git"},"keywords":["node","engines","version","check","verify","upgrade"],"author":{"name":"typicode"},"license":"MIT","bugs":{"url":"https://github.com/typicode/please-upgrade-node/issues"},"homepage":"https://github.com/typicode/please-upgrade-node#readme","devDependencies":{"mock-require":"^2.0.2","pkg-ok":"^1.1.0","prettier":"^1.5.2"},"gitHead":"f8bf463e7d50c7a88ae2b02394cfbbd5bb75733f","_id":"please-upgrade-node@3.0.1","_shasum":"0a681f2c18915e5433a5ca2cd94e0b8206a782db","_from":".","_npmVersion":"2.15.11","_nodeVersion":"0.12.18","_npmUser":{"name":"typicode","email":"typicode@gmail.com"},"dist":{"shasum":"0a681f2c18915e5433a5ca2cd94e0b8206a782db","size":2495,"noattachment":false,"key":"/please-upgrade-node/-/please-upgrade-node-3.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/please-upgrade-node/download/please-upgrade-node-3.0.1.tgz"},"maintainers":[{"name":"typicode","email":"typicode@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/please-upgrade-node-3.0.1.tgz_1501534322979_0.9684319840744138"},"directories":{},"publish_time":1501534323914,"_cnpm_publish_time":1501534323914,"_hasShrinkwrap":false,"deprecated":"critical bug with Node 10+ fixed in v3.0.2, please upgrade"},"3.0.0":{"name":"please-upgrade-node","version":"3.0.0","description":"Displays a beginner-friendly message telling your user to upgrade their version of Node","main":"index.js","scripts":{"test":"node test","prepublishOnly":"pkg-ok","fix":"prettier --write *.js"},"repository":{"type":"git","url":"git+https://github.com/typicode/please-upgrade-node.git"},"keywords":["node","engines","version","check","verify","upgrade"],"author":{"name":"typicode"},"license":"MIT","bugs":{"url":"https://github.com/typicode/please-upgrade-node/issues"},"homepage":"https://github.com/typicode/please-upgrade-node#readme","devDependencies":{"mock-require":"^2.0.2","pkg-ok":"^1.1.0","prettier":"^1.5.2"},"gitHead":"3a27857b03d2f96be7a93bb9f66d46ff15faaa9f","_id":"please-upgrade-node@3.0.0","_npmVersion":"5.3.0","_nodeVersion":"8.2.1","_npmUser":{"name":"typicode","email":"typicode@gmail.com"},"dist":{"shasum":"4515ea23f77098a83ddd78ca2c6dd9e7c2f12d11","size":2045,"noattachment":false,"key":"/please-upgrade-node/-/please-upgrade-node-3.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/please-upgrade-node/download/please-upgrade-node-3.0.0.tgz"},"maintainers":[{"name":"typicode","email":"typicode@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/please-upgrade-node-3.0.0.tgz_1501533067493_0.44792803400196135"},"directories":{},"publish_time":1501533068419,"_cnpm_publish_time":1501533068419,"_hasShrinkwrap":false,"deprecated":"critical bug with Node 10+ fixed in v3.0.2, please upgrade"},"2.0.0":{"name":"please-upgrade-node","version":"2.0.0","description":"Displays a beginner-friendly message telling your user to upgrade their version of Node","main":"index.js","scripts":{"test":"node test","prepublishOnly":"pkg-ok","precommit":"npm test","fix":"prettier --write *.js"},"repository":{"type":"git","url":"git+https://github.com/typicode/please-upgrade-node.git"},"keywords":["node","engines","version","check","verify","upgrade"],"author":{"name":"typicode"},"license":"MIT","bugs":{"url":"https://github.com/typicode/please-upgrade-node/issues"},"homepage":"https://github.com/typicode/please-upgrade-node#readme","devDependencies":{"mock-require":"^2.0.2","pkg-ok":"^1.1.0","prettier":"^1.5.2"},"gitHead":"6911c3f9e1c590402535f443fa0d6e0e48c4633e","_id":"please-upgrade-node@2.0.0","_npmVersion":"5.0.3","_nodeVersion":"8.1.0","_npmUser":{"name":"typicode","email":"typicode@gmail.com"},"dist":{"shasum":"7943c577f1fd81182fa00e32039c690d7a8c3ecb","size":2591,"noattachment":false,"key":"/please-upgrade-node/-/please-upgrade-node-2.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/please-upgrade-node/download/please-upgrade-node-2.0.0.tgz"},"maintainers":[{"name":"typicode","email":"typicode@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/please-upgrade-node-2.0.0.tgz_1500927535265_0.4033139774110168"},"directories":{},"publish_time":1500927536200,"_hasShrinkwrap":false,"_cnpm_publish_time":1500927536200,"deprecated":"critical bug with Node 10+ fixed in v3.0.2, please upgrade"},"1.0.1":{"name":"please-upgrade-node","version":"1.0.1","description":"Displays a beginner-friendly message telling your user to upgrade their version of Node","main":"index.js","scripts":{"test":"node test","prepublishOnly":"pkg-ok","precommit":"npm test","fix":"prettier --write *.js"},"repository":{"type":"git","url":"git+https://github.com/typicode/please-upgrade-node.git"},"keywords":["node","engines","version","check","verify","upgrade"],"author":{"name":"typicode"},"license":"MIT","bugs":{"url":"https://github.com/typicode/please-upgrade-node/issues"},"homepage":"https://github.com/typicode/please-upgrade-node#readme","devDependencies":{"pkg-ok":"^1.1.0","prettier":"^1.5.2"},"gitHead":"933f7a6beb7f0fb7b3b66a7ceb4a2b67003ba8bb","_id":"please-upgrade-node@1.0.1","_npmVersion":"5.1.0","_nodeVersion":"8.1.2","_npmUser":{"name":"typicode","email":"typicode@gmail.com"},"dist":{"shasum":"f92dd3443d9797f5742510ea2fd205f811b3b1f7","size":2439,"noattachment":false,"key":"/please-upgrade-node/-/please-upgrade-node-1.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/please-upgrade-node/download/please-upgrade-node-1.0.1.tgz"},"maintainers":[{"name":"typicode","email":"typicode@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/please-upgrade-node-1.0.1.tgz_1499684886966_0.4267589938826859"},"directories":{},"publish_time":1499684887928,"_cnpm_publish_time":1499684887928,"_hasShrinkwrap":false,"deprecated":"critical bug with Node 10+ fixed in v3.0.2, please upgrade"},"1.0.0":{"name":"please-upgrade-node","version":"1.0.0","description":"Displays a beginner-friendly message telling your user to upgrade their version of Node","main":"index.js","scripts":{"test":"node test","prepublishOnly":"pkg-ok","precommit":"npm test","fix":"prettier --write *.js"},"repository":{"type":"git","url":"git+https://github.com/typicode/please-upgrade-node.git"},"keywords":["node","engines","version","check","verify","upgrade"],"author":{"name":"typicode"},"license":"MIT","bugs":{"url":"https://github.com/typicode/please-upgrade-node/issues"},"homepage":"https://github.com/typicode/please-upgrade-node#readme","devDependencies":{"pkg-ok":"^1.1.0","prettier":"^1.5.2"},"gitHead":"75547d092c11ce78a12e9111576618ec1221f652","_id":"please-upgrade-node@1.0.0","_npmVersion":"5.1.0","_nodeVersion":"8.1.2","_npmUser":{"name":"typicode","email":"typicode@gmail.com"},"dist":{"shasum":"6de252cf9e9bf07d5378dc3919575b960bfc374e","size":2438,"noattachment":false,"key":"/please-upgrade-node/-/please-upgrade-node-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/please-upgrade-node/download/please-upgrade-node-1.0.0.tgz"},"maintainers":[{"name":"typicode","email":"typicode@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/please-upgrade-node-1.0.0.tgz_1499523801861_0.22819634550251067"},"directories":{},"publish_time":1499523802809,"_hasShrinkwrap":false,"_cnpm_publish_time":1499523802809,"deprecated":"critical bug with Node 10+ fixed in v3.0.2, please upgrade"}},"readme":"# Please upgrade Node [![](http://img.shields.io/npm/dm/please-upgrade-node.svg?style=flat)](https://www.npmjs.org/package/please-upgrade-node) [![Build Status](https://travis-ci.org/typicode/please-upgrade-node.svg?branch=master)](https://travis-ci.org/typicode/please-upgrade-node) [![npm](https://img.shields.io/npm/v/please-upgrade-node.svg)](https://www.npmjs.com/package/please-upgrade-node)\n\n> :information_desk_person: show a message to your users to upgrade Node instead of a stacktrace \n\nIt's common for new Node users to miss or not understand engines warning when installing a CLI. This package displays a beginner-friendly message if their Node version is below the one expected.\n\n```sh\n$ node -v\n0.12\n\n$ modern-cli\nmodern-cli requires at least version 6 of Node, please upgrade\n```\n\n## Support\n\nIf you like this project, you can support me on [GitHub Sponsors](https://github.com/users/typicode/sponsorship)\n\n## Usage\n\n```sh\nnpm install please-upgrade-node\n```\n\nAdd `please-upgrade-node` at the top of your CLI\n\n```js\n#!/usr/bin/env node\nconst pkg = require('./package.json')\nrequire('please-upgrade-node')(pkg) // <- Must run BEFORE requiring any other modules\n\n// ...\n```\n\nSet in your `package.json` the required Node version\n\n```js\n{\n  \"engines\": {\n    \"node\": \">=6\"\n  }\n}\n```\n\n__Important__: `>=` is the only operator supported by `please-upgrade-node` (e.g. `>=6`, `>=6.0`, `>=6.0.0`).\n\n## Options\n\nYou can set custom `exitCode` and `message` function if needed\n\n```js\npleaseUpgradeNode(pkg, {\n  exitCode: 0, // Default: 1\n  message: function(requiredVersion) {\n    return 'Oops this program require Node ' +  requiredVersion\n  }\n})\n```\n\n__Important__: to keep `message` function compatible with older versions of Node, avoid using ES6 features like `=>` or string interpolation.\n\n## See also\n\n* [pkg-ok](https://github.com/typicode/pkg-ok) - :ok_hand: Prevents publishing a module with bad paths\n* [husky](https://github.com/typicode/husky) - :dog: Git hooks made easy\n* [update-notifier](https://github.com/yeoman/update-notifier) - Update notifications for your CLI app \n\nThanks to [zeit/serve](https://github.com/zeit/serve) for the error message inspiration.\n\n## License\n\nMIT - [Typicode :cactus:](https://github.com/typicode) - [Patreon](https://patreon.com/typicode)\n","_attachments":{},"homepage":"https://github.com/typicode/please-upgrade-node#readme","bugs":{"url":"https://github.com/typicode/please-upgrade-node/issues"},"license":"MIT"}