feat(plugin-typescript): support multiple tsconfigs

hanna-skryl · hanna-skryl · commit 09359f070879 · 2026-01-22T17:46:17.000-05:00
diff --git a/code-pushup.config.ts b/code-pushup.config.ts
@@ -20,7 +20,7 @@ export default mergeConfigs(
   await configureEslintPlugin(),
   await configureCoveragePlugin(),
   await configureJsPackagesPlugin(),
-  configureTypescriptPlugin(),
+  await configureTypescriptPlugin(),
   configureJsDocsPlugin(),
   await configureLighthousePlugin(TARGET_URL),
   configureAxePlugin(TARGET_URL),
diff --git a/code-pushup.preset.ts b/code-pushup.preset.ts
@@ -20,6 +20,7 @@ import {
 } from './packages/plugin-lighthouse/src/index.js';
 import typescriptPlugin, {
   getCategories,
+  tsconfigFromAllNxProjects,
 } from './packages/plugin-typescript/src/index.js';
 
 export function configureUpload(projectName: string = 'workspace'): CoreConfig {
@@ -150,10 +151,17 @@ export async function configureJsPackagesPlugin(): Promise<CoreConfig> {
   };
 }
 
-export function configureTypescriptPlugin(projectName?: string): CoreConfig {
+export async function configureTypescriptPlugin(
+  projectName?: string,
+): Promise<CoreConfig> {
   const tsconfig = projectName
     ? `packages/${projectName}/tsconfig.lib.json`
-    : 'tsconfig.code-pushup.json';
+    : await tsconfigFromAllNxProjects({
+        exclude: [
+          'test-fixtures', // Intentionally incomplete tsconfigs
+          'models', // Uses ts-patch transformer plugin
+        ],
+      });
   return {
     plugins: [typescriptPlugin({ tsconfig })],
     categories: getCategories(),
diff --git a/packages/ci/code-pushup.config.ts b/packages/ci/code-pushup.config.ts
@@ -14,6 +14,6 @@ export default mergeConfigs(
   configureUpload(projectName),
   await configureEslintPlugin(projectName),
   await configureCoveragePlugin(projectName),
-  configureTypescriptPlugin(projectName),
+  await configureTypescriptPlugin(projectName),
   configureJsDocsPlugin(projectName),
 );
diff --git a/packages/cli/code-pushup.config.ts b/packages/cli/code-pushup.config.ts
@@ -14,6 +14,6 @@ export default mergeConfigs(
   configureUpload(projectName),
   await configureEslintPlugin(projectName),
   await configureCoveragePlugin(projectName),
-  configureTypescriptPlugin(projectName),
+  await configureTypescriptPlugin(projectName),
   configureJsDocsPlugin(projectName),
 );
diff --git a/packages/core/code-pushup.config.ts b/packages/core/code-pushup.config.ts
@@ -14,6 +14,6 @@ export default mergeConfigs(
   configureUpload(projectName),
   await configureEslintPlugin(projectName),
   await configureCoveragePlugin(projectName),
-  configureTypescriptPlugin(projectName),
+  await configureTypescriptPlugin(projectName),
   configureJsDocsPlugin(projectName),
 );
diff --git a/packages/create-cli/code-pushup.config.ts b/packages/create-cli/code-pushup.config.ts
@@ -14,6 +14,6 @@ export default mergeConfigs(
   configureUpload(projectName),
   await configureEslintPlugin(projectName),
   await configureCoveragePlugin(projectName),
-  configureTypescriptPlugin(projectName),
+  await configureTypescriptPlugin(projectName),
   configureJsDocsPlugin(projectName),
 );
diff --git a/packages/nx-plugin/code-pushup.config.ts b/packages/nx-plugin/code-pushup.config.ts
@@ -14,6 +14,6 @@ export default mergeConfigs(
   configureUpload(projectName),
   await configureEslintPlugin(projectName),
   await configureCoveragePlugin(projectName),
-  configureTypescriptPlugin(projectName),
+  await configureTypescriptPlugin(projectName),
   configureJsDocsPlugin(projectName),
 );
diff --git a/packages/plugin-axe/code-pushup.config.ts b/packages/plugin-axe/code-pushup.config.ts
@@ -14,6 +14,6 @@ export default mergeConfigs(
   configureUpload(projectName),
   await configureEslintPlugin(projectName),
   await configureCoveragePlugin(projectName),
-  configureTypescriptPlugin(projectName),
+  await configureTypescriptPlugin(projectName),
   configureJsDocsPlugin(projectName),
 );
diff --git a/packages/plugin-coverage/code-pushup.config.ts b/packages/plugin-coverage/code-pushup.config.ts
@@ -14,6 +14,6 @@ export default mergeConfigs(
   configureUpload(projectName),
   await configureEslintPlugin(projectName),
   await configureCoveragePlugin(projectName),
-  configureTypescriptPlugin(projectName),
+  await configureTypescriptPlugin(projectName),
   configureJsDocsPlugin(projectName),
 );
diff --git a/packages/plugin-eslint/code-pushup.config.ts b/packages/plugin-eslint/code-pushup.config.ts
@@ -14,6 +14,6 @@ export default mergeConfigs(
   configureUpload(projectName),
   await configureEslintPlugin(projectName),
   await configureCoveragePlugin(projectName),
-  configureTypescriptPlugin(projectName),
+  await configureTypescriptPlugin(projectName),
   configureJsDocsPlugin(projectName),
 );
diff --git a/packages/plugin-js-packages/code-pushup.config.ts b/packages/plugin-js-packages/code-pushup.config.ts
@@ -14,6 +14,6 @@ export default mergeConfigs(
   configureUpload(projectName),
   await configureEslintPlugin(projectName),
   await configureCoveragePlugin(projectName),
-  configureTypescriptPlugin(projectName),
+  await configureTypescriptPlugin(projectName),
   configureJsDocsPlugin(projectName),
 );
diff --git a/packages/plugin-jsdocs/code-pushup.config.ts b/packages/plugin-jsdocs/code-pushup.config.ts
@@ -14,6 +14,6 @@ export default mergeConfigs(
   configureUpload(projectName),
   await configureEslintPlugin(projectName),
   await configureCoveragePlugin(projectName),
-  configureTypescriptPlugin(projectName),
+  await configureTypescriptPlugin(projectName),
   configureJsDocsPlugin(projectName),
 );
diff --git a/packages/plugin-lighthouse/code-pushup.config.ts b/packages/plugin-lighthouse/code-pushup.config.ts
@@ -14,6 +14,6 @@ export default mergeConfigs(
   configureUpload(projectName),
   await configureEslintPlugin(projectName),
   await configureCoveragePlugin(projectName),
-  configureTypescriptPlugin(projectName),
+  await configureTypescriptPlugin(projectName),
   configureJsDocsPlugin(projectName),
 );
diff --git a/packages/plugin-typescript/code-pushup.config.ts b/packages/plugin-typescript/code-pushup.config.ts
@@ -14,6 +14,6 @@ export default mergeConfigs(
   configureUpload(projectName),
   await configureEslintPlugin(projectName),
   await configureCoveragePlugin(projectName),
-  configureTypescriptPlugin(projectName),
+  await configureTypescriptPlugin(projectName),
   configureJsDocsPlugin(projectName),
 );
diff --git a/packages/plugin-typescript/mocks/fixtures/nx-monorepo/.gitignore b/packages/plugin-typescript/mocks/fixtures/nx-monorepo/.gitignore
@@ -0,0 +1 @@
+.nx
diff --git a/packages/plugin-typescript/mocks/fixtures/nx-monorepo/_nx.json b/packages/plugin-typescript/mocks/fixtures/nx-monorepo/_nx.json
@@ -0,0 +1 @@
+{}
diff --git a/packages/plugin-typescript/mocks/fixtures/nx-monorepo/_package.json b/packages/plugin-typescript/mocks/fixtures/nx-monorepo/_package.json
@@ -0,0 +1 @@
+{}
diff --git a/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/cli/_project.json b/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/cli/_project.json
@@ -0,0 +1,5 @@
+{
+  "name": "cli",
+  "sourceRoot": "packages/cli/src",
+  "projectType": "library"
+}
diff --git a/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/cli/tsconfig.lib.json b/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/cli/tsconfig.lib.json
@@ -0,0 +1 @@
+{}
diff --git a/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/core/_project.json b/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/core/_project.json
@@ -0,0 +1,5 @@
+{
+  "name": "core",
+  "sourceRoot": "packages/core/src",
+  "projectType": "library"
+}
diff --git a/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/core/tsconfig.lib.json b/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/core/tsconfig.lib.json
@@ -0,0 +1 @@
+{}
diff --git a/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/nx-plugin/_project.json b/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/nx-plugin/_project.json
@@ -0,0 +1,5 @@
+{
+  "name": "nx-plugin",
+  "sourceRoot": "packages/nx-plugin/src",
+  "projectType": "library"
+}
diff --git a/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/nx-plugin/tsconfig.lib.json b/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/nx-plugin/tsconfig.lib.json
@@ -0,0 +1 @@
+{}
diff --git a/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/utils/_project.json b/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/utils/_project.json
@@ -0,0 +1,5 @@
+{
+  "name": "utils",
+  "sourceRoot": "packages/utils/src",
+  "projectType": "library"
+}
diff --git a/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/utils/tsconfig.lib.json b/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/utils/tsconfig.lib.json
@@ -0,0 +1 @@
+{}
diff --git a/packages/plugin-typescript/package.json b/packages/plugin-typescript/package.json
@@ -28,8 +28,14 @@
     "zod": "^4.2.1"
   },
   "peerDependencies": {
+    "@nx/devkit": ">=17.0.0",
     "typescript": ">=4.0.0"
   },
+  "peerDependenciesMeta": {
+    "@nx/devkit": {
+      "optional": true
+    }
+  },
   "scripts": {},
   "files": [
     "src",
diff --git a/packages/plugin-typescript/src/index.ts b/packages/plugin-typescript/src/index.ts
@@ -9,3 +9,4 @@ export {
   type TypescriptPluginOptions,
 } from './lib/schema.js';
 export { getCategories, getCategoryRefsFromGroups } from './lib/utils.js';
+export { tsconfigFromAllNxProjects } from './lib/nx/tsconfig-paths.js';
diff --git a/packages/plugin-typescript/src/lib/nx/tsconfig-paths.int.test.ts b/packages/plugin-typescript/src/lib/nx/tsconfig-paths.int.test.ts
@@ -0,0 +1,68 @@
+import { cp } from 'node:fs/promises';
+import path from 'node:path';
+import process from 'node:process';
+import { fileURLToPath } from 'node:url';
+import type { MockInstance } from 'vitest';
+import {
+  restoreNxIgnoredFiles,
+  teardownTestFolder,
+} from '@code-pushup/test-utils';
+import { executeProcess } from '@code-pushup/utils';
+import { tsconfigFromAllNxProjects } from './tsconfig-paths.js';
+
+// Test setup adapted from packages/plugin-eslint/src/lib/nx/nx.int.test.ts
+describe.skipIf(process.platform === 'win32')('Nx helpers', () => {
+  const thisDir = fileURLToPath(path.dirname(import.meta.url));
+  const fixturesDir = path.join(thisDir, '..', '..', '..', 'mocks', 'fixtures');
+  const tmpDir = path.join(process.cwd(), 'tmp', 'int', 'plugin-typescript');
+  let cwdSpy: MockInstance<[], string>;
+
+  beforeAll(async () => {
+    const workspaceDir = path.join(tmpDir, 'nx-monorepo');
+    await cp(path.join(fixturesDir, 'nx-monorepo'), workspaceDir, {
+      recursive: true,
+    });
+    await restoreNxIgnoredFiles(workspaceDir);
+    cwdSpy = vi.spyOn(process, 'cwd').mockReturnValue(workspaceDir);
+
+    await executeProcess({
+      command: 'npx nx graph --file=.nx/graph.json',
+      cwd: workspaceDir,
+    });
+  });
+
+  afterAll(async () => {
+    cwdSpy.mockRestore();
+    await teardownTestFolder(tmpDir);
+  });
+
+  describe('tsconfigFromAllNxProjects', () => {
+    it('should find tsconfig.lib.json from all Nx projects', async () => {
+      await expect(tsconfigFromAllNxProjects()).resolves.toEqual([
+        'packages/cli/tsconfig.lib.json',
+        'packages/core/tsconfig.lib.json',
+        'packages/nx-plugin/tsconfig.lib.json',
+        'packages/utils/tsconfig.lib.json',
+      ]);
+    });
+
+    it('should exclude specified projects', async () => {
+      await expect(
+        tsconfigFromAllNxProjects({
+          exclude: ['cli', 'core'],
+        }),
+      ).resolves.toEqual([
+        'packages/nx-plugin/tsconfig.lib.json',
+        'packages/utils/tsconfig.lib.json',
+      ]);
+    });
+
+    it('should return empty array when all projects are excluded', async () => {
+      await expect(
+        tsconfigFromAllNxProjects({
+          exclude: ['cli', 'core', 'nx-plugin', 'utils'],
+        }),
+      ).resolves.toEqual([]);
+    });
+  });
+});
diff --git a/packages/plugin-typescript/src/lib/nx/tsconfig-paths.ts b/packages/plugin-typescript/src/lib/nx/tsconfig-paths.ts
@@ -0,0 +1,90 @@
+import type { ProjectConfiguration } from '@nx/devkit';
+import { readdir } from 'node:fs/promises';
+import path from 'node:path';
+import { logger, pluralizeToken, stringifyError } from '@code-pushup/utils';
+import { formatMetaLog } from '../format.js';
+
+/**
+ * TypeScript config patterns to look for in each project.
+ */
+const TSCONFIG_PATTERNS = new Set([
+  'tsconfig.lib.json',
+  'tsconfig.spec.json',
+  'tsconfig.test.json',
+  'tsconfig.app.json',
+]);
+
+/**
+ * Resolves the cached project graph for the current Nx workspace.
+ * Tries to read from cache first, falls back to async creation.
+ */
+async function resolveCachedProjectGraph() {
+  const { readCachedProjectGraph, createProjectGraphAsync } = await import(
+    '@nx/devkit'
+  );
+  try {
+    return readCachedProjectGraph();
+  } catch (error) {
+    logger.warn(
+      `Could not read cached project graph, falling back to async creation.\n${stringifyError(error)}`,
+    );
+    return await createProjectGraphAsync({ exitOnError: false });
+  }
+}
+
+function isProjectIncluded(
+  project: ProjectConfiguration,
+  exclude?: string[],
+): boolean {
+  return !exclude?.includes(project.name ?? '');
+}
+
+/**
+ * Finds tsconfig files matching known patterns in a project directory.
+ */
+async function findTsconfigsInProject(projectRoot: string): Promise<string[]> {
+  const absoluteRoot = path.resolve(process.cwd(), projectRoot);
+  const files = await readdir(absoluteRoot);
+  return files
+    .filter(file => TSCONFIG_PATTERNS.has(file))
+    .map(file => path.join(projectRoot, file));
+}
+
+/**
+ * Finds all tsconfig files from Nx projects in the workspace.
+ *
+ * @param options - Configuration options
+ * @param options.exclude - Array of project names to exclude
+ * @returns Array of tsconfig file paths
+ */
+export async function tsconfigFromAllNxProjects(
+  options: { exclude?: string[] } = {},
+): Promise<string[]> {
+  const projectGraph = await resolveCachedProjectGraph();
+
+  const { readProjectsConfigurationFromProjectGraph } = await import(
+    '@nx/devkit'
+  );
+  const { projects } = readProjectsConfigurationFromProjectGraph(projectGraph);
+
+  const projectRoots = Object.values(projects)
+    .filter(project => isProjectIncluded(project, options.exclude))
+    .map(project => project.root)
+    .toSorted();
+
+  const tsconfigs = (
+    await Promise.all(projectRoots.map(findTsconfigsInProject))
+  ).flat();
+
+  logger.info(
+    formatMetaLog(
+      `Found ${pluralizeToken('tsconfig', tsconfigs.length)} in ${pluralizeToken('Nx project', projectRoots.length)}${
+        options.exclude?.length
+          ? ` (excluding ${pluralizeToken('project', options.exclude.length)})`
+          : ''
+      }`,
+    ),
+  );
+
+  return tsconfigs;
+}
diff --git a/packages/plugin-typescript/src/lib/runner/runner.int.test.ts b/packages/plugin-typescript/src/lib/runner/runner.int.test.ts
@@ -7,8 +7,9 @@ import { createRunnerFunction } from './runner.js';
 describe('createRunnerFunction', () => {
   it('should create valid audit outputs when called', async () => {
     const runnerFunction = createRunnerFunction({
-      tsconfig:
+      tsconfig: [
         'packages/plugin-typescript/mocks/fixtures/basic-setup/tsconfig.all-audits.json',
+      ],
       expectedAudits: getAudits(),
     });
 
diff --git a/packages/plugin-typescript/src/lib/runner/runner.ts b/packages/plugin-typescript/src/lib/runner/runner.ts
diff --git a/packages/plugin-typescript/src/lib/runner/runner.unit.test.ts b/packages/plugin-typescript/src/lib/runner/runner.unit.test.ts
diff --git a/packages/plugin-typescript/src/lib/runner/ts-runner.ts b/packages/plugin-typescript/src/lib/runner/ts-runner.ts
diff --git a/packages/plugin-typescript/tsconfig.test.json b/packages/plugin-typescript/tsconfig.test.json
diff --git a/packages/utils/code-pushup.config.ts b/packages/utils/code-pushup.config.ts
diff --git a/tsconfig.code-pushup.json b/tsconfig.code-pushup.json
