feat: add flags to scan full tree and dev deps (off by default)

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 direct dev dependencies
+* `--deps` - include the support information of direct production dependencies
+* `--dev` - when used with --deps, include indirect dependencies
 
 ## Usage (library)
 

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

@@ -21,7 +21,9 @@ internals.walk = (node, callback) => {
 };
 
 
-exports.resolve = async ({ packageJson, lockfile }) => {
+exports.resolve = async ({ packageJson, lockfile }, options) => {
+
+    const { deep, dev } = options;
 
     const path = Tempy.directory();
     Fs.writeFileSync(Path.join(path, 'package.json'), JSON.stringify(packageJson, null, '  '));
@@ -38,11 +40,17 @@ exports.resolve = async ({ packageJson, lockfile }) => {
 
     internals.walk(arborist.idealTree, (node) => {
 
-        if (node === arborist.idealTree) {
+        if (node.isTop) {
+            return;
+        }
+
+        if (!dev && node.dev) {
+            // only include dev deps when `options.dev` flag is set
             return;
         }
 
-        if (node.dev) {
+        if (!deep && !node.parent.isTop) {
+            // only include deep deps when `options.deep` flag is set
             return;
         }
 
@@ -71,11 +79,11 @@ 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'));
 
-    const versions = await exports.resolve({ packageJson, lockfile });
+    const versions = await exports.resolve({ packageJson, lockfile }, options);
 
     const support = [];
 

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;

package.json

@@ -37,7 +37,7 @@
   },
   "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",
     "git-url-parse": "^11.1.2",
     "js-yaml": "^3.13.1",

test/deps.js

@@ -13,12 +13,53 @@ describe('Deps', () => {
 
     describe('resolve', () => {
 
-        it('returns flattened list of deps', async () => {
+        it('returns flattened list of direct prod deps', async () => {
 
             const result = await Deps.resolve({
-                packageJson: JSON.parse(Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test-package.json'))),
-                lockfile: JSON.parse(Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test-lock.json')))
+                packageJson: JSON.parse(Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test', 'package.json'))),
+                lockfile: JSON.parse(Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test', 'npm-shrinkwrap.json')))
+            }, {});
+
+            expect(result).to.equal({
+                'ci-info': ['1.6.0'],
+                'is-ci': ['2.0.0']
+            });
+        });
+
+        it('returns flattened list of all deps', async () => {
+
+            const result = await Deps.resolve({
+                packageJson: JSON.parse(Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test', 'package.json'))),
+                lockfile: JSON.parse(Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test', 'npm-shrinkwrap.json')))
+            }, { deep: true, dev: true });
+
+            expect(result).to.equal({
+                'ci-info': ['1.6.0', '2.0.0'],
+                'is-ci': ['2.0.0'],
+                'ms': ['2.1.2']
             });
+        });
+
+        it('returns flattened list of deps (only direct)', async () => {
+
+            const result = await Deps.resolve({
+                packageJson: JSON.parse(Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test', 'package.json'))),
+                lockfile: JSON.parse(Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test', 'npm-shrinkwrap.json')))
+            }, { dev: true });
+
+            expect(result).to.equal({
+                'ci-info': ['1.6.0'],
+                'is-ci': ['2.0.0'],
+                'ms': ['2.1.2']
+            });
+        });
+
+        it('returns flattened list of deps (only prod)', async () => {
+
+            const result = await Deps.resolve({
+                packageJson: JSON.parse(Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test', 'package.json'))),
+                lockfile: JSON.parse(Fs.readFileSync(Path.join(__dirname, 'fixtures', 'deps-test', 'npm-shrinkwrap.json')))
+            }, { deep: true });
 
             expect(result).to.equal({
                 'ci-info': ['1.6.0', '2.0.0'],

test/fixtures/deps-test-lock.json renamed to test/fixtures/deps-test/npm-shrinkwrap.json

@@ -3,5 +3,8 @@
   "dependencies": {
     "is-ci": "^2.0.0",
     "ci-info": "^1.6.0"
+  },
+  "devDependencies": {
+    "ms": "^2.1.2"
   }
 }