dependency-tree 7.2.0 → 8.1.0

package/README.md

@@ -26,7 +26,8 @@ var tree = dependencyTree({
     entry: 'module'
   }, // optional
   filter: path => path.indexOf('node_modules') === -1, // optional
-  nonExistent: [] // optional
+  nonExistent: [], // optional
+  noTypeDefinitions: false // optional
 });
 
 // Returns a post-order traversal (list form) of the tree with duplicate sub-trees pruned.
@@ -49,8 +50,9 @@ var list = dependencyTree.toList({
 * `filter`: a function used to determine if a module (and its subtree) should be included in the dependency tree
  - The first argument given to the filter is an absolute filepath to the dependency and the second is the filepath to the currently traversed file. Should return a `Boolean`. If it returns `true`, the module is included in the resulting tree.
 * `detective`: object with configuration specific to detectives used to find dependencies of a file
- - for example `detective.amd.skipLazyLoaded: true` tells the AMD detective to omit inner requires
- - See [precinct's usage docs](https://github.com/dependents/node-precinct#usage) for the list of module types you can pass options to.
+  - for example `detective.amd.skipLazyLoaded: true` tells the AMD detective to omit inner requires
+  - 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
 

package/index.d.ts

@@ -0,0 +1,32 @@
+declare namespace dependencyTree {
+  interface TreeInnerNode {
+    [parent: string]: TreeInnerNode | string;
+  }
+  type Tree = TreeInnerNode | string;
+
+  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/index.js

@@ -22,6 +22,7 @@ const Config = require('./lib/Config');
  * @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) {
@@ -109,7 +110,8 @@ module.exports._getDependencies = function(config) {
       config: config.requireConfig,
       webpackConfig: config.webpackConfig,
       nodeModulesConfig: config.nodeModulesConfig,
-      tsConfig: config.tsConfig
+      tsConfig: config.tsConfig,
+      noTypeDefinitions: config.noTypeDefinitions
     });
 
     if (!result) {

package/lib/Config.js

@@ -15,6 +15,7 @@ class Config {
     this.nodeModulesConfig = options.nodeModulesConfig;
     this.detectiveConfig = options.detective || options.detectiveConfig || {};
     this.tsConfig = options.tsConfig;
+    this.noTypeDefinitions = options.noTypeDefinitions;
 
     this.filter = options.filter;
 
@@ -22,6 +23,14 @@ class Config {
     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);

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "dependency-tree",
-  "version": "7.2.0",
+  "version": "8.1.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 @babel/register test/test.js"
+    "test": "jscs index.js test/test.js && ./node_modules/.bin/mocha --require esm test/test.js"
   },
   "bin": {
     "dependency-tree": "bin/cli.js"
@@ -34,26 +35,24 @@
     "url": "https://github.com/mrjoelkemp/node-dependency-tree/issues"
   },
   "engines": {
-    "node": ">=6.0.0"
+    "node": "^10.13 || ^12 || >=14"
   },
   "homepage": "https://github.com/mrjoelkemp/node-dependency-tree",
   "dependencies": {
-    "commander": "^2.19.0",
-    "debug": "^4.1.1",
-    "filing-cabinet": "^2.5.1",
-    "precinct": "^6.2.0"
+    "commander": "^2.20.3",
+    "debug": "^4.3.1",
+    "filing-cabinet": "^3.0.0",
+    "precinct": "^7.0.0",
+    "typescript": "^3.9.7"
   },
   "devDependencies": {
-    "@babel/cli": "^7.2.3",
-    "@babel/core": "^7.2.2",
-    "@babel/preset-env": "^7.2.3",
-    "@babel/register": "^7.0.0",
+    "esm": "^3.2.25",
     "jscs": "^3.0.7",
     "jscs-preset-mrjoelkemp": "~2.0.0",
-    "mocha": "^5.0.0",
-    "mock-fs": "^4.7.0",
-    "resolve": "^1.9.0",
-    "rewire": "^4.0.1",
-    "sinon": "^6.1.5"
+    "mocha": "^8.2.1",
+    "mock-fs": "^4.13.0",
+    "resolve": "^1.19.0",
+    "rewire": "^5.0.0",
+    "sinon": "^9.2.1"
   }
 }

package/.node-version

@@ -1 +0,0 @@
-8.16.2