docs: stub out deps option

Author: dominykas

README.md

@@ -5,45 +5,59 @@ List the Node.js versions supported by the package/repository
 ## Usage (command line)
 
 ```
-$ npx detect-node-support [path]
+$ npx detect-node-support [options] <path>
 ```
 
 Prints the supported Node.js versions for the package at the specified path. When the path is not a git repository - tries to read the git repository from `package.json` and tries to detect the versions listed in the repository as well.
 
 When `path` is omitted, tries to detect the versions for `cwd`. 
 
 ```
-$ npx detect-node-support [package name]
+$ npx detect-node-support [options] <package name>
 ```
 
 Prints supported Node.js versions for the package from the registry.
 
 ```
-$ npx detect-node-support [repository git URL]
+$ npx detect-node-support [options] <repository git URL>
 ```
 
 Prints supported Node.js versions for the package at the git URL.
 
+### Options
+
+* `--deps` - include the support information of all dependencies
+
 ## Usage (library)
 
 ```
-const result = await require('detect-node-support').detect({ path });
+const result = await require('detect-node-support').detect({ path }, options);
 ```
 
 `path` should be a folder in the local file system. When the path is not a git repository - tries to read the git repository from `package.json` and tries to detect the versions listed in the repository as well. 
 
 ```
-const result = await require('detect-node-support').detect({ packageName });
+const result = await require('detect-node-support').detect({ packageName }, options);
 ```
 
 `packageName` is a string name for the package in the registry. 
 
 ```
-const result = await require('detect-node-support').detect({ repository });
+const result = await require('detect-node-support').detect({ repository }, options);
 ```
 
 `repository` is a URL for a git repository.
 
+```
+const result = await require('detect-node-support').detect(what, options);
+```
+
+`what` is a string containing either a package name, or a local path, or a reference to a git repository.
+
+### Options
+
+- `deps: false` - when `true`, include the support information of all dependencies.
+
 ### Result
 
 - Throws if the `path` / `repository` does not have a `package.json`
@@ -88,6 +102,30 @@ const result = {
             "lts/*": "12.14.0",
             "invalid-specifier": false
         }       
+    },
+
+    // only present when explicitly requested
+    "dependencies": {
+
+        // will contain a support object for every unique dependency in the tree
+        // note that the `version` will be the _latest_ version available in the registry
+        // see below for the actual versions installed   
+        "support": [
+            { 
+                "name": "dependency-A" 
+                /*... other fields ...*/ 
+            },
+            { 
+                "name": "dependency-B" 
+                /*... other fields ...*/ 
+            }           
+        ],
+    
+        // 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"]
+        }       
     }
 }
 ```

bin/detect-node-support

@@ -2,28 +2,38 @@
 
 'use strict';
 
+const Minimist = require('minimist');
+
 const NodeSupport = require('..');
 
 const internals = {};
 
 internals.help = () => {
 
-    return `Usage: detect-node-support [ path | Github URL | npm package name ]`;
+    return `
+Usage: detect-node-support [--deps] <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
+`;
 };
 
-exports.main = async ([nodeBin, thisBin, what]) => {
+exports.main = async ({ _: [what], deps }) => {
 
     if (!what) {
         console.log(internals.help());
         return;
     }
 
-    const result = await NodeSupport.detect(what);
+    const result = await NodeSupport.detect(what, { deps });
 
     console.log(result);
 };
 
-exports.main(process.argv)
+exports.main(Minimist(process.argv.slice(2), { boolean: 'deps' }))
     .catch((err) => {
 
         console.error(err);

lib/index.js

@@ -1,10 +1,14 @@
 'use strict';
 
+const Assert = require('assert');
+
 const Engines = require('./engines');
 const Package = require('./package');
 const Travis = require('./travis');
 
-exports.detect = async function (what) {
+exports.detect = async function (what, { deps } = {}) {
+
+    Assert.ok(!deps, '`deps` support not implemented yet');
 
     const packageInfo = await Package.detect(what);
 

package.json

@@ -40,6 +40,7 @@
     "@pkgjs/nv": "0.0.3",
     "git-url-parse": "^11.1.2",
     "js-yaml": "^3.13.1",
+    "minimist": "^1.2.5",
     "pacote": "^11.1.0",
     "simple-git": "^1.131.0"
   }