Merge branch 'main' into main_161

Author: XhmikosR

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
-        node: [18, 20]
+        node: [18, 20, 22]
 
     steps:
       - name: Clone repository

README.md

@@ -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

index.js

@@ -107,6 +107,7 @@ module.exports._getDependencies = function(config = {}) {
       webpackConfig: config.webpackConfig,
       nodeModulesConfig: config.nodeModulesConfig,
       tsConfig: config.tsConfig,
+      tsConfigPath: config.tsConfigPath,
       noTypeDefinitions: config.noTypeDefinitions
     });
 

lib/config.js

@@ -18,8 +18,8 @@ module.exports = class Config {
     this.nodeModulesConfig = options.nodeModulesConfig;
     this.detectiveConfig = options.detective || options.detectiveConfig || {};
     this.tsConfig = options.tsConfig;
+    this.tsConfigPath = options.tsConfigPath;
     this.noTypeDefinitions = options.noTypeDefinitions;
-
     this.filter = options.filter;
 
     if (!this.filename) throw new Error('filename not given');
@@ -31,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;
     }