@smarlhens/npm-check-engines 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.7.0](https://github.com/smarlhens/npm-check-engines/compare/v0.6.0...v0.7.0) (2022-07-03)
+
+
+### Features
+
+* tips to upgrade package.json when new computed range constraints are available ([17ea35f](https://github.com/smarlhens/npm-check-engines/commit/17ea35f2e0eb2240c85c46fc16fdef25411d0188))
+
+
+### Documentation
+
+* **readme:** add missing thanks link in toc ([0e579a4](https://github.com/smarlhens/npm-check-engines/commit/0e579a4d475936c59595ac18301c0ac0c600fe76))
+
 ## [0.6.0](https://github.com/smarlhens/npm-check-engines/compare/v0.5.0...v0.6.0) (2022-07-03)
 
 

package/README.md

@@ -19,6 +19,7 @@
 - [Usage](#usage)
 - [Options](#options)
 - [Debug](#debug)
+- [Thanks](#thanks)
 
 ---
 
@@ -53,6 +54,8 @@ $ nce
 ✔ Computed engines range constraints:
 
  node  *  →  ^14.17.0 || ^16.10.0 || >=17.0.0
+
+Run nce -u to upgrade package.json.
 ```
 
 Upgrade a project's `package.json` file:
@@ -166,12 +169,16 @@ $ DEBUG=* nce -d
 [TITLE] Computed engines range constraints:
 [TITLE]
 [TITLE]  node  *  →  ^14.17.0 || ^16.10.0 || >=17.0.0
+[TITLE]
+[TITLE] Run nce -p examples -d -u to upgrade package.json.
 [SUCCESS] Output computed engines range constraints...
 [STARTED] Update package.json file...
 [SKIPPED] Update is disabled by default.
 [SUCCESS] Computed engines range constraints:
 [SUCCESS]
 [SUCCESS]  node  *  →  ^14.17.0 || ^16.10.0 || >=17.0.0
+[SUCCESS]
+[SUCCESS] Run nce -p examples -d -u to upgrade package.json.
 ```
 
 </details>

package/dist/lib/tasks.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cliCommandTask = exports.checkCommandTasks = exports.updatePackageJson = exports.outputComputedConstraints = exports.computeEnginesConstraints = exports.loadPackageLockFile = exports.loadPackageFile = exports.humanizeRange = exports.restrictiveRange = exports.applyMinVersionToRangeSet = exports.setToRange = exports.sortRangeSet = exports.rangeOptions = void 0;
+exports.cliCommandTask = exports.checkCommandTasks = exports.updatePackageJson = exports.outputComputedConstraints = exports.generateUpdateCommandFromContext = exports.computeEnginesConstraints = exports.loadPackageLockFile = exports.loadPackageFile = exports.humanizeRange = exports.restrictiveRange = exports.applyMinVersionToRangeSet = exports.setToRange = exports.sortRangeSet = exports.rangeOptions = void 0;
 const tslib_1 = require("tslib");
 const cli_table_1 = tslib_1.__importDefault(require("cli-table"));
 const colorette_1 = require("colorette");
@@ -244,8 +244,33 @@ const createEnginesTable = (colWidths) => {
         },
     });
 };
+const generateUpdateCommandFromContext = (ctx) => {
+    const argv = ['nce'];
+    let path = undefined;
+    if (typeof ctx.path === 'string' && ctx.path.length > 0) {
+        path = (0, utils_1.getRelativePath)({ path: ctx.path, workingDir: ctx.workingDir });
+    }
+    if (typeof path === 'string' && path.length > 0) {
+        argv.push(...['-p', path]);
+    }
+    if (ctx.engines) {
+        argv.push(...ctx.engines.map(e => ['-e', e]).flat());
+    }
+    if (ctx.quiet) {
+        argv.push('-q');
+    }
+    if (ctx.debug) {
+        argv.push('-d');
+    }
+    if (ctx.verbose) {
+        argv.push('-v');
+    }
+    argv.push('-u');
+    return argv.join(' ');
+};
+exports.generateUpdateCommandFromContext = generateUpdateCommandFromContext;
 const outputComputedConstraints = ({ ctx, parent, debug }) => {
-    const { ranges } = ctx;
+    const { ranges, packageObject, update } = ctx;
     if (!ranges) {
         throw new Error(`Computed engines range constraints are not defined.`);
     }
@@ -275,7 +300,11 @@ const outputComputedConstraints = ({ ctx, parent, debug }) => {
     else {
         const table = createEnginesTable(colWidths);
         table.push(...colValues);
-        parent.title = `Computed engines range constraints:\n\n${table.toString()}`;
+        let title = `Computed engines range constraints:\n\n${table.toString()}`;
+        if (!update) {
+            title += `\n\nRun ${(0, colorette_1.cyan)((0, exports.generateUpdateCommandFromContext)(ctx))} to upgrade ${packageObject.filename}.`;
+        }
+        parent.title = title;
     }
     ctx.rangesSimplified = rangesSimplified;
 };

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@smarlhens/npm-check-engines",
-    "version": "0.6.0",
+    "version": "0.7.0",
     "description": "Node.JS engines constraint checker written in TypeScript.",
     "keywords": [
         "node",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smarlhens/npm-check-engines",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Node.JS engines constraint checker written in TypeScript.",
   "keywords": [
     "node",