Merge branch 'feat-7' into alpha

Author: dominykas

.gitignore

@@ -1,6 +1,6 @@
 **/node_modules
-**/package-lock.json
-**/npm-shrinkwrap.json
+/package-lock.json
+/npm-shrinkwrap.json
 
 coverage.*
 *.log*

README.md

@@ -26,7 +26,9 @@ Prints supported Node.js versions for the package at the git URL.
 
 ### Options
 
-* `--deps` - include the support information of all dependencies
+* `--deep` - when used with --deps, include indirect dependencies
+* `--deps` - include the support information of direct production dependencies
+* `--dev` - when used with --deps, include dev dependencies
 
 ## Usage (library)
 
@@ -56,7 +58,9 @@ const result = await require('detect-node-support').detect(what, options);
 
 ### Options
 
+- `deep: false` - when `true` and used `deps: true`, include indirect dependencies
 - `deps: false` - when `true`, include the support information of all dependencies.
+- `dev: false` - when `true` and used with `deps: true`, include dev dependencies
 
 ### Result
 
@@ -124,7 +128,16 @@ const result = {
         // will contain a list of unique versions for each dependency found in the dependency tree
         "versions": {
             "dependency-A": ["0.0.10", "1.2.5"],
-            "dependency-B": ["0.5.3", "1.0.0"]
+            "dependency-B": ["0.5.3", "1.0.0"],
+            "dependency-C": ["7.8.9"]
+        },
+        
+        // will contain a list of errors that were encountered while resolving dependency support information
+        "errors": {
+            "dependency-C": {
+                // the `message` will always be either a string or `null`
+                "message": "Failed to download some information or something"
+            }       
         }       
     }
 }

bin/detect-node-support

@@ -12,25 +12,33 @@ const internals = {};
 internals.help = () => {
 
     return `
-Usage: detect-node-support [--deps] [--json] <what>
+Usage: detect-node-support [--deps] [--dev] [--deep] [--json] <what>
 
   <what> can be an npm package name, or a Github URL, or a path 
   with a package.json.
 
 Options:
-  --deps    Include the support information of all dependencies
+  --deep    When used with --deps, include indirect dependencies
+  --deps    Include the support information of direct production dependencies
+  --dev     When used with --deps, include direct dev dependencies
   --json    Print JSON formatted output
 `;
 };
 
