refactor: ignore node modules (#128)

* refactor(find): replace scanNodeModules with includeNodeModules * refactor: switch includeNodeModules to ignoreNodeModules * docs: update readme * fix: windows test
dominikg · Sep 14, 2023 · 0a2e30b · 0a2e30b
1 parent 190e219
commit 0a2e30b
Show file tree

Hide file tree

Showing 11 changed files with 49 additions and 39 deletions.
diff --git a/.changeset/witty-dolls-relax.md b/.changeset/witty-dolls-relax.md
@@ -0,0 +1,5 @@
+---
+'tsconfck': major
+---
+
+breaking(find): replace scanNodeModules with ignoreNodeModules
diff --git a/docs/api.md b/docs/api.md
@@ -33,11 +33,13 @@ interface TSConfckFindOptions {
 	root?: string;
 
 	/**
-	 * set to true if you want to find tsconfig.json files inside node_modules
+	 * set to true if you don't want to find tsconfig for files inside node_modules
+	 *
+	 * This is useful if you want to use the output with esbuild.transform as esbuild itself also ignores node_modules
 	 *
 	 * @default false
 	 */
-	scanNodeModules?: boolean;
+	ignoreNodeModules?: boolean;
 }
 ```
 

diff --git a/packages/tsconfck/README.md b/packages/tsconfck/README.md
@@ -60,17 +60,22 @@ see [API-DOCS](docs/api.md)
 
 ## Advanced
 
-### finding tsconfig.json files inside node_modules
+### ignoring tsconfig.json for 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`
+esbuild ignores node_modules so when you want to use tsconfck with esbuild, you can set `ignoreNodeModules: true`
 
 ```js
-import { find } from 'tsconfck';
-// does not return some-lib/tsconfig.json but first tsconfig outside of node_modules
+import { find, parse } from 'tsconfck';
+// returns some-lib/tsconfig.json
 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 });
+
+// returns null
+const fooTSConfigIgnored = await find('node_modules/some-lib/src/foo.ts', {
+	ignoreNodeModules: true
+});
+
+// returns empty config
+const { tsconfig } = await parse('node_modules/some-lib/src/foo.ts', { ignoreNodeModules: true });
 ```
 
 ### caching

diff --git a/packages/tsconfck/src/find-native.js b/packages/tsconfck/src/find-native.js
@@ -1,5 +1,5 @@
 import path from 'node:path';
-import { loadTS, stripNodeModules } from './util.js';
+import { isInNodeModules, loadTS } from './util.js';
 
 /**
  * find the closest tsconfig.json file using native ts.findConfigFile
@@ -12,8 +12,8 @@ import { loadTS, stripNodeModules } from './util.js';
  */
 export async function findNative(filename, options) {
 	let dir = path.dirname(path.resolve(filename));
-	if (!options?.scanNodeModules) {
-		dir = stripNodeModules(dir);
+	if (options?.ignoreNodeModules && isInNodeModules(dir)) {
+		return null;
 	}
 	const cache = options?.cache;
 	const root = options?.root ? path.resolve(options.root) : undefined;

diff --git a/packages/tsconfck/src/find.js b/packages/tsconfck/src/find.js
@@ -1,6 +1,6 @@
 import path from 'node:path';
 import fs from 'node:fs';
-import { makePromise, stripNodeModules } from './util.js';
+import { isInNodeModules, makePromise } from './util.js';
 /**
  * find the closest tsconfig.json file
  *
@@ -9,11 +9,11 @@ import { makePromise, stripNodeModules } from './util.js';
  * @returns {Promise<string|null>} absolute path to closest tsconfig.json or null if not found
  */
 export async function find(filename, options) {
-	const cache = options?.cache;
 	let dir = path.dirname(path.resolve(filename));
-	if (!options?.scanNodeModules) {
-		dir = stripNodeModules(dir);
+	if (options?.ignoreNodeModules && isInNodeModules(dir)) {
+		return null;
 	}
+	const cache = options?.cache;
 	if (cache?.hasTSConfigPath(dir)) {
 		return cache.getTSConfigPath(dir);
 	}

diff --git a/packages/tsconfck/src/public.d.ts b/packages/tsconfck/src/public.d.ts
@@ -16,11 +16,13 @@ export interface TSConfckFindOptions {
 	root?: string;
 
 	/**
-	 * set to true if you want to find tsconfig.json files inside node_modules
+	 * set to true if you don't want to find tsconfig for files inside node_modules
+	 *
+	 * This is useful if you want to use the output with esbuild.transform as esbuild itself also ignores node_modules
 	 *
 	 * @default false
 	 */
-	scanNodeModules?: boolean;
+	ignoreNodeModules?: boolean;
 }
 
 export interface TSConfckParseOptions extends TSConfckFindOptions {

diff --git a/packages/tsconfck/src/util.js b/packages/tsconfck/src/util.js
@@ -64,17 +64,13 @@ 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
+ * @returns {boolean}  if dir path includes a node_modules segment
  */
-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[/\\].*$/, '');
+export const isInNodeModules = IS_POSIX
+	? (dir) => dir.includes('/node_modules/')
+	: (dir) => dir.match(/[/\\]node_modules[/\\]/);
 
 /**
  * convert posix separator to native separator

diff --git a/packages/tsconfck/tests/find-native.js b/packages/tsconfck/tests/find-native.js
@@ -47,25 +47,24 @@ describe('find-native', () => {
 		}
 	});
 
-	it('should ignore tsconfig in node_modules directory', async () => {
+	it('should ignore files in node_modules directory with ignoreNodeModules=true', 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);
+			expect(await findNative(input, { ignoreNodeModules: true }), `input: ${input}`).toBe(null);
 		}
 	});
 
-	it('should find tsconfig in node_modules directory with scanNodeModules=true', async () => {
+	it('should find tsconfig in node_modules', 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);
+			expect(await findNative(input), `input: ${input}`).toBe(expected);
 		}
 	});
 

diff --git a/packages/tsconfck/tests/find.js b/packages/tsconfck/tests/find.js
@@ -44,25 +44,24 @@ describe('find', () => {
 		}
 	});
 
-	it('should ignore tsconfig in node_modules directory', async () => {
+	it('should ignore files in node_modules directory with ignoreNodeModules=true', 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);
+			expect(await find(input, { ignoreNodeModules: true }), `input: ${input}`).toBe(null);
 		}
 	});
 
-	it('should find tsconfig in node_modules directory with scanNodeModules=true', async () => {
+	it('should find tsconfig in node_modules', 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);
+			expect(await find(input), `input: ${input}`).toBe(expected);
 		}
 	});
 

diff --git a/packages/tsconfck/types/index.d.ts b/packages/tsconfck/types/index.d.ts
@@ -140,11 +140,13 @@ declare module 'tsconfck' {
 		root?: string;
 
 		/**
-		 * set to true if you want to find tsconfig.json files inside node_modules
+		 * set to true if you don't want to find tsconfig for files inside node_modules
+		 *
+		 * This is useful if you want to use the output with esbuild.transform as esbuild itself also ignores node_modules
 		 *
 		 * @default false
 		 */
-		scanNodeModules?: boolean;
+		ignoreNodeModules?: boolean;
 	}
 
 	interface TSConfckParseOptions extends TSConfckFindOptions {

diff --git a/packages/tsconfck/types/index.d.ts.map b/packages/tsconfck/types/index.d.ts.map
@@ -38,5 +38,5 @@
 		null,
 		null
 	],
-	"mappings": ";;;;;;;;iBAUsBA,IAAIA;;;;;;;;iBCWJC,OAAOA;;;;;;;iBCRbC,MAAMA;;;;;;;;;;iBCDAC,UAAUA;cCXnBC,aAAaA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBC0BJC,KAAKA;cAwTdC,kBAAkBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBCxTTC,WAAWA;cA6NpBC,wBAAwBA;;;;;;;;;;;;;;;;;;;;;;;;;WCtPpBC,mBAAmBA;;;;;;;;;;;;;;;;;;;;;;;WAuBnBC,oBAAoBA;;;;WAIpBC,sBAAsBA;;;;;;;;;WAStBC,mBAAmBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BnBC,0BAA0BA;;;;;;;;;;;;WAY1BC,yBAAyBA"
+	"mappings": ";;;;;;;;iBAUsBA,IAAIA;;;;;;;;iBCWJC,OAAOA;;;;;;;iBCRbC,MAAMA;;;;;;;;;;iBCDAC,UAAUA;cCXnBC,aAAaA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBC0BJC,KAAKA;cAwTdC,kBAAkBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBCxTTC,WAAWA;cA6NpBC,wBAAwBA;;;;;;;;;;;;;;;;;;;;;;;;;WCtPpBC,mBAAmBA;;;;;;;;;;;;;;;;;;;;;;;;;WAyBnBC,oBAAoBA;;;;WAIpBC,sBAAsBA;;;;;;;;;WAStBC,mBAAmBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BnBC,0BAA0BA;;;;;;;;;;;;WAY1BC,yBAAyBA"
 }