fix(plugin-typescript): include extended options

code-pushup.config.ts

@@ -26,7 +26,7 @@ const config: CoreConfig = {
       server: env.CP_SERVER,
       apiKey: env.CP_API_KEY,
       organization: env.CP_ORGANIZATION,
-      project: env.CP_PROJECT,
+      project: 'cli-workspace',
     },
   }),
 

e2e/plugin-typescript-e2e/mocks/fixtures/default-setup/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "rootDir": "./src",
+    "rootDir": "${configDir}/src",
     "target": "ES6",
     "module": "CommonJS",
     "strict": true,

e2e/plugin-typescript-e2e/tests/__snapshots__/collect.e2e.test.ts.snap

@@ -121,7 +121,7 @@ exports[`PLUGIN collect report with typescript-plugin NPM package > should run p
           "details": {
             "issues": [
               {
-                "message": "TS6059: File '<PATH>' is not under 'rootDir' '<PATH>'. 'rootDir' is expected to contain all source files.",
+                "message": "TS6059: File './exclude/utils.ts' is not under 'rootDir' './src'. 'rootDir' is expected to contain all source files.",
                 "severity": "error",
                 "source": {
                   "file": "tmp/e2e/plugin-typescript-e2e/src/6-configuration-errors.ts",

e2e/plugin-typescript-e2e/tests/collect.e2e.test.ts

@@ -7,6 +7,7 @@ import {
   E2E_ENVIRONMENTS_DIR,
   TEST_OUTPUT_DIR,
   omitVariableReportData,
+  osAgnosticAuditOutputs,
   osAgnosticPath,
   teardownTestFolder,
 } from '@code-pushup/test-utils';
@@ -17,27 +18,20 @@ function sanitizeReportPaths(report: Report): Report {
     ...report,
     plugins: report.plugins.map(plugin => ({
       ...plugin,
-      audits: plugin.audits.map(audit => ({
-        ...audit,
-        ...(audit.details && {
-          details: {
-            ...audit.details,
-            issues: audit.details.issues?.map(issue => ({
-              ...issue,
-              ...(issue.source && {
-                source: {
-                  ...issue.source,
-                  file: osAgnosticPath(issue.source.file),
-                },
-              }),
-              message: issue.message.replace(
-                /['"]([^'"]*[/\\][^'"]*)['"]/g,
-                "'<PATH>'",
-              ),
-            })),
+      audits: osAgnosticAuditOutputs(plugin.audits, message =>
+        message.replace(
+          /['"]([^'"]*[/\\][^'"]*)['"]/g,
+          (fullMatch: string, capturedPath: string) => {
+            const osAgnostic = osAgnosticPath(capturedPath);
+            // Only replace directory paths, not .ts file paths
+            if (capturedPath.endsWith('.ts')) {
+              return `'${osAgnostic}'`;
+            }
+            // on Windows the path starts from "plugin-typescript-e2e/src" not "./". This normalizes it to "./<segment>"
+            return `'${['.', osAgnostic.split('/').slice(-1)].join('/')}'`;
           },
-        }),
-      })),
+        ),
+      ),
     })),
   };
 }

packages/plugin-typescript/mocks/fixtures/basic-setup/tsconfig.extends-base.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "rootDir": "./src",
+    "rootDir": "${configDir}",
     "verbatimModuleSyntax": false
   },
   "include": ["src/**/*.ts"]

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

@@ -1,5 +1,6 @@
 import { describe, expect } from 'vitest';
-import { osAgnosticPath } from '@code-pushup/test-utils';
+import type { AuditOutputs } from '@code-pushup/models';
+import { osAgnosticAuditOutputs } from '@code-pushup/test-utils';
 import { getAudits } from '../utils.js';
 import { createRunnerFunction } from './runner.js';
 
@@ -13,24 +14,8 @@ describe('createRunnerFunction', () => {
 
     const result = await runnerFunction();
 
-    const sanitizedResult = result.map(audit => ({
-      ...audit,
-      ...(audit.details && {
-        details: {
-          ...audit.details,
-          issues: audit.details.issues?.map(issue => ({
-            ...issue,
-            ...(issue.source && {
-              source: {
-                ...issue.source,
-                file: osAgnosticPath(issue.source.file),
-              },
-            }),
-          })),
-        },
-      }),
-    }));
-
-    await expect(sanitizedResult).toMatchSnapshot();
+    await expect(
+      osAgnosticAuditOutputs(result as AuditOutputs),
+    ).toMatchSnapshot();
   }, 35_000);
 });

packages/plugin-typescript/src/lib/runner/utils.int.test.ts

@@ -1,5 +1,5 @@
 import * as tsModule from 'typescript';
-import { describe, expect } from 'vitest';
+import { describe, expect, vi } from 'vitest';
 import { osAgnosticPath } from '@code-pushup/test-utils';
 import { loadTargetConfig } from './utils.js';
 
@@ -48,11 +48,11 @@ describe('loadTargetConfig', () => {
       expect.objectContaining({
         fileNames: expect.arrayContaining([
           // from tsconfig.extends-base.json#includes and tsconfig.extends-extending.json#excludes
-          expect.stringContaining('src/0-no-diagnostics/'),
+          expect.stringMatching(/src[/\\]0-no-diagnostics[/\\]/),
         ]),
         options: expect.objectContaining({
           // Options from tsconfig.extends-base.json
-          rootDir: expect.stringContaining('src'),
+          rootDir: expect.stringMatching(/basic-setup$/),
           // Options from tsconfig.extends-extending.json
           module: 1,
           configFilePath: expect.stringContaining(

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

@@ -101,7 +101,7 @@ export function loadTargetConfig(tsConfigPath: string) {
 
   if (error) {
     throw new Error(
-      `Error reading TypeScript config file: \n${error.messageText}`,
+      `Error reading TypeScript config file at ${tsConfigPath}:\n${error.messageText}`,
     );
   }
 

project.json

@@ -1,5 +1,5 @@
 {
-  "name": "@code-pushup/cli-source",
+  "name": "cli-workspace",
   "$schema": "node_modules/nx/schemas/project-schema.json",
   "targets": {
     "code-pushup": {

testing/test-utils/src/lib/utils/os-agnostic-paths.ts

@@ -1,8 +1,4 @@
-import type {
-  AuditOutput,
-  AuditOutputs,
-  AuditReport,
-} from '@code-pushup/models';
+import type { AuditOutput, AuditReport } from '@code-pushup/models';
 
 const AGNOSTIC_PATH_SEP_REGEX = /[/\\]/g;
 const OS_AGNOSTIC_PATH_SEP = '/';
@@ -102,6 +98,7 @@ export function osAgnosticPath(filePath?: string): string | undefined {
 
 export function osAgnosticAudit<T extends AuditOutput | AuditReport>(
   audit: T,
+  transformMessage: (message: string) => string = s => s,
 ): T {
   const { issues = [] } = audit.details ?? {};
   if (issues.every(({ source }) => source == null)) {
@@ -119,12 +116,18 @@ export function osAgnosticAudit<T extends AuditOutput | AuditReport>(
                 ...issue.source,
                 file: osAgnosticPath(issue.source.file),
               },
+              message: transformMessage(issue.message),
             },
       ),
     },
   };
 }
 
-export function osAgnosticAuditOutputs(audits: AuditOutputs): AuditOutputs {
-  return audits.map(osAgnosticAudit);
+export function osAgnosticAuditOutputs<T extends AuditOutput | AuditReport>(
+  audits: T[],
+  transformAuditIssueMessage?: (message: string) => string,
+): T[] {
+  return audits.map(audit =>
+    osAgnosticAudit(audit, transformAuditIssueMessage),
+  );
 }