please-upgrade-node - npm Package Compare versions

Comparing version 1.0.1 to 2.0.0

index.js

@@ -1,2 +0,4 @@
-module.exports = function(pkg) {
+module.exports = function (pkgDir) {
+  var dir = pkgDir || '.'
+  var pkg = require(dir + "/package.json");
   var requiredVersion = pkg.engines.node.replace(">=", "");
@@ -3,0 +5,0 @@ var currentVersion = process.version.replace("v", "");

package.json

 {
   "name": "please-upgrade-node",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "Displays a beginner-friendly message telling your user to upgrade their version of Node",
@@ -31,2 +31,3 @@ "main": "index.js",
   "devDependencies": {
+    "mock-require": "^2.0.2",
     "pkg-ok": "^1.1.0",
@@ -33,0 +34,0 @@ "prettier": "^1.5.2"

README.md

@@ -29,6 +29,5 @@ # 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)
 ```js
-// bin.js
-require('please-upgrade-node')(
-  require('./package.json')
-)
+// ./bin.js
+// by default, will load ./package.json
+require('please-upgrade-node')()
 
@@ -62,2 +61,16 @@ // The rest of your code...
 
+## API
+
+`pleaseUpgradeNode([pkgDir = '.'])`
+
+You can pass a `pkgDir` if your `package.json` is not at the same level:
+
+```js
+// ./package.json
+require('please-upgrade-node')()
+
+// ../../package.json
+require('please-upgrade-node')('../..')
+```
+
 ## Caveat
@@ -67,10 +80,11 @@
 
-For example, if you use `const` instead of `var` and don't transpile it, `please-upgrade-node` won't work with Node `0.12`:
+For example, if you use `const` instead of `var`, `please-upgrade-node` won't work with Node `0.12`:
 
 ```js
-const pkg = require('./package.json') // ← Will fail and exit here with Node 0.12,
-                                      // because const isn't supported.
-require('please-upgrade-node')(pkg)   // No upgrade message will be displayed :(
+const pleaseUpgradeNode = require('please-upgrade-node') // ← Will fail and exit here with Node 0.12,
+pleaseUpgradeNode() // Message won't be displayed
 ```
 
+To avoid any issues, the recommended syntax is `require('please-upgrade-node')()`.
+
 ## See also
@@ -77,0 +91,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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

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

5245

increased by9.87%

Lines of code

14

increased by16.67%

Number of lines in readme file

97

increased by16.87%

Worsened metrics

Dev dependency count

3

increased by50%

Number of low supply chain risk alerts

1

increased byInfinity%

No dependency changes