feat(find): ignore tsconfig.json inside node_modules by default (#123)

* feat(find): ignore tsconfig.json files inside node_modules

* feat(find): add option scanNodeModules, update documentation and more node: import specifiers

* fix: stupid cp bug in tests

.changeset/tricky-trees-tell.md

@@ -0,0 +1,5 @@
+---
+'tsconfck': major
+---
+
+breaking(find): ignore tsconfig files inside node_modules

docs/api.md

@@ -31,6 +31,13 @@ interface TSConfckFindOptions {
 	 * Improves performance but may lead to different results from native typescript when no tsconfig is found inside root
 	 */
 	root?: string;
+
+	/**
+	 * set to true if you want to find tsconfig.json files inside node_modules
+	 *
+	 * @default false
+	 */
+	scanNodeModules?: boolean;
 }
 ```
 

packages/tsconfck/README.md

@@ -60,6 +60,19 @@ see [API-DOCS](docs/api.md)
 
 ## Advanced
 
+### finding tsconfig.json files inside node_modules
+
+By default, tsconfck ignores tsconfig.json files inside node_modules, similar to esbuild.
+If you want to include tsconfig.json files inside node_modules in your find/parse results, set `scanNodeModules`
+
+```js
+import { find } from 'tsconfck';
+// does not return some-lib/tsconfig.json but first tsconfig outside of node_modules
+const fooTSConfig = await find('node_modules/some-lib/src/foo.ts');
+// returns some-lib/tsconfig.json if it exists otherwise continues finding up the tree
+const fooResult = await find('node_modules/some-lib/src/foo.ts', { scanNodeModules: true });
+```
+
 ### caching
 
 a TSConfckCache instance can be created and passed to find and parse functions to reduce overhead when they are called often within the same project
@@ -107,16 +120,24 @@ const barResult = await parse('src/bar.ts', parseOptions);
 
 ### error handling
 
-find and parse reject for all errors they encounter.
+find and parse reject for errors they encounter, but return null or empty result if no config was found
 
-For parse, you can choose to resolve with an empty result instead if no tsconfig file was found
+If you want them to error instead, test the result and throw
 
 ```js
 import { parse } from 'tsconfck';
-const result = await parse('some/path/without/tsconfig/foo.ts', {
-	resolveWithEmptyIfConfigNotFound: true
+find('some/path/without/tsconfig/foo.ts').then((result) => {
+	if (result === null) {
+		throw new Error('not found');
+	}
+	return result;
+});
+parse('some/path/without/tsconfig/foo.ts').then((result) => {
+	if (result.tsconfigFile === null) {
+		throw new Error('not found');
+	}
+	return result;
 });
-// result = { tsconfigFile: 'no_tsconfig_file_found',tsconfig: {} }
 ```
 
 ### TSConfig type (optional, requires typescript as devDependency)

packages/tsconfck/src/find-all.js

@@ -1,4 +1,4 @@
-import path from 'path';
+import path from 'node:path';
 import { readdir } from 'node:fs';
 
 /**

packages/tsconfck/src/find-native.js

@@ -1,5 +1,5 @@
-import path from 'path';
-import { loadTS } from './util.js';
+import path from 'node:path';
+import { loadTS, stripNodeModules } from './util.js';
 
 /**
  * find the closest tsconfig.json file using native ts.findConfigFile
@@ -11,20 +11,23 @@ import { loadTS } from './util.js';
  * @returns {Promise<string>} absolute path to closest tsconfig.json
  */
 export async function findNative(filename, options) {
-	const fileDir = path.dirname(path.resolve(filename));
+	let dir = path.dirname(path.resolve(filename));
+	if (!options?.scanNodeModules) {
+		dir = stripNodeModules(dir);
+	}
 	const cache = options?.cache;
 	const root = options?.root ? path.resolve(options.root) : undefined;
-	if (cache?.hasTSConfigPath(fileDir)) {
-		return cache.getTSConfigPath(fileDir);
+	if (cache?.hasTSConfigPath(dir)) {
+		return cache.getTSConfigPath(dir);
 	}
 	const ts = await loadTS();
 	const { findConfigFile, sys } = ts;
-	let tsconfigFile = findConfigFile(fileDir, sys.fileExists);
+	let tsconfigFile = findConfigFile(dir, sys.fileExists);
 	if (!tsconfigFile || is_out_of_root(tsconfigFile, root)) {
 		tsconfigFile = null;
 	}
 	if (cache) {
-		cache_result(tsconfigFile, fileDir, cache, root);
+		cache_result(tsconfigFile, dir, cache, root);
 	}
 	return tsconfigFile;
 }

packages/tsconfck/src/find.js

@@ -1,5 +1,6 @@
 import path from 'node:path';
 import fs from 'node:fs';
+import { stripNodeModules } from './util.js';
 /**
  * find the closest tsconfig.json file
  *
@@ -10,6 +11,9 @@ import fs from 'node:fs';
 export async function find(filename, options) {
 	const cache = options?.cache;
 	let dir = path.dirname(path.resolve(filename));
+	if (!options?.scanNodeModules) {
+		dir = stripNodeModules(dir);
+	}
 	if (cache?.hasTSConfigPath(dir)) {
 		return cache.getTSConfigPath(dir);
 	}

packages/tsconfck/src/parse-native.js

@@ -1,4 +1,4 @@
-import path from 'path';
+import path from 'node:path';
 import {
 	loadTS,
 	native2posix,

packages/tsconfck/src/parse.js

@@ -1,4 +1,4 @@
-import path from 'path';
+import path from 'node:path';
 import { promises as fs } from 'node:fs';
 import { createRequire } from 'module';
 import { find } from './find.js';

packages/tsconfck/src/public.d.ts

@@ -14,6 +14,13 @@ export interface TSConfckFindOptions {
 	 * Improves performance but may lead to different results from native typescript when no tsconfig is found inside root
 	 */
 	root?: string;
+
+	/**
+	 * set to true if you want to find tsconfig.json files inside node_modules
+	 *
+	 * @default false
+	 */
+	scanNodeModules?: boolean;
 }
 
 export interface TSConfckParseOptions extends TSConfckFindOptions {

packages/tsconfck/src/util.js

@@ -50,6 +50,19 @@ export async function resolveTSConfigJson(filename, cache) {
 	});
 }
 
+/**
+ * remove path segments inside node_modules
+ *
+ * @param {string} dir an absolute directory path
+ * @returns {string}  parent dir of node_modules if inside of node_modules, dir if not
+ */
+export const stripNodeModules = IS_POSIX
+	? (dir) => {
+			const i = dir.indexOf('/node_modules/');
+			return i > -1 ? dir.slice(0, i) : dir;
+	  }
+	: (dir) => dir.replace(/[/\\]node_modules[/\\].*$/, '');
+
 /**
  * convert posix separator to native separator
  *

packages/tsconfck/tests/find-all.js

@@ -23,14 +23,14 @@ describe('find-all', () => {
 	it('should find tsconfig in same directory', async () => {
 		const fixtureDir = 'find/a';
 		const expected = absFixture(`${fixtureDir}/tsconfig.json`);
-		const found = await findAll(absFixture(fixtureDir));
+		const found = await findAll(absFixture(fixtureDir), { skip: (dir) => dir === 'node_modules' });
 		expect(found).toEqual([expected]);
 	});
 
 	it('should find tsconfig in child directory', async () => {
 		const fixtureDir = 'find';
 		const expected = absFixture(`${fixtureDir}/a/tsconfig.json`);
-		const found = await findAll(absFixture(fixtureDir));
+		const found = await findAll(absFixture(fixtureDir), { skip: (dir) => dir === 'node_modules' });
 		expect(found).toEqual([expected]);
 	});
 

packages/tsconfck/tests/find-native.js

@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest';
-import path from 'path';
+import path from 'node:path';
 import os from 'os';
 import { findNative } from '../src/find-native.js';
 import { absFixture, absRoot, relFixture } from './util/fixture-paths.js';
@@ -47,6 +47,28 @@ describe('find-native', () => {
 		}
 	});
 
+	it('should ignore tsconfig in node_modules directory', async () => {
+		const fixtureDir = 'find/a';
+		const expected = native2posix(absFixture(`${fixtureDir}/tsconfig.json`));
+		const relativeTS = relFixture(`${fixtureDir}/node_modules/some-lib/src/foo.ts`);
+		const absoluteTS = absFixture(`${fixtureDir}/node_modules/some-lib/src/foo.ts`);
+		const inputs = [relativeTS, `./${relativeTS}`, absoluteTS];
+		for (const input of inputs) {
+			expect(await findNative(input), `input: ${input}`).toBe(expected);
+		}
+	});
+
+	it('should find tsconfig in node_modules directory with scanNodeModules=true', async () => {
+		const fixtureDir = 'find/a';
+		const expected = native2posix(absFixture(`${fixtureDir}/node_modules/some-lib/tsconfig.json`));
+		const relativeTS = relFixture(`${fixtureDir}/node_modules/some-lib/src/foo.ts`);
+		const absoluteTS = absFixture(`${fixtureDir}/node_modules/some-lib/src/foo.ts`);
+		const inputs = [relativeTS, `./${relativeTS}`, absoluteTS];
+		for (const input of inputs) {
+			expect(await findNative(input, { scanNodeModules: true }), `input: ${input}`).toBe(expected);
+		}
+	});
+
 	it('should stop searching at root', async () => {
 		const fixtureDir = 'find-root/a';
 		const relativeTS = relFixture(`${fixtureDir}/b/foo.ts`);

packages/tsconfck/tests/find.js

@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest';
-import path from 'path';
+import path from 'node:path';
 import os from 'os';
 import { find } from '../src/find.js';
 import { absFixture, absRoot, relFixture } from './util/fixture-paths.js';
@@ -44,6 +44,28 @@ describe('find', () => {
 		}
 	});
 
+	it('should ignore tsconfig in node_modules directory', async () => {
+		const fixtureDir = 'find/a';
+		const expected = absFixture(`${fixtureDir}/tsconfig.json`);
+		const relativeTS = relFixture(`${fixtureDir}/node_modules/some-lib/src/foo.ts`);
+		const absoluteTS = absFixture(`${fixtureDir}/node_modules/some-lib/src/foo.ts`);
+		const inputs = [relativeTS, `./${relativeTS}`, absoluteTS];
+		for (const input of inputs) {
+			expect(await find(input), `input: ${input}`).toBe(expected);
+		}
+	});
+
+	it('should find tsconfig in node_modules directory with scanNodeModules=true', async () => {
+		const fixtureDir = 'find/a';
+		const expected = absFixture(`${fixtureDir}/node_modules/some-lib/tsconfig.json`);
+		const relativeTS = relFixture(`${fixtureDir}/node_modules/some-lib/src/foo.ts`);
+		const absoluteTS = absFixture(`${fixtureDir}/node_modules/some-lib/src/foo.ts`);
+		const inputs = [relativeTS, `./${relativeTS}`, absoluteTS];
+		for (const input of inputs) {
+			expect(await find(input, { scanNodeModules: true }), `input: ${input}`).toBe(expected);
+		}
+	});
+
 	it('should stop searching at root', async () => {
 		const fixtureDir = 'find-root/a';
 		const relativeTS = relFixture(`${fixtureDir}/b/foo.ts`);

packages/tsconfck/tests/fixtures/find/a/.gitignore

@@ -0,0 +1 @@
+!node_modules

packages/tsconfck/tests/parse.js

@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest';
-import path from 'path';
+import path from 'node:path';
 import { parse, TSConfckParseError } from '../src/parse.js';
 import os from 'os';
 

packages/tsconfck/tests/util.js

@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest';
-import path from 'path';
+import path from 'node:path';
 import os from 'os';
 import { isGlobMatch, native2posix, resolve2posix } from '../src/util.js';
 

packages/tsconfck/tests/util/copy-fixtures.js

@@ -1,5 +1,5 @@
 import { promises as fs } from 'node:fs';
-import path from 'path';
+import path from 'node:path';
 
 /**
  *

packages/tsconfck/tests/util/fixture-paths.js

@@ -1,5 +1,5 @@
 import { fileURLToPath } from 'node:url';
-import path from 'path';
+import path from 'node:path';
 import glob from 'tiny-glob';
 const cwd = process.cwd();
 const root = fileURLToPath(new URL('../..', import.meta.url));

packages/tsconfck/types/index.d.ts

@@ -136,6 +136,13 @@ declare module 'tsconfck' {
 		 * Improves performance but may lead to different results from native typescript when no tsconfig is found inside root
 		 */
 		root?: string;
+
+		/**
+		 * set to true if you want to find tsconfig.json files inside node_modules
+		 *
+		 * @default false
+		 */
+		scanNodeModules?: boolean;
 	}
 
 	interface TSConfckParseOptions extends TSConfckFindOptions {

packages/tsconfck/types/index.d.ts.map

@@ -38,5 +38,5 @@
 		null,
 		null
 	],
-	"mappings": ";;;;;;;;iBASsBA,IAAIA;;;;;;;;iBCYJC,OAAOA;;;;;;;iBCRbC,MAAMA;;;;;;;;;;iBCDAC,UAAUA;cCXnBC,aAAaA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBCyBJC,KAAKA;cAqTdC,kBAAkBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBCrTTC,WAAWA;cAyNpBC,wBAAwBA;;;;;;;;;;;;;;;;;;;;;;;;;WCjPpBC,mBAAmBA;;;;;;;;;;;;;;;;WAgBnBC,oBAAoBA;;;;WAIpBC,sBAAsBA;;;;;;;;;WAStBC,mBAAmBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BnBC,0BAA0BA;;;;;;;;;;;;WAY1BC,yBAAyBA"
+	"mappings": ";;;;;;;;iBAUsBA,IAAIA;;;;;;;;iBCWJC,OAAOA;;;;;;;iBCRbC,MAAMA;;;;;;;;;;iBCDAC,UAAUA;cCXnBC,aAAaA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBCyBJC,KAAKA;cAqTdC,kBAAkBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBCrTTC,WAAWA;cAyNpBC,wBAAwBA;;;;;;;;;;;;;;;;;;;;;;;;;WCjPpBC,mBAAmBA;;;;;;;;;;;;;;;;;;;;;;;WAuBnBC,oBAAoBA;;;;WAIpBC,sBAAsBA;;;;;;;;;WAStBC,mBAAmBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BnBC,0BAA0BA;;;;;;;;;;;;WAY1BC,yBAAyBA"
 }