-exports.main = async ({ _: [what], deps, json }) => {
+exports.main = async ({ _: [what], deps, deep, dev, json }) => {
 
     if (!what) {
         console.log(internals.help());
         return;
     }
 
-    const result = await NodeSupport.detect(what, { deps });
+    if (!deps && (deep || dev)) {
+        console.log('--deep and --dev can only be used together with --deps\n');
+        console.log(internals.help());
+        return;
+    }
+
+    const result = await NodeSupport.detect(what, { deps, deep, dev });
 
     if (json) {
         console.log(JSON.stringify(result, null, '  '));
@@ -40,7 +48,7 @@ exports.main = async ({ _: [what], deps, json }) => {
     }
 };
 
-exports.main(Minimist(process.argv.slice(2), { boolean: ['deps', 'json'] }))
+exports.main(Minimist(process.argv.slice(2), { boolean: ['deps', 'dev', 'deep', 'json'] }))
     .catch((err) => {
 
         console.error(err);

lib/deps.js

@@ -1,15 +1,20 @@
 'use strict';
 
+const Debug = require('debug');
 const { Arborist } = require('@npmcli/arborist');
 const Fs = require('fs');
 const Path = require('path');
-const Tempy = require('tempy');
+const Tmp = require('tmp');
 
 const Package = require('./package');
+const Utils = require('./utils');
 
 const internals = {};
 
 
+internals.log = Debug('detect-node-support');
+
+
 internals.walk = (node, callback) => {
 
     callback(node);
@@ -21,15 +26,29 @@ internals.walk = (node, callback) => {
 };
 
 
-exports.resolve = async ({ packageJson, lockfile }) => {
+internals.resolve = async ({ packageJson, lockfile }, options) => {
+
+    const { deep, dev } = options;
+
+    const tmpDir = Tmp.dirSync({ unsafeCleanup: true });
+    const path = tmpDir.name;
 
-    const path = Tempy.directory();
     Fs.writeFileSync(Path.join(path, 'package.json'), JSON.stringify(packageJson, null, '  '));
 
     if (lockfile) {
         Fs.writeFileSync(Path.join(path, 'package-lock.json'), JSON.stringify(lockfile, null, '  '));
     }
 
+    const direct = new Set();
+    ['dependencies', 'devDependencies', 'peerDependencies', 'optionalDependencies'].forEach((depType) => {
+
+        if (!packageJson[depType]) {
+            return;
+        }
+
+        Object.keys(packageJson[depType]).forEach((dep) => direct.add(dep));
+    });
+
     const arborist = new Arborist({ path });
 
     await arborist.buildIdealTree();
@@ -38,11 +57,23 @@ exports.resolve = async ({ packageJson, lockfile }) => {
 
     internals.walk(arborist.idealTree, (node) => {
 
-        if (node === arborist.idealTree) {
+        if (node.isRoot) {
+            return;
+        }
+
+        if (!dev && node.dev) {
+            // only include dev deps when `options.dev` flag is set
+            return;
+        }
+
+        if (!deep && !node.parent.isRoot) {
+            // only include deep deps when `options.deep` flag is set
             return;
         }
 
-        if (node.dev) {
+        if (!deep && !direct.has(node.name)) {
+            // only include deep deps when `options.deep` flag is set
+            // workaround for https://github.com./npm/arborist/issues/60
             return;
         }
 
@@ -56,6 +87,8 @@ exports.resolve = async ({ packageJson, lockfile }) => {
         result[name] = [...map[name]];
     }
 
+    tmpDir.removeCallback();
+
     return result;
 };
 
@@ -71,23 +104,42 @@ internals.tryLoad = async (loadFile, filename) => {
     }
 };
 
-exports.detect = async ({ packageJson, loadFile }) => {
+exports.detect = async ({ packageJson, loadFile }, options) => {
 
     const lockfile = (await internals.tryLoad(loadFile, 'package-lock.json')) || (await internals.tryLoad(loadFile, 'npm-shrinkwrap.json'));
+    internals.log(lockfile ? 'Lock file present' : 'Lock file missing - things will be a bit slower');
 
-    const versions = await exports.resolve({ packageJson, lockfile });
+    const versions = await internals.resolve({ packageJson, lockfile }, options);
 
     const support = [];
+    const errors = {};
+    let hasErrors = false;
+
+    const packages = Object.keys(versions).sort();
+    const n = packages.length;
+
+    for (let i = 0; i < n; ++i) {
+
+        const packageName = packages[i];
+        internals.log(`Resolving dependency ${i + 1} of ${n}: ${packageName}`);
 
-    for (const packageName of Object.keys(versions)) {
         try {
             const { result } = await Package.detect({ packageName });
             support.push(result);
         }
         catch (err) {
-            console.warn(`Failed to detect support for ${packageName}: ${err && err.message}`);
+            hasErrors = true;
+            errors[packageName] = {
+                message: Utils.getErrorMessage(err)
+            };
         }
     }
 
-    return { support, versions };
+    const result = { support, versions };
+
+    if (hasErrors) {
+        result.errors = errors;
+    }
+
+    return result;
 };

lib/index.js

@@ -3,12 +3,12 @@
 const Deps = require('./deps');
 const Package = require('./package');
 
-exports.detect = async function (what, { deps } = {}) {
+exports.detect = async function (what, { deps, deep, dev } = {}) {
 
     const { result, meta } = await Package.detect(what);
 
     if (deps) {
-        result.dependencies = await Deps.detect(meta);
+        result.dependencies = await Deps.detect(meta, { deep, dev });
     }
 
     return result;

lib/utils.js

@@ -4,5 +4,21 @@ const SimpleGit = require('simple-git/promise');
 
 /* $lab:coverage:off$ */
 // this is wrapped primarily to be able to stub it
-exports.simpleGit = (...args) => SimpleGit(...args);
+exports.simpleGit = (...args) => {
+
+    return SimpleGit(...args);
+};
 /* $lab:coverage:on$ */
+
+exports.getErrorMessage = (error) => {
+
+    if (typeof error === 'string') {
+        return error;
+    }
+
+    if (error && error.message) {
+        return error.message;
+    }
+
+    return null;
+};

package.json

@@ -32,18 +32,18 @@
     "@hapi/lab": "^22.0.0",
     "allow-scripts": "^1.5.2",
     "nock": "^12.0.1",
-    "sinon": "^9.0.0",
-    "tmp": "^0.1.0"
+    "sinon": "^9.0.0"
   },
   "dependencies": {
     "@hapi/wreck": "^17.0.0",
-    "@npmcli/arborist": "0.0.0-pre.13",
+    "@npmcli/arborist": "0.0.0-pre.14",
     "@pkgjs/nv": "0.0.3",
+    "debug": "^4.1.1",
     "git-url-parse": "^11.1.2",
     "js-yaml": "^3.13.1",
     "minimist": "^1.2.5",
     "pacote": "^11.1.0",
     "simple-git": "^1.131.0",
-    "tempy": "^0.5.0"
+    "tmp": "^0.1.0"
   }
 }

test/deps.js

@@ -0,0 +1,12 @@
+{
+  "name": "@pkgjs/detect-node-support-deps-test",
+  "version": "0.0.0-development",
+  "private": true,
+  "dependencies": {
+    "is-ci": "^2.0.0",
+    "ci-info": "^1.6.0"
+  },
+  "devDependencies": {
+    "debug": "^4.1.1"
+  }
+}