feat: add skip option (#146)

Co-authored-by: Alec Larson <[email protected]>

Author: Akiyamka

README.md

@@ -63,6 +63,9 @@ Give [`vite`] the ability to resolve imports using TypeScript's path mapping.
 - `ignoreConfigErrors: boolean`  
   When true, parsing errors encountered while loading tsconfig files will be ignored. This is useful if you have a monorepo with multiple tsconfig files, and you don't want to see errors for the ones that aren't relevant to the current project.
 
+- `skip: (dir: string) => boolean`  
+  A function that determines which directories to skip when searching for tsconfig.json files. While `.git` and `node_modules` directories are always skipped, this option allows you to skip additional directories, which is useful in large monorepos to improve performance.
+
  
 
 ### allowJs

src/index.ts

@@ -63,7 +63,13 @@ export default (opts: PluginOptions = {}): Plugin => {
         : await tsconfck.findAll(workspaceRoot, {
             configNames: opts.configNames || ['tsconfig.json', 'jsconfig.json'],
             skip(dir) {
-              return dir == 'node_modules' || dir == '.git'
+              if (dir === '.git' || dir === 'node_modules') {
+                return true
+              }
+              if (typeof opts.skip === 'function') {
+                return opts.skip(dir)
+              }
+              return false
             },
           })
 
@@ -402,3 +408,4 @@ function compileGlob(glob: string) {
     globstar: true,
   }).regex
 }
+

src/types.ts

@@ -47,6 +47,12 @@ export interface PluginOptions {
    * @default ["tsconfig.json", "jsconfig.json"]
    */
   configNames?: string[]
+  /**
+   * A function that determines which directories to skip when searching for tsconfig.json files.
+   * While `.git` and `node_modules` directories are always skipped, this option allows you to skip
+   * additional directories, which is useful in large monorepos to improve performance.
+   */
+  skip?: (dir: string) => boolean
 }
 
 export interface TSConfig {