fix: improve type support for isolated dependencies in pnpm (#289)

Author: fasttime

.github/workflows/ci.yml

@@ -112,3 +112,25 @@ jobs:
               run: |
                   npm run build
                   npm run test:jsr
+
+    pnpm_test:
+        name: Test pnpm Type Support
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v5
+
+            - uses: pnpm/action-setup@v4
+              with:
+                  version: latest
+
+            - uses: actions/setup-node@v5
+              with:
+                  node-version: "lts/*"
+
+            - name: Install Packages
+              run: npm install
+
+            - name: Run pnpm test
+              run: |
+                  npm run build
+                  npm run test:pnpm --ws --if-present

.gitignore

@@ -142,3 +142,6 @@ bun.lockb
 
 # Automatically generated files by GitHub Actions workflow
 tools/update-readme.js
+
+# pnpm
+pnpm-lock.yaml

packages/config-helpers/package.json

@@ -28,9 +28,10 @@
     "build:dedupe-types": "node ../../tools/dedupe-types.js dist/cjs/index.cjs dist/esm/index.js",
     "build:cts": "node ../../tools/build-cts.js dist/esm/index.d.ts dist/cjs/index.d.cts",
     "build": "rollup -c && npm run build:dedupe-types && tsc -p tsconfig.esm.json && npm run build:cts",
-    "test:jsr": "npx jsr@latest publish --dry-run",
     "test": "mocha \"tests/**/*.test.js\"",
     "test:coverage": "c8 npm test",
+    "test:jsr": "npx jsr@latest publish --dry-run",
+    "test:pnpm": "cd tests/pnpm && pnpm install && pnpm exec tsc",
     "test:types": "tsc -p tests/types/tsconfig.json"
   },
   "repository": {

packages/config-helpers/tests/pnpm/package.json

@@ -0,0 +1,7 @@
+{
+  "type": "module",
+  "dependencies": {
+    "@eslint/config-helpers": "file:../..",
+    "typescript": "^5.9.3"
+  }
+}

packages/config-helpers/tests/pnpm/test-eslint.config.js

@@ -0,0 +1,5 @@
+import { defineConfig, globalIgnores } from "@eslint/config-helpers";
+
+export const ignoresConfig = globalIgnores([]);
+
+export default defineConfig([ignoresConfig]);

packages/config-helpers/tests/pnpm/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "checkJs": true,
+    "declaration": true,
+    "module": "nodenext",
+    "noEmit": true
+  },
+  "files": ["test-eslint.config.js"]
+}

packages/object-schema/package.json

@@ -25,8 +25,9 @@
     "test": "tests"
   },
   "scripts": {
+    "build:dedupe-types": "node ../../tools/dedupe-types.js dist/cjs/index.cjs dist/esm/index.js",
     "build:cts": "node ../../tools/build-cts.js dist/esm/index.d.ts dist/cjs/index.d.cts",
-    "build": "rollup -c && tsc -p tsconfig.esm.json && npm run build:cts",
+    "build": "rollup -c && npm run build:dedupe-types && tsc -p tsconfig.esm.json && npm run build:cts",
     "test": "mocha \"tests/**/*.test.js\"",
     "test:coverage": "c8 npm test",
     "test:jsr": "npx jsr@latest publish --dry-run",

tools/build-cts.js

@@ -25,8 +25,8 @@ if (!newFilename) {
 
 const oldSourceText = await readFile(filename, "utf-8");
 const newSourceText = oldSourceText.replaceAll(
-	'import("./types.ts")',
-	'import("./types.cts")',
+	' from "./types.ts";\n',
+	' from "./types.cts";\n',
 );
 
 await writeFile(newFilename, newSourceText);

tools/dedupe-types.js

@@ -25,19 +25,31 @@ const files = process.argv.slice(2);
 files.forEach(filePath => {
 	const lines = fs.readFileSync(filePath, "utf8").split(/\r?\n/gu);
 	const typedefs = new Set();
-
-	const remainingLines = lines.filter(line => {
-		if (!line.startsWith("/** @typedef {import")) {
-			return true;
-		}
-
-		if (typedefs.has(line)) {
-			return false;
+	const importSources = new Set();
+	const outputLines = [];
+
+	for (const line of lines) {
+		const match = line.match(
+			/^(?<start>\/\*\*\s*@typedef\s+\{)import\("(?<importSource>.+?)"\)(?<end>.*)/u,
+		);
+		if (!match) {
+			// not a typedef, so just copy the line
+			outputLines.push(line);
+		} else if (!typedefs.has(line)) {
+			// we haven't seen this typedef before, so process it
+			typedefs.add(line);
+			const { start, importSource, end } = match.groups;
+			const importName = `$${importSource.replace(/\W/gu, "")}`;
+			if (!importSources.has(importSource)) {
+				// we haven't seen this import before, so add an @import comment
+				importSources.add(importSource);
+				outputLines.push(
+					`/** @import * as ${importName} from "${importSource}"; */`,
+				);
+			}
+			outputLines.push(`${start}${importName}${end}`);
 		}
+	}
 
-		typedefs.add(line);
-		return true;
-	});
-
-	fs.writeFileSync(filePath, remainingLines.join("\n"), "utf8");
+	fs.writeFileSync(filePath, outputLines.join("\n"), "utf8");
 });

tsconfig.base.json

@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "allowImportingTsExtensions": true,
     "allowJs": true,
     "checkJs": true,
     "declaration": true,