please-upgrade-node - npm Package Compare versions

Comparing version 3.1.1 to 3.2.0

.eslintrc.js

@@ -0,0 +0,0 @@ module.exports = {

index.js

@@ -0,0 +0,0 @@ var semverCompare = require('semver-compare')

package.json

 {
   "name": "please-upgrade-node",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "description": "Displays a beginner-friendly message telling your user to upgrade their version of Node",
@@ -33,2 +33,3 @@ "main": "index.js",
     "eslint-plugin-prettier": "^2.6.0",
+    "husky": "^1.0.0-rc.12",
     "pkg-ok": "^1.1.0",
@@ -40,3 +41,8 @@ "prettier": "1.12.1",
     "semver-compare": "^1.0.0"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm test && npm run lint"
+    }
   }
 }

README.md

@@ -5,3 +5,3 @@ # 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)
 
-It's common for new Node users to miss the `npm` engines warning when installing a CLI. This package displays a beginner-friendly message if their Node version is below the one expected.
+It'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.
 
@@ -16,4 +16,8 @@ ```sh
 
-## Install
+## Support
 
+If you like this project, you can support me on [GitHub Sponsors](https://github.com/users/typicode/sponsorship)
+
+## Usage
+
 ```sh
@@ -23,13 +27,16 @@ npm install please-upgrade-node
 
+Add `please-upgrade-node` at the top of your CLI
+
 ```js
 #!/usr/bin/env node
 const pkg = require('./package.json')
-require('please-upgrade-node')(pkg)
-// Must run BEFORE requiring other modules
+require('please-upgrade-node')(pkg) // <- Must run BEFORE requiring any other modules
+
+// ...
 ```
 
+Set in your `package.json` the required Node version
+
 ```js
-// package.json
 {
-  "bin": "./bin.js",
   "engines": {
@@ -45,9 +52,9 @@ "node": ">=6"
 
-You can also pass custom `exitCode` (default: `1`) or `message` function
+You can set custom `exitCode` and `message` function if needed
 
 ```js
 pleaseUpgradeNode(pkg, {
-  exitCode: 0,
+  exitCode: 0, // Default: 1
   message: function(requiredVersion) {
-    return 'Oops, this program requires Node ' + requiredVersion
+    return 'Oops this program require Node ' +  requiredVersion
   }
@@ -54,0 +61,0 @@ })

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5539

increased by7.8%

Number of package files

7

increased by40%

Lines of code

44

increased by25.71%

Number of lines in readme file

73

increased by10.61%

Worsened metrics

Dev dependency count

6

increased by20%

No dependency changes