Fix tsconfig for test/ directory (#68346)

* Add @types/node for test/ directory files * Update tsconfig for e2e and performance test directories * Add test/e2e and test/performance to root tsconfig references * Expect TS error * Remove declaration files * Clean up tsconfig * Use @types/node v 20 * Use a hack instead of ts-expect-error
WordPress · Dec 27, 2024 · f1fadbb · f1fadbb · github-actions · Dec 27, 2024
1 parent 80e7991
commit f1fadbb
Show file tree

Hide file tree

Showing 8 changed files with 94 additions and 88 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -65,6 +65,7 @@
 		"@types/estree": "1.0.5",
 		"@types/istanbul-lib-report": "3.0.0",
 		"@types/mime": "2.0.3",
+		"@types/node": "20.17.10",
 		"@types/npm-package-arg": "6.1.1",
 		"@types/prettier": "2.4.4",
 		"@types/qs": "6.9.7",

diff --git a/test/e2e/playwright.config.ts b/test/e2e/playwright.config.ts
@@ -8,7 +8,7 @@ import { defineConfig, devices } from '@playwright/test';
 /**
  * WordPress dependencies
  */
-const baseConfig = require( '@wordpress/scripts/config/playwright.config' );
+import baseConfig from '@wordpress/scripts/config/playwright.config.js';
 
 const config = defineConfig( {
 	...baseConfig,

diff --git a/test/e2e/specs/interactivity/fixtures/index.ts b/test/e2e/specs/interactivity/fixtures/index.ts
@@ -18,8 +18,8 @@ export const test = base.extend< Fixtures >( {
 		async ( { requestUtils }, use ) => {
 			await use( new InteractivityUtils( { requestUtils } ) );
 		},
-		// @ts-ignore: The required type is 'test', but can be 'worker' too. See
+		// This is a hack, 'worker' is a valid value but the type is wrong.
 		// https://playwright.dev/docs/test-fixtures#worker-scoped-fixtures
-		{ scope: 'worker' },
+		{ scope: 'worker' as 'test' },
 	],
 } );
diff --git a/test/e2e/tsconfig.json b/test/e2e/tsconfig.json
@@ -2,11 +2,11 @@
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
+		"checkJs": false,
 		"noEmit": true,
-		"emitDeclarationOnly": false,
-		"allowJs": true,
-		"checkJs": false
+		"rootDir": ".",
+		"types": [ "node" ]
 	},
-	"include": [ "**/*" ],
+	"include": [ "." ],
 	"exclude": []
 }
diff --git a/test/performance/playwright.config.ts b/test/performance/playwright.config.ts
@@ -8,7 +8,7 @@ import { defineConfig } from '@playwright/test';
 /**
  * WordPress dependencies
  */
-const baseConfig = require( '@wordpress/scripts/config/playwright.config' );
+import baseConfig from '@wordpress/scripts/config/playwright.config.js';
 
 process.env.ASSETS_PATH = path.join( __dirname, 'assets' );
 

diff --git a/test/performance/tsconfig.json b/test/performance/tsconfig.json
@@ -2,11 +2,11 @@
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
+		"checkJs": false,
 		"noEmit": true,
-		"emitDeclarationOnly": false,
-		"allowJs": true,
-		"checkJs": false
+		"rootDir": ".",
+		"types": [ "node" ]
 	},
-	"include": [ "**/*" ],
+	"include": [ "." ],
 	"exclude": []
 }
diff --git a/tsconfig.json b/tsconfig.json
@@ -59,7 +59,9 @@
 		{ "path": "packages/url" },
 		{ "path": "packages/vips" },
 		{ "path": "packages/warning" },
-		{ "path": "packages/wordcount" }
+		{ "path": "packages/wordcount" },
+		{ "path": "test/e2e" },
+		{ "path": "test/performance" }
 	],
 	"files": []
 }