fix(test runner): improve error message when not able to parse tsconf…

…ig (#32526)
microsoft · Sep 9, 2024 · 6bb005d · 6bb005d
1 parent e6c5b60
commit 6bb005d
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 3 deletions.
diff --git a/packages/playwright/src/third_party/tsconfig-loader.ts b/packages/playwright/src/third_party/tsconfig-loader.ts
@@ -53,9 +53,13 @@ export interface LoadedTsConfig {
 }
 
 export function loadTsConfig(configPath: string): LoadedTsConfig[] {
-  const references: LoadedTsConfig[] = [];
-  const config = innerLoadTsConfig(configPath, references);
-  return [config, ...references];
+  try {
+    const references: LoadedTsConfig[] = [];
+    const config = innerLoadTsConfig(configPath, references);
+    return [config, ...references];
+  } catch (e) {
+    throw new Error(`Failed to load tsconfig file at ${configPath}:\n${e.message}`);
+  }
 }
 
 function resolveConfigFile(baseConfigFile: string, referencedConfigFile: string) {

diff --git a/tests/playwright-test/resolver.spec.ts b/tests/playwright-test/resolver.spec.ts
@@ -16,6 +16,24 @@
 
 import { test, expect } from './playwright-test-fixtures';
 
+test('should print tsconfig parsing error', async ({ runInlineTest }) => {
+  const files = {
+    'a.spec.ts': `
+      import { test } from '@playwright/test';
+      test('pass', async () => {});
+    `,
+    'tsconfig.json': `
+      "foo": "bar"
+    `,
+  };
+
+  const result = await runInlineTest(files);
+  expect(result.exitCode).toBe(1);
+  expect(result.output).toContain(`Failed to load tsconfig file at`);
+  expect(result.output).toContain(`tsconfig.json`);
+  expect(result.output).toContain(`JSON5: invalid character ':' at 2:12`);
+});
+
 test('should respect path resolver', async ({ runInlineTest }) => {
   test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/11656' });