feat(plugin-typescript): support multiple tsconfigs (#1229)

hanna-skryl · web-flow · commit e7d950efddfa · 2026-01-29T08:26:14.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-coverage/src/lib/nx/coverage-paths.ts b/packages/plugin-coverage/src/lib/nx/coverage-paths.ts
@@ -9,40 +9,22 @@ import type { VitestExecutorOptions } from '@nx/vite/executors';
 import path from 'node:path';
 import {
   importModule,
+  loadNxProjectGraph,
   logger,
   pluralize,
   pluralizeToken,
-  stringifyError,
 } from '@code-pushup/utils';
 import type { CoverageResult } from '../config.js';
 import { formatMetaLog } from '../format.js';
 
-/**
- * Resolves the cached project graph for the current Nx workspace.
- * First tries to read cache and if not possible, go for the 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 - ${stringifyError(error)}`,
-    );
-    return await createProjectGraphAsync({ exitOnError: false });
-  }
-}
-
 /**
  * @param targets nx targets to be used for measuring coverage, test by default
  * @returns An array of coverage result information for the coverage plugin.
  */
 export async function getNxCoveragePaths(
   targets: string[] = ['test'],
 ): Promise<CoverageResult[]> {
-  const { nodes } = await resolveCachedProjectGraph();
+  const { nodes } = await loadNxProjectGraph();
 
   const coverageResultsPerTarget = Object.fromEntries(
     await Promise.all(
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-eslint/src/lib/nx/find-all-projects.ts b/packages/plugin-eslint/src/lib/nx/find-all-projects.ts
@@ -1,27 +1,9 @@
-import { logger, pluralizeToken, stringifyError } from '@code-pushup/utils';
+import { loadNxProjectGraph, logger, pluralizeToken } from '@code-pushup/utils';
 import type { ESLintTarget } from '../config.js';
 import { formatMetaLog } from '../meta/format.js';
 import { filterProjectGraph } from './filter-project-graph.js';
 import { nxProjectsToConfig } from './projects-to-config.js';
 
-/**
- * Resolves the cached project graph for the current Nx workspace.
- * First tries to read cache and if not possible, go for the 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 });
-  }
-}
-
 /**
  * Finds all Nx projects in workspace and converts their lint configurations to Code PushUp ESLint plugin parameters.
  *
@@ -51,7 +33,7 @@ async function resolveCachedProjectGraph() {
 export async function eslintConfigFromAllNxProjects(
   options: { exclude?: string[] } = {},
 ): Promise<ESLintTarget[]> {
-  const projectGraph = await resolveCachedProjectGraph();
+  const projectGraph = await loadNxProjectGraph();
   const filteredProjectGraph = filterProjectGraph(
     projectGraph,
     options.exclude,
diff --git a/packages/plugin-eslint/src/lib/nx/find-project-with-deps.ts b/packages/plugin-eslint/src/lib/nx/find-project-with-deps.ts
@@ -1,4 +1,4 @@
-import { logger, pluralizeToken } from '@code-pushup/utils';
+import { loadNxProjectGraph, logger, pluralizeToken } from '@code-pushup/utils';
 import type { ESLintTarget } from '../config.js';
 import { formatMetaLog } from '../meta/format.js';
 import { nxProjectsToConfig } from './projects-to-config.js';
@@ -32,8 +32,7 @@ import { findAllDependencies } from './traverse-graph.js';
 export async function eslintConfigFromNxProjectAndDeps(
   projectName: string,
 ): Promise<ESLintTarget[]> {
-  const { createProjectGraphAsync } = await import('@nx/devkit');
-  const projectGraph = await createProjectGraphAsync({ exitOnError: false });
+  const projectGraph = await loadNxProjectGraph();
 
   const dependencies = findAllDependencies(projectName, projectGraph);
 
diff --git a/packages/plugin-eslint/src/lib/nx/find-project-without-deps.ts b/packages/plugin-eslint/src/lib/nx/find-project-without-deps.ts
@@ -1,4 +1,4 @@
-import { logger } from '@code-pushup/utils';
+import { loadNxProjectGraph, logger } from '@code-pushup/utils';
 import type { ESLintTarget } from '../config.js';
 import { formatMetaLog } from '../meta/format.js';
 import { nxProjectsToConfig } from './projects-to-config.js';
@@ -31,8 +31,7 @@ import { nxProjectsToConfig } from './projects-to-config.js';
 export async function eslintConfigFromNxProject(
   projectName: string,
 ): Promise<ESLintTarget> {
-  const { createProjectGraphAsync } = await import('@nx/devkit');
-  const projectGraph = await createProjectGraphAsync({ exitOnError: false });
+  const projectGraph = await loadNxProjectGraph();
 
   const [project] = await nxProjectsToConfig(
     projectGraph,
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/README.md b/packages/plugin-typescript/README.md
@@ -84,21 +84,49 @@ Each set is also available as group in the plugin. See more under [Audits and Gr
 
 The plugin accepts the following parameters:
 
-| Option     | Type     | Default         | Description                                                                                                                                 |
-| ---------- | -------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
-| tsconfig   | string   | `tsconfig.json` | A string that defines the path to your `tsconfig.json` file                                                                                 |
-| onlyAudits | string[] | undefined       | An array of audit slugs to specify which documentation types you want to measure. Only the specified audits will be included in the results |
+| Option     | Type               | Default         | Description                                                                                                                                 |
+| ---------- | ------------------ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| tsconfig   | string \| string[] | `tsconfig.json` | Path(s) to your `tsconfig.json` file(s)                                                                                                     |
+| onlyAudits | string[]           | undefined       | An array of audit slugs to specify which documentation types you want to measure. Only the specified audits will be included in the results |
 
 #### `tsconfig`
 
-Optional parameter. The `tsconfig` option accepts a string that defines the path to your config file and defaults to `tsconfig.json`.
+Optional parameter. The `tsconfig` option accepts a path or an array of paths to your config files. Defaults to `tsconfig.json`.
 
 ```js
 typescriptPlugin({
   tsconfig: './tsconfig.json',
 });
 ```
 
+You can also provide multiple tsconfigs to combine results from different configurations (e.g., separate configs for source and test files):
+
+```js
+typescriptPlugin({
+  tsconfig: ['./tsconfig.lib.json', './tsconfig.spec.json'],
+});
+```
+
+If you're using an Nx monorepo, a helper function is provided to auto-discover tsconfigs from all projects:
+
+```js
+import typescriptPlugin, { tsconfigFromAllNxProjects } from '@code-pushup/typescript-plugin';
+
+export default {
+  plugins: [
+    await typescriptPlugin({
+      tsconfig: await tsconfigFromAllNxProjects(),
+    }),
+  ],
+};
+```
+
+You can exclude specific projects by name:
+
+```js
+await tsconfigFromAllNxProjects({ exclude: ['my-app-e2e'] });
+```
+
 #### `onlyAudits`
 
 The `onlyAudits` option allows you to specify which documentation types you want to measure. Only the specified audits will be included in the results. All audits are included by default. Example:
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.base.json b/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/cli/tsconfig.base.json
@@ -0,0 +1,3 @@
+{
+  "compilerOptions": { "strict": true }
+}
diff --git a/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/cli/tsconfig.json b/packages/plugin-typescript/mocks/fixtures/nx-monorepo/packages/cli/tsconfig.json
@@ -0,0 +1,5 @@
+{
+  "files": [],
+  "include": [],
+  "references": [{ "path": "./tsconfig.lib.json" }]
+}
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,3 @@
+{
+  "include": ["src/**/*.ts"]
+}
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,3 @@
+{
+  "include": ["src/**/*.ts"]
+}
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,3 @@
+{
+  "include": ["src/**/*.ts"]
+}
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,3 @@
+{
+  "include": ["src/**/*.ts"]
+}
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
diff --git a/packages/plugin-typescript/src/lib/nx/tsconfig-paths.ts b/packages/plugin-typescript/src/lib/nx/tsconfig-paths.ts
diff --git a/packages/plugin-typescript/src/lib/runner/runner.int.test.ts b/packages/plugin-typescript/src/lib/runner/runner.int.test.ts
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/src/lib/schema.ts b/packages/plugin-typescript/src/lib/schema.ts
diff --git a/packages/plugin-typescript/src/lib/schema.unit.test.ts b/packages/plugin-typescript/src/lib/schema.unit.test.ts
diff --git a/packages/plugin-typescript/src/lib/typescript-plugin.ts b/packages/plugin-typescript/src/lib/typescript-plugin.ts
diff --git a/packages/plugin-typescript/src/lib/typescript-plugin.unit.test.ts b/packages/plugin-typescript/src/lib/typescript-plugin.unit.test.ts
diff --git a/packages/utils/code-pushup.config.ts b/packages/utils/code-pushup.config.ts
diff --git a/packages/utils/package.json b/packages/utils/package.json
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
diff --git a/packages/utils/src/lib/nx.ts b/packages/utils/src/lib/nx.ts
diff --git a/tsconfig.code-pushup.json b/tsconfig.code-pushup.json
