Merge branch 'main' into master

Author: XhmikosR

.github/workflows/ci.yml

@@ -3,8 +3,7 @@ name: CI
 on:
   push:
     branches:
-      - "**"
-      - "!dependabot/**"
+      - "main"
   pull_request:
   workflow_dispatch:
 
@@ -23,16 +22,16 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
-        node: [14, 16, 18, 20]
+        node: [18, 20, 22]
 
     steps:
       - name: Clone repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           persist-credentials: false
 
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
           cache: npm

.github/workflows/codeql.yml

@@ -4,11 +4,9 @@ on:
   push:
     branches:
       - main
-      - "!dependabot/**"
   pull_request:
     branches:
       - main
-      - "!dependabot/**"
   schedule:
     - cron: "0 0 * * 0"
   workflow_dispatch:
@@ -24,21 +22,21 @@ jobs:
 
     steps:
       - name: Clone repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           persist-credentials: false
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
         with:
           config-file: ./.github/codeql/codeql-config.yml
           languages: "javascript"
           queries: +security-and-quality
 
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v2
+        uses: github/codeql-action/autobuild@v3
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3
         with:
           category: "/language:javascript"

.github/workflows/lint.yml

@@ -3,14 +3,13 @@ name: Lint
 on:
   push:
     branches:
-      - "**"
-      - "!dependabot/**"
+      - "main"
   pull_request:
   workflow_dispatch:
 
 env:
   FORCE_COLOR: 2
-  NODE: 18
+  NODE: 20
 
 permissions:
   contents: read
@@ -21,12 +20,12 @@ jobs:
 
     steps:
       - name: Clone repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           persist-credentials: false
 
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ env.NODE }}
           cache: npm

.npmrc

@@ -10,7 +10,7 @@
 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/dependents/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/dependents/node-filing-cabinet)
   - Supports RequireJS and Webpack loaders
@@ -50,6 +50,7 @@ const list = dependencyTree.toList({
 * `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
 * `tsConfig`: path to a typescript config (or a preloaded object representing the typescript config)
+* `tsConfigPath`: a (virtual) path to typescript config file when `tsConfig` option is given as an object, not a string. Needed to calculate [Path Mapping](https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping). If not given when `tsConfig` is an object, **Path Mapping** is ignored. This is not needed when `tsConfig` is given as a path string.
 * `nodeModulesConfig`: config for resolving entry file for node_modules
 * `visited`: object used for avoiding redundant subtree generations via memoization.
 * `nonExistent`: array used for storing the list of partial paths that do not exist

README.md

@@ -2,7 +2,7 @@
 
 'use strict';
 
-const program = require('commander');
+const { program } = require('commander');
 const dependencyTree = require('../index.js');
 const { name, description, version } = require('../package.json');
 

bin/cli.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const fs = require('node:fs');
+const path = require('node:path');
 const { debuglog } = require('node:util');
 const cabinet = require('filing-cabinet');
 const precinct = require('precinct');
@@ -94,30 +95,31 @@ module.exports._getDependencies = function(config = {}) {
 
   const resolvedDependencies = [];
 
-  for (const dep of dependencies) {
+  for (const dependency of dependencies) {
     const result = cabinet({
-      partial: dep,
+      partial: dependency,
       filename: config.filename,
       directory: config.directory,
       ast: precinct.ast,
       config: config.requireConfig,
       webpackConfig: config.webpackConfig,
       nodeModulesConfig: config.nodeModulesConfig,
       tsConfig: config.tsConfig,
+      tsConfigPath: config.tsConfigPath,
       noTypeDefinitions: config.noTypeDefinitions
     });
 
     if (!result) {
-      debug(`skipping an empty filepath resolution for partial: ${dep}`);
-      config.nonExistent.push(dep);
+      debug(`skipping an empty filepath resolution for partial: ${dependency}`);
+      config.nonExistent.push(dependency);
       continue;
     }
 
     const exists = fs.existsSync(result);
 
     if (!exists) {
-      config.nonExistent.push(dep);
-      debug(`skipping non-empty but non-existent resolution: ${result} for partial: ${dep}`);
+      config.nonExistent.push(dependency);
+      debug(`skipping non-empty but non-existent resolution: ${result} for partial: ${dependency}`);
       continue;
     }
 
@@ -156,16 +158,17 @@ function traverse(config = {}) {
     debug(`filtered number of dependencies: ${dependencies.length}`);
   }
 
-  for (const dep of dependencies) {
+  for (const dependency of dependencies) {
     const localConfig = config.clone();
-    localConfig.filename = dep;
+    localConfig.filename = dependency;
+    localConfig.directory = getDirectory(localConfig);
 
     if (localConfig.isListForm) {
       for (const item of traverse(localConfig)) {
         subTree.add(item);
       }
     } else {
-      subTree[dep] = traverse(localConfig);
+      subTree[dependency] = traverse(localConfig);
     }
   }
 
@@ -190,3 +193,25 @@ function dedupeNonExistent(nonExistent) {
     i++;
   }
 }
+
+// If the file is in a node module, use the root directory of the module
+function getDirectory(localConfig) {
+  if (!localConfig.filename.includes('node_modules')) {
+    return localConfig.directory;
+  }
+
+  return getProjectPath(path.dirname(localConfig.filename)) || localConfig.directory;
+}
+
+function getProjectPath(filename) {
+  try {
+    const nodeModuleParts = filename.split('node_modules');
+    const packageSubPathPath = nodeModuleParts.pop().split(path.sep).filter(Boolean);
+    const packageName = packageSubPathPath[0].startsWith('@') ? `${packageSubPathPath[0]}${path.sep}${packageSubPathPath[1]}` : packageSubPathPath[0];
+
+    return path.normalize([...nodeModuleParts, `${path.sep}${packageName}`].join('node_modules'));
+  } catch {
+    debug(`Could not determine the root directory of package file ${filename}. Using default`);
+    return null;
+  }
+}

index.js

@@ -18,6 +18,7 @@ module.exports = class Config {
     this.nodeModulesConfig = options.nodeModulesConfig;
     this.detectiveConfig = options.detective || options.detectiveConfig || { includeCore: false };
     this.tsConfig = options.tsConfig;
+    this.tsConfigPath = options.tsConfigPath;
     this.noTypeDefinitions = options.noTypeDefinitions;
     this.filter = options.filter;
 
@@ -30,6 +31,7 @@ module.exports = class Config {
       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.tsConfigPath ||= this.tsConfig;
       this.tsConfig = obj.raw;
     }