@smarlhens/npm-check-engines 0.3.0 → 0.4.2

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # Changelog
 
+## [0.4.2](https://github.com/smarlhens/npm-check-engines/compare/v0.4.1...v0.4.2) (2022-06-08)
+
+
+### Chores
+
+* **deps:** update dependency @types/jest to v28.1.1 ([990732b](https://github.com/smarlhens/npm-check-engines/commit/990732b13009c8350232d112822589d7a9f9301c))
+* **deps:** update jest monorepo to v28.1.1 ([a05193b](https://github.com/smarlhens/npm-check-engines/commit/a05193b59324f417241b3e460f0e77fb322a9a5b))
+
+
+### Documentation
+
+* **readme:** add lgtm badges ([2dac6ac](https://github.com/smarlhens/npm-check-engines/commit/2dac6ac13c2b5568f1b84d3b623343275de3404f))
+
+
+### Miscellaneous
+
+* **release-please:** remove signoff option ([5ad0155](https://github.com/smarlhens/npm-check-engines/commit/5ad0155693846b1424e5592972aeee072cfddbb3))
+
+## [0.4.1](https://github.com/smarlhens/npm-check-engines/compare/v0.4.0...v0.4.1) (2022-06-04)
+
+
+### Bug Fixes
+
+* **deps:** update dependency colorette to v2.0.17 ([624217c](https://github.com/smarlhens/npm-check-engines/commit/624217cb2dfdb56149fc29b8461e814f7186902c))
+
+
+### Chores
+
+* **deps:** move form dependencies to devDependencies ([310248f](https://github.com/smarlhens/npm-check-engines/commit/310248fb9fb5e4b621b73c7784ac49ff415f9d2a))
+* **deps:** update commitlint monorepo to v17.0.2 ([9a05965](https://github.com/smarlhens/npm-check-engines/commit/9a059657a6a5a4a07e48323506a8d47360c7cf15))
+* **deps:** update dependency @types/jest to v28 ([63ce9fc](https://github.com/smarlhens/npm-check-engines/commit/63ce9fce0c86eb37903d790f94dbea01d727ee5d))
+* **deps:** update dependency lint-staged to v13 ([6b92d2e](https://github.com/smarlhens/npm-check-engines/commit/6b92d2eb4715d8832dc91262f500615562343878))
+* **deps:** update dependency ts-node to v10.8.1 ([82538fb](https://github.com/smarlhens/npm-check-engines/commit/82538fbdd2cdb74fba73a6d2080a67706e311ba2))
+* **deps:** update dependency typescript to v4.7.3 ([56913f7](https://github.com/smarlhens/npm-check-engines/commit/56913f7f21c0558564b1d6f43844489ad2fb7084))
+
+
+### Miscellaneous
+
+* **release-please:** update changelog-types, add documentation & chores sections ([710a11c](https://github.com/smarlhens/npm-check-engines/commit/710a11cb1c94b06e02d9bfa8399c9d29205ec6a4))
+
+## [0.4.0](https://github.com/smarlhens/npm-check-engines/compare/v0.3.0...v0.4.0) (2022-05-31)
+
+
+### Features
+
+* add cli engines option to choose specific engine(s) ([ec06756](https://github.com/smarlhens/npm-check-engines/commit/ec06756f34f0189689bf56670d8ae79c97ec6ce9))
+* add support for npm engine ([ae7df76](https://github.com/smarlhens/npm-check-engines/commit/ae7df76a7a695dd4d26e5ded05ecea3d85bde227))
+* add yarn engine ([69a4268](https://github.com/smarlhens/npm-check-engines/commit/69a4268a948762c942eb2aadf75d8db029da46f5))
+
 ## [0.3.0](https://github.com/smarlhens/npm-check-engines/compare/v0.2.0...v0.3.0) (2022-05-31)
 
 

package/README.md

@@ -1,6 +1,8 @@
 # NPM check engines
 
 [![GitHub CI](https://github.com/smarlhens/npm-check-engines/workflows/ci/badge.svg)](https://github.com/smarlhens/npm-check-engines/actions/workflows/ci.yml)
+[![Total alerts](https://img.shields.io/lgtm/alerts/g/smarlhens/npm-check-engines.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/smarlhens/npm-check-engines/alerts/)
+[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/smarlhens/npm-check-engines.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/smarlhens/npm-check-engines/context:javascript)
 ![node-current (scoped)](https://img.shields.io/node/v/@smarlhens/npm-check-engines)
 [![GitHub license](https://img.shields.io/github/license/smarlhens/npm-check-engines)](https://github.com/smarlhens/npm-check-engines)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

package/dist/lib/index.js

@@ -14,6 +14,7 @@ const nce = async (args) => {
         verbose: cliArgs.verbose || false,
         quiet: cliArgs.quiet || false,
         debug: cliArgs.debug || false,
+        engines: cliArgs.engines,
     };
     const options = Object.assign({}, (0, renderer_1.renderer)({ quiet: context.quiet, debug: context.debug, verbose: context.verbose }));
     const debugNamespaces = (0, debug_1.namespaces)();

package/dist/lib/tasks.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.cliCommandTask = exports.checkCommandTasks = exports.updatePackageJson = exports.outputComputedConstraints = exports.computeEnginesConstraints = exports.computeEnginesConstraint = exports.getConstraintFromEngines = exports.loadLockFile = exports.humanizeRange = exports.restrictiveRange = exports.applyMinVersionToRangeSet = exports.setToRange = exports.sortRangeSet = exports.rangeOptions = void 0;
 const tslib_1 = require("tslib");
 const listr2_1 = require("listr2");
+const types_1 = require("./types");
 const utils_1 = require("./utils");
 const json_schema_validator_1 = require("./json-schema-validator");
 const lodash_1 = require("lodash");
@@ -117,7 +118,7 @@ exports.loadLockFile = loadLockFile;
 const getConstraintFromEngines = (engines, constraintKey) => {
     var _a;
     if (typeof engines === 'object' && constraintKey in engines) {
-        return engines.node;
+        return engines[constraintKey];
     }
     else if ((0, lodash_1.isArray)(engines) && engines.some(constraint => constraint.includes(constraintKey))) {
         return (_a = engines.find(constraint => constraint.includes(constraintKey))) === null || _a === void 0 ? void 0 : _a.replace(constraintKey, '');
@@ -157,25 +158,33 @@ const computeEnginesConstraint = ({ packages, constraintKey, debug, }) => {
             debugConstraint(`${(0, colorette_1.white)('New most restrictive range:')} ${(0, colorette_1.green)(mrr.raw)}`);
         }
     }
-    if (!mrr) {
-        throw new Error(`Computed engine range constraint is not defined.`);
+    if (mrr) {
+        debugConstraint(`${(0, colorette_1.white)(`Final computed engine range constraint:`)} ${(0, colorette_1.blue)(mrr.raw)}`);
+    }
+    else {
+        debugConstraint(`${(0, colorette_1.white)(`No computed engine range constraint`)}`);
     }
-    debugConstraint(`${(0, colorette_1.white)(`Final computed engine range constraint:`)} ${(0, colorette_1.blue)(mrr.raw)}`);
     return mrr;
 };
 exports.computeEnginesConstraint = computeEnginesConstraint;
 const computeEnginesConstraints = ({ ctx, debug }) => {
-    const { packageLockObject } = ctx;
+    const { packageLockObject, engines } = ctx;
     if (!packageLockObject) {
         throw new Error(`${packageLockJSONFilename} data is not defined.`);
     }
     if (!('packages' in packageLockObject)) {
         throw new Error(`${packageLockJSONFilename} does not contain packages property.`);
     }
+    const filterEngineConstraintKey = (key) => -1 !== types_1.EngineConstraintKeys.indexOf(key);
     const packages = Object.entries(packageLockObject.packages);
     const ranges = new Map();
-    let constraintKey = 'node';
-    ranges.set(constraintKey, (0, exports.computeEnginesConstraint)({ packages, constraintKey, debug }));
+    const constraintKeys = (engines === null || engines === void 0 ? void 0 : engines.filter(filterEngineConstraintKey)) || [...types_1.EngineConstraintKeys];
+    if (0 === constraintKeys.length) {
+        throw new Error(`No valid constraint key(s).`);
+    }
+    for (const constraintKey of constraintKeys) {
+        ranges.set(constraintKey, (0, exports.computeEnginesConstraint)({ packages, constraintKey, debug }));
+    }
     ctx.ranges = ranges;
 };
 exports.computeEnginesConstraints = computeEnginesConstraints;

package/dist/lib/types.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EngineConstraintKeys = void 0;
-exports.EngineConstraintKeys = ['node'];
+exports.EngineConstraintKeys = ['node', 'npm', 'yarn'];

package/dist/lib/yargs.js

@@ -34,6 +34,11 @@ exports.cli = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
         default: false,
         description: 'A little more detailed than the default output.',
     },
+    engines: {
+        array: true,
+        alias: 'e',
+        description: 'Select engines to check. Default will check all engines defined.',
+    },
     update: {
         boolean: true,
         alias: 'u',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smarlhens/npm-check-engines",
-  "version": "0.3.0",
+  "version": "0.4.2",
   "description": "Node.JS engines constraint checker written in TypeScript.",
   "keywords": [
     "node",
@@ -51,42 +51,43 @@
     "ajv": "8.11.0",
     "ajv-draft-04": "1.0.0",
     "ajv-formats": "2.1.1",
-    "colorette": "2.0.16",
+    "colorette": "2.0.17",
     "debug": "4.3.4",
     "fs-extra": "10.1.0",
     "listr2": "4.0.5",
     "lodash": "4.17.21",
-    "rimraf": "3.0.2",
     "semver": "7.3.7",
     "sort-package-json": "1.57.0",
-    "tslib": "2.4.0",
     "yargs": "17.5.1"
   },
   "devDependencies": {
     "@babel/core": "7.18.2",
     "@babel/preset-env": "7.18.2",
     "@babel/preset-typescript": "7.17.12",
-    "@commitlint/cli": "17.0.1",
-    "@commitlint/config-conventional": "17.0.0",
+    "@commitlint/cli": "17.0.2",
+    "@commitlint/config-conventional": "17.0.2",
     "@types/debug": "4.1.7",
     "@types/fs-extra": "9.0.13",
-    "@types/jest": "27.5.1",
+    "@types/jest": "28.1.1",
     "@types/lodash": "4.14.182",
     "@types/node": "17.0.36",
     "@types/semver": "7.3.9",
     "@types/yargs": "17.0.10",
-    "babel-jest": "28.1.0",
+    "babel-jest": "28.1.1",
     "cz-conventional-changelog": "3.3.0",
     "execa": "5.1.1",
     "husky": "8.0.1",
-    "jest": "28.1.0",
-    "lint-staged": "12.5.0",
+    "jest": "28.1.1",
+    "lint-staged": "13.0.0",
     "prettier": "2.6.2",
-    "ts-node": "10.8.0",
-    "typescript": "4.7.2"
+    "rimraf": "3.0.2",
+    "ts-node": "10.8.1",
+    "tslib": "2.4.0",
+    "typescript": "4.7.3"
   },
   "engines": {
-    "node": "^14.17.0 || ^16.10.0 || ^18.0.0"
+    "node": "^14.17.0 || ^16.10.0 || ^18.0.0",
+    "npm": ">=6.0.0"
   },
   "publishConfig": {
     "tag": "latest"