[FEAT] Support multiple tsconfigs (import-js#9)

[FEAT] Support multiple tsconfigs

Author: JounQin

README.md

@@ -19,7 +19,7 @@ npm install --save-dev eslint-plugin-import @typescript-eslint/parser eslint-imp
 
 Add the following to your `.eslintrc` config:
 
-```CJSON
+```JSONC
 {
   "plugins": ["import"],
   "rules": {
@@ -37,6 +37,29 @@ Add the following to your `.eslintrc` config:
       // use <root>/path/to/folder/tsconfig.json
       "typescript": {
         "directory": "./path/to/folder"
+      },
+
+      // Multiple tsconfigs (Useful for monorepos)
+
+      // use a glob pattern
+      "typescript": {
+        "directory": "./packages/**/tsconfig.json"
+      },
+
+      // use an array
+      "typescript": {
+        "directory": [
+          "./packages/module-a/tsconfig.json",
+          "./packages/module-b/tsconfig.json"
+        ]
+      },
+
+      // use an array of glob patterns
+      "typescript": {
+        "directory": [
+          "./packages/**/tsconfig.json",
+          "./other-packages/**/tsconfig.json"
+        ]
       }
     }
   }

index.js

@@ -4,14 +4,20 @@ const path = require('path');
 const resolve = require('resolve');
 const tsconfigPaths = require('tsconfig-paths');
 const debug = require('debug');
+const globSync = require('glob').sync;
+const isGlob = require('is-glob');
 
 const log = debug('eslint-import-resolver-typescript');
 
+const extensions = ['.ts', '.tsx', '.d.ts'].concat(
+  Object.keys(require.extensions),
+);
+
 /**
  * @param {string} source the module to resolve; i.e './some-module'
  * @param {string} file the importing file's full path; i.e. '/usr/local/bin/file.js'
  */
-function resolveFile(source, file, config) {
+function resolveFile(source, file, options = {}) {
   log('looking for:', source);
 
   // don't worry about core node modules
@@ -24,36 +30,16 @@ function resolveFile(source, file, config) {
     };
   }
 
-  let foundTsPath = null;
-  const extensions = ['.ts', '.tsx', '.d.ts'].concat(
-    Object.keys(require.extensions),
-  );
-
-  // setup tsconfig-paths
-  const searchStart = config.directory || process.cwd();
-  const configLoaderResult = tsconfigPaths.loadConfig(searchStart);
-  if (configLoaderResult.resultType === 'success') {
-    const matchPath = tsconfigPaths.createMatchPath(
-      configLoaderResult.absoluteBaseUrl,
-      configLoaderResult.paths,
-    );
-
-    // look for files based on setup tsconfig "paths"
-    foundTsPath = matchPath(source, undefined, undefined, extensions);
-
-    if (foundTsPath) {
-      log('matched ts path:', foundTsPath);
-    }
-  } else {
-    log('failed to init tsconfig-paths:', configLoaderResult.message);
-    // this can happen if the user has problems with their tsconfig
-    // or if it's valid, but they don't have baseUrl set
+  initMappers(options);
+  const mappedPath = getMappedPath(source, file);
+  if (mappedPath) {
+    log('matched ts path:', mappedPath);
   }
 
-  // note that even if we match via tsconfig-paths, we still need to do a final resolve
+  // note that even if we map the path, we still need to do a final resolve
   let foundNodePath;
   try {
-    foundNodePath = resolve.sync(foundTsPath || source, {
+    foundNodePath = resolve.sync(mappedPath || source, {
       extensions,
       basedir: path.dirname(path.resolve(file)),
       packageFilter,
@@ -66,15 +52,15 @@ function resolveFile(source, file, config) {
   // if path is neither absolute nor relative
   if (
     (/\.jsx?$/.test(foundNodePath) ||
-      (config.alwaysTryTypes && !foundNodePath)) &&
+      (options.alwaysTryTypes && !foundNodePath)) &&
     !/^@types[/\\]/.test(source) &&
     !path.isAbsolute(source) &&
     source[0] !== '.'
   ) {
     const definitelyTyped = resolveFile(
       '@types' + path.sep + mangleScopedPackage(source),
       file,
-      config,
+      options,
     );
     if (definitelyTyped.found) {
       return definitelyTyped;
@@ -104,6 +90,74 @@ function packageFilter(pkg) {
 }
 
 /**
+ * @param {string} source the module to resolve; i.e './some-module'
+ * @param {string} file the importing file's full path; i.e. '/usr/local/bin/file.js'
+ * @returns The mapped path of the module or undefined
+ */
+function getMappedPath(source, file) {
+  const paths = mappers
+    .map(mapper => mapper(source, file))
+    .filter(path => !!path);
+
+  if (paths.length > 1) {
+    log('found multiple matching ts paths:', paths);
+  }
+
+  return paths[0];
+}
+
+let mappers;
+function initMappers(options) {
+  if (mappers) {
+    return;
+  }
+
+  const isArrayOfStrings = array =>
+    Array.isArray(array) && array.every(o => typeof o === 'string');
+
+  const configPaths =
+    typeof options.directory === 'string'
+      ? [options.directory]
+      : isArrayOfStrings(options.directory)
+      ? options.directory
+      : [process.cwd()];
+
+  mappers = configPaths
+    // turn glob patterns into paths
+    .reduce(
+      (paths, path) => paths.concat(isGlob(path) ? globSync(path) : path),
+      [],
+    )
+
+    .map(path => tsconfigPaths.loadConfig(path))
+    .filter(configLoaderResult => {
+      const success = configLoaderResult.resultType === 'success';
+      if (!success) {
+        // this can happen if the user has problems with their tsconfig
+        // or if it's valid, but they don't have baseUrl set
+        log('failed to init tsconfig-paths:', configLoaderResult.message);
+      }
+      return success;
+    })
+    .map(configLoaderResult => {
+      const matchPath = tsconfigPaths.createMatchPath(
+        configLoaderResult.absoluteBaseUrl,
+        configLoaderResult.paths,
+      );
+
+      return (source, file) => {
+        // exclude files that are not part of the config base url
+        if (!file.includes(configLoaderResult.absoluteBaseUrl)) {
+          return undefined;
+        }
+
+        // look for files based on setup tsconfig "paths"
+        return matchPath(source, undefined, undefined, extensions);
+      };
+    });
+}
+
+/*
  * For a scoped package, we must look in `@types/foo__bar` instead of `@types/@foo/bar`.
  *
  * @param {string} moduleName