dependency-tree 9.0.0 → 10.0.0

package/README.md

@@ -1,22 +1,28 @@
-### dependency-tree [![npm](http://img.shields.io/npm/v/dependency-tree.svg)](https://npmjs.org/package/dependency-tree) [![npm](http://img.shields.io/npm/dm/dependency-tree.svg)](https://npmjs.org/package/dependency-tree)
+# dependency-tree
+
+[![CI](https://img.shields.io/github/actions/workflow/status/dependents/node-dependency-tree/ci.yml?branch=main&label=CI&logo=github)](https://github.com/dependents/node-dependency-tree/actions/workflows/ci.yml?query=branch%3Amain)
+[![npm version](https://img.shields.io/npm/v/dependency-tree?logo=npm&logoColor=fff)](https://www.npmjs.com/package/dependency-tree)
+[![npm downloads](https://img.shields.io/npm/dm/dependency-tree)](https://www.npmjs.com/package/dependency-tree)
 
 > Get the dependency tree of a module
 
-`npm install --save dependency-tree`
+```sh
+npm install dependency-tree
+```
 
-* Works for JS (AMD, CommonJS, ES6 modules), Typescript, and CSS preprocessors (CSS (PostCSS), Sass, Stylus, and Less); basically, any module type supported by [Precinct](https://github.com/mrjoelkemp/node-precinct).
+* Works for JS (AMD, CommonJS, ES6 modules), Typescript, and CSS preprocessors (CSS (PostCSS), Sass, Stylus, and Less); basically, any module type supported by [Precinct](https://github.com/dependents/node-precinct).
   - For CommonJS modules, 3rd party dependencies (npm installed dependencies) are included in the tree by default
-  - Dependency path resolutions are handled by [filing-cabinet](https://github.com/mrjoelkemp/node-filing-cabinet)
+  - Dependency path resolutions are handled by [filing-cabinet](https://github.com/dependents/node-filing-cabinet)
   - Supports RequireJS and Webpack loaders
 * All core Node modules (assert, path, fs, etc) are removed from the dependency list by default
 
-### Usage
+## Usage
 
 ```js
-var dependencyTree = require('dependency-tree');
+const dependencyTree = require('dependency-tree');
 
 // Returns a dependency tree object for the given file
-var tree = dependencyTree({
+const tree = dependencyTree({
   filename: 'path/to/a/file',
   directory: 'path/to/all/files',
   requireConfig: 'path/to/requirejs/config', // optional
@@ -33,13 +39,13 @@ var tree = dependencyTree({
 // Returns a post-order traversal (list form) of the tree with duplicate sub-trees pruned.
 // This is useful for bundling source files, because the list gives the concatenation order.
 // Note: you can pass the same arguments as you would to dependencyTree()
-var list = dependencyTree.toList({
+const list = dependencyTree.toList({
   filename: 'path/to/a/file',
   directory: 'path/to/all/files'
 });
 ```
 
-#### Options
+### Options
 
 * `requireConfig`: path to a requirejs config for AMD modules (allows for the result of aliased module paths)
 * `webpackConfig`: path to a webpack config for aliased modules
@@ -54,7 +60,7 @@ var list = dependencyTree.toList({
   - See [precinct's usage docs](https://github.com/dependents/node-precinct#usage) for the list of module types you can pass options to.
 * `noTypeDefinitions`: For TypeScript imports, whether to resolve to `*.js` instead of `*.d.ts`.
 
-#### Format Details
+### Format Details
 
 The object form is a mapping of the dependency tree to the filesystem –
 where every key is an absolute filepath and the value is another object/subtree.
@@ -79,7 +85,7 @@ Example:
 This structure was chosen to serve as a visual representation of the dependency tree
 for use in the [Dependents](https://github.com/mrjoelkemp/sublime-dependents) plugin.
 
-##### CLI version
+### CLI version
 
 * Assumes a global install: `npm install -g dependency-tree`
 
@@ -91,9 +97,9 @@ Prints the dependency tree of the given filename as stringified json (by default
 
 * You can alternatively print out the list form one element per line using the `--list-form` option.
 
-### How does this work?
+## How does this work?
 
-Dependency tree takes in a starting file, extracts its declared dependencies via [precinct](https://github.com/dependents/node-precinct/), resolves each of those dependencies to a file on the filesystem via [filing-cabinet](https://github.com/dependents/node-filing-cabinet), then recursively performs those steps until there are no more dependencies to process. 
+Dependency tree takes in a starting file, extracts its declared dependencies via [precinct](https://github.com/dependents/node-precinct/), resolves each of those dependencies to a file on the filesystem via [filing-cabinet](https://github.com/dependents/node-filing-cabinet), then recursively performs those steps until there are no more dependencies to process.
 
 In more detail, the starting file is passed to precinct to extract dependencies. Dependency-tree doesn't care about how to extract dependencies, so it delegates that work to precinct: which is a multi-language dependency extractor; we'll focus on JavaScript tree generation for this example. To do the extraction, precinct delegates the abstract-syntax-tree (AST) generation to the default parser for [node-source-walk](https://github.com/dependents/node-source-walk). Precinct uses the AST to determine what type of JS module the file is (Commonjs, AMD, or ES6) and then delegates to the "detective" that's appropriate for that module type. The "detective" contains the logic for how to extract dependencies based on the module syntax format; i.e., the way dependencies are declared in commonjs is different than in AMD (which has 4 ways of doing that, for example).
 
@@ -105,13 +111,13 @@ So after the appropriate resolver finds the file on the filesystem, filing-cabin
 
 At the end of traversing every file (in a depth-first fashion), we have a fully populated dependency tree. :dancers:
 
-### FAQ
+## FAQ
 
-#### Why aren't some some dependencies being detected?
+### Why aren't some some dependencies being detected?
 
 If there are bugs in [precinct](https://github.com/dependents/node-precinct) or if the `requireConfig`/`webpackConfig`/`tsConfig` options are incomplete,
 some dependencies may not be resolved. The optional array passed to the `nonExistent` option will be populated with paths
 that could not be resolved. You can check this array to see where problems might exist.
 
-You can also use the `DEBUG=*` env variable along with the cli version to see debugging information explaining where resolution went wrong.
-Example: `DEBUG=* dependency-tree -w path/to/webpack.config.json path/to/a/file`
+You can also use the `NODE_DEBUG=*` env variable along with the cli version to see debugging information explaining where resolution went wrong.
+Example: `NODE_DEBUG=* dependency-tree -w path/to/webpack.config.json path/to/a/file`

package/bin/cli.js

@@ -2,36 +2,39 @@
 
 'use strict';
 
-const dependencyTree = require('../');
 const program = require('commander');
+const dependencyTree = require('../index.js');
+const { name, description, version } = require('../package.json');
 
 program
-  .version(require('../package.json').version)
+  .name(name)
+  .description(description)
+  .version(version)
   .usage('[options] <filename>')
   .option('-d, --directory <path>', 'location of files of supported filetypes')
   .option('-c, --require-config <path>', 'path to a requirejs config')
   .option('-w, --webpack-config <path>', 'path to a webpack config')
   .option('-t, --ts-config <path>', 'path to a typescript config')
   .option('--list-form', 'output the list form of the tree (one element per line)')
-  .parse(process.argv);
-
-let tree;
+  .parse();
 
+const cliOptions = program.opts();
 const options = {
   filename: program.args[0],
-  root: program.directory,
-  config: program.requireConfig,
-  webpackConfig: program.webpackConfig,
-  tsConfig: program.tsConfig
+  root: cliOptions.directory,
+  config: cliOptions.requireConfig,
+  webpackConfig: cliOptions.webpackConfig,
+  tsConfig: cliOptions.tsConfig
 };
 
-if (program.listForm) {
+let tree;
+
+if (cliOptions.listForm) {
   tree = dependencyTree.toList(options);
 
-  tree.forEach(function(node) {
+  for (const node of tree) {
     console.log(node);
-  });
-
+  }
 } else {
   tree = dependencyTree(options);
 

package/index.js

@@ -1,11 +1,12 @@
 'use strict';
 
-const precinct = require('precinct');
-const path = require('path');
-const fs = require('fs');
+const fs = require('node:fs');
+const { debuglog } = require('node:util');
 const cabinet = require('filing-cabinet');
-const debug = require('debug')('tree');
-const Config = require('./lib/Config');
+const precinct = require('precinct');
+const Config = require('./lib/config.js');
+
+const debug = debuglog('tree');
 
 /**
  * Recursively find all dependencies (avoiding circular) traversing the entire dependency tree
@@ -18,18 +19,18 @@ const Config = require('./lib/Config');
  * @param {String} [options.webpackConfig] - The path to a webpack config
  * @param {String} [options.nodeModulesConfig] - config for resolving entry file for node_modules
  * @param {Object} [options.visited] - Cache of visited, absolutely pathed files that should not be reprocessed.
- *                             Format is a filename -> tree as list lookup table
+ *                                     Format is a filename -> tree as list lookup table
  * @param {Array} [options.nonExistent] - List of partials that do not exist
  * @param {Boolean} [options.isListForm=false]
  * @param {String|Object} [options.tsConfig] Path to a typescript config (or a preloaded one).
  * @param {Boolean} [options.noTypeDefinitions] For TypeScript imports, whether to resolve to `*.js` instead of `*.d.ts`.
  * @return {Object}
  */
-module.exports = function(options) {
+module.exports = function(options = {}) {
   const config = new Config(options);
 
   if (!fs.existsSync(config.filename)) {
-    debug('file ' + config.filename + ' does not exist');
+    debug(`file ${config.filename} does not exist`);
     return config.isListForm ? [] : {};
   }
 
@@ -42,11 +43,9 @@ module.exports = function(options) {
   let tree;
   if (config.isListForm) {
     debug('list form of results requested');
-
-    tree = Array.from(results);
+    tree = [...results];
   } else {
     debug('object form of results requested');
-
     tree = {};
     tree[config.filename] = results;
   }
@@ -67,7 +66,7 @@ module.exports = function(options) {
  *
  * Params are those of module.exports
  */
-module.exports.toList = function(options) {
+module.exports.toList = function(options = {}) {
   options.isListForm = true;
 
   return module.exports(options);
@@ -81,27 +80,23 @@ module.exports.toList = function(options) {
  * @param  {Config} config
  * @return {Array}
  */
-module.exports._getDependencies = function(config) {
-  let dependencies;
+module.exports._getDependencies = function(config = {}) {
   const precinctOptions = config.detectiveConfig;
   precinctOptions.includeCore = false;
+  let dependencies;
 
   try {
     dependencies = precinct.paperwork(config.filename, precinctOptions);
-
-    debug('extracted ' + dependencies.length + ' dependencies: ', dependencies);
-
-  } catch (e) {
-    debug('error getting dependencies: ' + e.message);
-    debug(e.stack);
+    debug(`extracted ${dependencies.length} dependencies: `, dependencies);
+  } catch (error) {
+    debug(`error getting dependencies: ${error.message}`);
+    debug(error.stack);
     return [];
   }
 
   const resolvedDependencies = [];
 
-  for (let i = 0, l = dependencies.length; i < l; i++) {
-    const dep = dependencies[i];
-
+  for (const dep of dependencies) {
     const result = cabinet({
       partial: dep,
       filename: config.filename,
@@ -115,7 +110,7 @@ module.exports._getDependencies = function(config) {
     });
 
     if (!result) {
-      debug('skipping an empty filepath resolution for partial: ' + dep);
+      debug(`skipping an empty filepath resolution for partial: ${dep}`);
       config.nonExistent.push(dep);
       continue;
     }
@@ -124,7 +119,7 @@ module.exports._getDependencies = function(config) {
 
     if (!exists) {
       config.nonExistent.push(dep);
-      debug('skipping non-empty but non-existent resolution: ' + result + ' for partial: ' + dep);
+      debug(`skipping non-empty but non-existent resolution: ${result} for partial: ${dep}`);
       continue;
     }
 
@@ -138,13 +133,13 @@ module.exports._getDependencies = function(config) {
  * @param  {Config} config
  * @return {Object|Set}
  */
-function traverse(config) {
-  let subTree = config.isListForm ? new Set() : {};
+function traverse(config = {}) {
+  const subTree = config.isListForm ? new Set() : {};
 
-  debug('traversing ' + config.filename);
+  debug(`traversing ${config.filename}`);
 
   if (config.visited[config.filename]) {
-    debug('already visited ' + config.filename);
+    debug(`already visited ${config.filename}`);
     return config.visited[config.filename];
   }
 
@@ -157,24 +152,22 @@ function traverse(config) {
 
   if (config.filter) {
     debug('using filter function to filter out dependencies');
-    debug('unfiltered number of dependencies: ' + dependencies.length);
-    dependencies = dependencies.filter(function(filePath) {
-      return config.filter(filePath, config.filename);
-    });
-    debug('filtered number of dependencies: ' + dependencies.length);
+    debug(`unfiltered number of dependencies: ${dependencies.length}`);
+    // eslint-disable-next-line unicorn/no-array-method-this-argument, unicorn/no-array-callback-reference
+    dependencies = dependencies.filter(filePath => config.filter(filePath, config.filename));
+    debug(`filtered number of dependencies: ${dependencies.length}`);
   }
 
-  for (let i = 0, l = dependencies.length; i < l; i++) {
-    const d = dependencies[i];
+  for (const dep of dependencies) {
     const localConfig = config.clone();
-    localConfig.filename = d;
+    localConfig.filename = dep;
 
     if (localConfig.isListForm) {
-      for (let item of traverse(localConfig)) {
+      for (const item of traverse(localConfig)) {
         subTree.add(item);
       }
     } else {
-      subTree[d] = traverse(localConfig);
+      subTree[dep] = traverse(localConfig);
     }
   }
 

package/package.json

@@ -1,18 +1,26 @@
 {
   "name": "dependency-tree",
-  "version": "9.0.0",
+  "version": "10.0.0",
   "description": "Get the dependency tree of a module",
   "main": "index.js",
   "types": "index.d.ts",
-  "scripts": {
-    "test": "jscs index.js test/test.js && ./node_modules/.bin/mocha --require esm test/test.js"
-  },
+  "files": [
+    "bin/cli.js",
+    "index.js"
+  ],
   "bin": {
     "dependency-tree": "bin/cli.js"
   },
+  "scripts": {
+    "lint": "xo",
+    "fix": "xo --fix",
+    "mocha": "mocha",
+    "test": "npm run lint && npm run mocha",
+    "test:ci": "c8 npm run mocha"
+  },
   "repository": {
     "type": "git",
-    "url": "git@github.com:mrjoelkemp/node-dependency-tree.git"
+    "url": "git+https://github.com/dependents/node-dependency-tree.git"
   },
   "keywords": [
     "dependency",
@@ -32,27 +40,72 @@
   "author": "Joel Kemp <joel@mrjoelkemp.com>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/mrjoelkemp/node-dependency-tree/issues"
+    "url": "https://github.com/dependents/node-dependency-tree/issues"
   },
+  "homepage": "https://github.com/dependents/node-dependency-tree",
   "engines": {
-    "node": "^10.13 || ^12 || >=14"
+    "node": ">=14"
   },
-  "homepage": "https://github.com/mrjoelkemp/node-dependency-tree",
   "dependencies": {
-    "commander": "^2.20.3",
-    "debug": "^4.3.1",
-    "filing-cabinet": "^3.0.1",
-    "precinct": "^9.0.0",
-    "typescript": "^4.0.0"
+    "commander": "^10.0.1",
+    "filing-cabinet": "^4.1.0",
+    "precinct": "^11.0.0",
+    "typescript": "^5.0.4"
   },
   "devDependencies": {
-    "esm": "^3.2.25",
-    "jscs": "^3.0.7",
-    "jscs-preset-mrjoelkemp": "~2.0.0",
-    "mocha": "^8.2.1",
-    "mock-fs": "^4.13.0",
-    "resolve": "^1.19.0",
-    "rewire": "^5.0.0",
-    "sinon": "^9.2.1"
+    "c8": "^7.13.0",
+    "debug": "^4.3.4",
+    "mocha": "^10.2.0",
+    "mock-fs": "^5.2.0",
+    "resolve": "^1.22.3",
+    "sinon": "^15.0.4",
+    "xo": "^0.54.2"
+  },
+  "xo": {
+    "space": true,
+    "ignores": [
+      "index.d.ts",
+      "test/fixtures/*"
+    ],
+    "rules": {
+      "arrow-body-style": "off",
+      "capitalized-comments": "off",
+      "comma-dangle": [
+        "error",
+        "never"
+      ],
+      "curly": [
+        "error",
+        "multi-line"
+      ],
+      "max-nested-callbacks": [
+        "error",
+        5
+      ],
+      "operator-linebreak": [
+        "error",
+        "after"
+      ],
+      "object-curly-spacing": [
+        "error",
+        "always"
+      ],
+      "prefer-template": "error",
+      "space-before-function-paren": [
+        "error",
+        "never"
+      ],
+      "unicorn/prefer-module": "off",
+      "unicorn/prefer-top-level-await": "off",
+      "unicorn/prevent-abbreviations": "off"
+    },
+    "overrides": [
+      {
+        "files": "test/**",
+        "envs": [
+          "mocha"
+        ]
+      }
+    ]
   }
 }

package/index.d.ts

@@ -1,34 +0,0 @@
-declare namespace dependencyTree {
-  interface TreeInnerNode {
-    [parent: string]: TreeInnerNode | string;
-  }
-  type Tree = TreeInnerNode | string;
-
-  export interface Options {
-    filename: string;
-    directory: string;
-    visited?: Tree;
-    nonExistent?: string[];
-    isListForm?: boolean;
-    requireConfig?: string;
-    webpackConfig?: string;
-    nodeModulesConfig?: any;
-    detectiveConfig?: any;
-    tsConfig?: string | Record<string, any>;
-    noTypeDefinitions?: boolean;
-    filter?: (path: string) => boolean;
-  }
-
-  interface Config extends Options {
-    clone: () => Config;
-  }
-
-  function toList(options: Options): string[];
-  function _getDependencies(config: Config): string[];
-}
-
-declare function dependencyTree(
-  options: dependencyTree.Options
-): dependencyTree.Tree;
-
-export = dependencyTree;

package/lib/Config.js

@@ -1,47 +0,0 @@
-'use strict';
-
-const path = require('path');
-const debug = require('debug')('tree');
-
-class Config {
-  constructor(options) {
-    this.filename = options.filename;
-    this.directory = options.directory || options.root;
-    this.visited = options.visited || {};
-    this.nonExistent = options.nonExistent || [];
-    this.isListForm = options.isListForm;
-    this.requireConfig = options.config || options.requireConfig;
-    this.webpackConfig = options.webpackConfig;
-    this.nodeModulesConfig = options.nodeModulesConfig;
-    this.detectiveConfig = options.detective || options.detectiveConfig || {};
-    this.tsConfig = options.tsConfig;
-    this.noTypeDefinitions = options.noTypeDefinitions;
-
-    this.filter = options.filter;
-
-    if (!this.filename) { throw new Error('filename not given'); }
-    if (!this.directory) { throw new Error('directory not given'); }
-    if (this.filter && typeof this.filter !== 'function') { throw new Error('filter must be a function'); }
-
-    if ('string' === typeof this.tsConfig) {
-      debug('preparsing the ts config into an object for performance');
-      const ts = require('typescript');
-      const tsParsedConfig = ts.readJsonConfigFile(this.tsConfig, ts.sys.readFile);
-      const obj = ts.parseJsonSourceFileConfigFileContent(tsParsedConfig, ts.sys, path.dirname(this.tsConfig));
-      this.tsConfig = obj.raw;
-    }
-
-    debug('given filename: ' + this.filename);
-
-    this.filename = path.resolve(process.cwd(), this.filename);
-
-    debug('resolved filename: ' + this.filename);
-    debug('visited: ', this.visited);
-  }
-
-  clone () {
-    return new Config(this);
-  }
-}
-
-module.exports = Config;