feat(plugin-typescript): support multiple tsconfigs

Author: hanna-skryl

packages/plugin-typescript/src/lib/runner/runner.ts

@@ -11,22 +11,22 @@ import {
   toSentenceCase,
 } from '@code-pushup/utils';
 import type { AuditSlug } from '../types.js';
-import {
-  type DiagnosticsOptions,
-  getTypeScriptDiagnostics,
-} from './ts-runner.js';
+import { getTypeScriptDiagnostics } from './ts-runner.js';
 import type { CodeRangeName } from './types.js';
 import { getIssueFromDiagnostic, tsCodeToAuditSlug } from './utils.js';
 
-export type RunnerOptions = DiagnosticsOptions & {
+export type RunnerOptions = {
+  tsconfig: string[];
   expectedAudits: { slug: AuditSlug }[];
 };
 
 export function createRunnerFunction(options: RunnerOptions): RunnerFunction {
   const { tsconfig, expectedAudits } = options;
 
   return (): AuditOutputs => {
-    const diagnostics = getTypeScriptDiagnostics({ tsconfig });
+    const diagnostics = tsconfig.flatMap(config => [
+      ...getTypeScriptDiagnostics({ tsconfig: config }),
+    ]);
 
     const result = diagnostics.reduce<
       Partial<Record<CodeRangeName, Pick<AuditOutput, 'slug' | 'details'>>>

packages/plugin-typescript/src/lib/runner/runner.unit.test.ts

@@ -56,7 +56,7 @@ describe('createRunnerFunction', () => {
   it('should return empty array if no diagnostics are found', () => {
     getTypeScriptDiagnosticsSpy.mockReturnValue([]);
     const runner = createRunnerFunction({
-      tsconfig: 'tsconfig.json',
+      tsconfig: ['tsconfig.json'],
       expectedAudits: [],
     });
     expect(runner(runnerArgs)).toStrictEqual([]);
@@ -65,7 +65,7 @@ describe('createRunnerFunction', () => {
   it('should return empty array if no supported diagnostics are found', () => {
     getTypeScriptDiagnosticsSpy.mockReturnValue([mockSemanticDiagnostic]);
     const runner = createRunnerFunction({
-      tsconfig: 'tsconfig.json',
+      tsconfig: ['tsconfig.json'],
       expectedAudits: [],
     });
     expect(runner(runnerArgs)).toStrictEqual([]);
@@ -74,7 +74,7 @@ describe('createRunnerFunction', () => {
   it('should pass the diagnostic code to tsCodeToSlug', () => {
     getTypeScriptDiagnosticsSpy.mockReturnValue([mockSemanticDiagnostic]);
     const runner = createRunnerFunction({
-      tsconfig: 'tsconfig.json',
+      tsconfig: ['tsconfig.json'],
       expectedAudits: [],
     });
     expect(runner(runnerArgs)).toStrictEqual([]);
@@ -85,7 +85,7 @@ describe('createRunnerFunction', () => {
   it('should pass the diagnostic to getIssueFromDiagnostic', () => {
     getTypeScriptDiagnosticsSpy.mockReturnValue([mockSemanticDiagnostic]);
     const runner = createRunnerFunction({
-      tsconfig: 'tsconfig.json',
+      tsconfig: ['tsconfig.json'],
       expectedAudits: [],
     });
     expect(runner(runnerArgs)).toStrictEqual([]);
@@ -106,7 +106,7 @@ describe('createRunnerFunction', () => {
       },
     ]);
     const runner = createRunnerFunction({
-      tsconfig: 'tsconfig.json',
+      tsconfig: ['tsconfig.json'],
       expectedAudits: [{ slug: 'semantic-errors' }],
     });
 
@@ -138,7 +138,7 @@ describe('createRunnerFunction', () => {
       mockSemanticDiagnostic,
     ]);
     const runner = createRunnerFunction({
-      tsconfig: 'tsconfig.json',
+      tsconfig: ['tsconfig.json'],
       expectedAudits: [{ slug: 'semantic-errors' }, { slug: 'syntax-errors' }],
     });
 
@@ -181,10 +181,54 @@ describe('createRunnerFunction', () => {
       },
     ]);
     const runner = createRunnerFunction({
-      tsconfig: 'tsconfig.json',
+      tsconfig: ['tsconfig.json'],
       expectedAudits: [{ slug: 'semantic-errors' }, { slug: 'syntax-errors' }],
     });
     const auditOutputs = runner(runnerArgs);
     expect(() => auditOutputsSchema.parse(auditOutputs)).not.toThrow();
   });
+
+  it('should aggregate diagnostics from multiple tsconfigs', () => {
+    getTypeScriptDiagnosticsSpy
+      .mockReturnValueOnce([mockSemanticDiagnostic])
+      .mockReturnValueOnce([mockSyntacticDiagnostic]);
+
+    const runner = createRunnerFunction({
+      tsconfig: ['tsconfig.lib.json', 'tsconfig.spec.json'],
+      expectedAudits: [{ slug: 'semantic-errors' }, { slug: 'syntax-errors' }],
+    });
+
+    const auditOutputs = runner(runnerArgs);
+
+    expect(getTypeScriptDiagnosticsSpy).toHaveBeenCalledTimes(2);
+    expect(getTypeScriptDiagnosticsSpy).toHaveBeenNthCalledWith(1, {
+      tsconfig: 'tsconfig.lib.json',
+    });
+    expect(getTypeScriptDiagnosticsSpy).toHaveBeenNthCalledWith(2, {
+      tsconfig: 'tsconfig.spec.json',
+    });
+
+    expect(auditOutputs).toStrictEqual([
+      expect.objectContaining({
+        slug: 'semantic-errors',
+        value: 1,
+        details: {
+          issues: [
+            expect.objectContaining({
+              message: `TS2322: Type 'string' is not assignable to type 'number'.`,
+            }),
+          ],
+        },
+      }),
+      expect.objectContaining({
+        slug: 'syntax-errors',
+        value: 1,
+        details: {
+          issues: [
+            expect.objectContaining({ message: "TS1005: ';' expected." }),
+          ],
+        },
+      }),
+    ]);
+  });
 });

packages/plugin-typescript/src/lib/schema.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 import { pluginScoreTargetsSchema } from '@code-pushup/models';
+import { toArray } from '@code-pushup/utils';
 import { AUDITS, DEFAULT_TS_CONFIG } from './constants.js';
 import type { AuditSlug } from './types.js';
 
@@ -10,8 +11,9 @@ const auditSlugs = AUDITS.map(({ slug }) => slug) as [
 export const typescriptPluginConfigSchema = z
   .object({
     tsconfig: z
-      .string()
+      .union([z.string(), z.array(z.string()).min(1)])
       .default(DEFAULT_TS_CONFIG)
+      .transform(toArray)
       .meta({
         description: `Path to a tsconfig file (default is ${DEFAULT_TS_CONFIG})`,
       }),

packages/plugin-typescript/src/lib/schema.unit.test.ts

@@ -19,6 +19,25 @@ describe('typescriptPluginConfigSchema', () => {
     ).not.toThrow();
   });
 
+  it('transforms a single tsconfig string to an array', () => {
+    expect(
+      typescriptPluginConfigSchema.parse({ tsconfig }).tsconfig,
+    ).toStrictEqual([tsconfig]);
+  });
+
+  it('accepts an array of tsconfig paths', () => {
+    const tsconfigs = ['tsconfig.lib.json', 'tsconfig.spec.json'];
+    expect(
+      typescriptPluginConfigSchema.parse({ tsconfig: tsconfigs }).tsconfig,
+    ).toStrictEqual(tsconfigs);
+  });
+
+  it('throws for empty tsconfig array', () => {
+    expect(() => typescriptPluginConfigSchema.parse({ tsconfig: [] })).toThrow(
+      'too_small',
+    );
+  });
+
   it('accepts a configuration with tsconfig and empty onlyAudits', () => {
     expect(() =>
       typescriptPluginConfigSchema.parse({

packages/plugin-typescript/src/lib/typescript-plugin.ts

@@ -22,7 +22,7 @@ export function typescriptPlugin(
   options?: TypescriptPluginOptions,
 ): PluginConfig {
   const {
-    tsconfig = DEFAULT_TS_CONFIG,
+    tsconfig = [DEFAULT_TS_CONFIG],
     onlyAudits,
     scoreTargets,
   } = parseOptions(options ?? {});

packages/plugin-typescript/src/lib/typescript-plugin.unit.test.ts

@@ -38,7 +38,7 @@ describe('typescriptPlugin', () => {
       }),
     )
       .toThrow(`Error parsing TypeScript Plugin options: SchemaValidationError: Invalid ${ansis.bold('TypescriptPluginConfig')}
-✖ Invalid input: expected string, received number
+✖ Invalid input
   → at tsconfig
 `);
   });