fix(tsConfig): path mapping by filing-cabinet (#138)

* fix(tsConfig): path mapping by filing-cabinet

A PR pending in filingc-cabinet should be merged and published before
this to be merged. REF: dependents/node-filing-cabinet#100

* Add test to #138

---------

Co-authored-by: XhmikosR <[email protected]>
Co-authored-by: Craig Spaeth <[email protected]>

Author: 3 people

README.md

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

@@ -106,6 +106,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;
     }
 

test/test.mjs

@@ -964,6 +964,18 @@ describe('dependencyTree', () => {
 
         assert.equal(typeof config.tsConfig, 'object');
       });
+
+      it('includes the tsConfigPath so filing-cabinet can still resolve compilerOptions.paths correctly', () => {
+        const directory = path.join(__dirname, 'fixtures/ts');
+        const tsConfigPath = path.join(directory, '.tsconfig');
+        const config = new Config({
+          filename: 'foo',
+          directory: 'bar',
+          tsConfig: tsConfigPath
+        });
+
+        assert.equal(config.tsConfigPath, tsConfigPath);
+      });
     });
 
     describe('when cloning', () => {