Build: Simplify tsconfig.json files (WordPress#68326)

TypeScript 5.5 introduced a configDir variable that can be used for templating tsconfig.json files. This significantly reduces repitition in tsconfig.json files. - Add standardized configuration to base tsconfig.json file. - Remove redundant configuration from package tsconfig.json files. - Remove redundant file globs (e.g. src instead of src/**/*). --- Co-authored-by: sirreal <[email protected]> Co-authored-by: manzoorwanijk <[email protected]>
carstingaxion · Dec 27, 2024 · ca61601 · ca61601
1 parent e726912
commit ca61601
Show file tree

Hide file tree

Showing 59 changed files with 85 additions and 260 deletions.
diff --git a/bin/tsconfig.json b/bin/tsconfig.json
@@ -16,6 +16,7 @@
 		"noEmit": true,
 		"outDir": ".cache"
 	},
+	"include": [],
 	"files": [
 		"./api-docs/update-api-docs.js",
 		"./plugin/config.js",

diff --git a/bin/validate-tsconfig.mjs b/bin/validate-tsconfig.mjs
@@ -29,14 +29,33 @@ for ( const packageName of packagesWithTypes ) {
 		hasErrors = true;
 	}
 
-	const packageJson = JSON.parse(
-		readFileSync( `packages/${ packageName }/package.json`, 'utf8' )
-	);
-	const tsconfigJson = JSON.parse(
-		stripJsonComments(
-			readFileSync( `packages/${ packageName }/tsconfig.json`, 'utf8' )
-		)
-	);
+	let packageJson;
+	try {
+		packageJson = JSON.parse(
+			readFileSync( `packages/${ packageName }/package.json`, 'utf8' )
+		);
+	} catch ( e ) {
+		console.error(
+			`Error parsing package.json for package ${ packageName }`
+		);
+		throw e;
+	}
+	let tsconfigJson;
+	try {
+		tsconfigJson = JSON.parse(
+			stripJsonComments(
+				readFileSync(
+					`packages/${ packageName }/tsconfig.json`,
+					'utf8'
+				)
+			)
+		);
+	} catch ( e ) {
+		console.error(
+			`Error parsing tsconfig.json for package ${ packageName }`
+		);
+		throw e;
+	}
 	if ( packageJson.dependencies ) {
 		for ( const dependency of Object.keys( packageJson.dependencies ) ) {
 			if ( dependency.startsWith( '@wordpress/' ) ) {

diff --git a/packages/a11y/tsconfig.json b/packages/a11y/tsconfig.json
@@ -1,10 +1,5 @@
 {
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
-	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types"
-	},
-	"references": [ { "path": "../dom-ready" }, { "path": "../i18n" } ],
-	"include": [ "src/**/*" ]
+	"references": [ { "path": "../dom-ready" }, { "path": "../i18n" } ]
 }
diff --git a/packages/api-fetch/tsconfig.json b/packages/api-fetch/tsconfig.json
@@ -1,11 +1,6 @@
 {
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
-	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types"
-	},
 	"references": [ { "path": "../i18n" }, { "path": "../url" } ],
-	"include": [ "src/**/*" ],
-	"exclude": [ "**/test/**/*" ]
+	"exclude": [ "**/test" ]
 }
diff --git a/packages/autop/tsconfig.json b/packages/autop/tsconfig.json
@@ -1,10 +1,5 @@
 {
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
-	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types"
-	},
-	"references": [ { "path": "../dom-ready" } ],
-	"include": [ "src/**/*" ]
+	"references": [ { "path": "../dom-ready" } ]
 }
diff --git a/packages/blob/tsconfig.json b/packages/blob/tsconfig.json
@@ -1,9 +1,4 @@
 {
 	"$schema": "https://json.schemastore.org/tsconfig.json",
-	"extends": "../../tsconfig.base.json",
-	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types"
-	},
-	"include": [ "src/**/*" ]
+	"extends": "../../tsconfig.base.json"
 }
diff --git a/packages/block-editor/tsconfig.json b/packages/block-editor/tsconfig.json
@@ -1,10 +1,6 @@
 {
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
-	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types"
-	},
 	"references": [
 		{ "path": "../a11y" },
 		{ "path": "../api-fetch" },
@@ -37,5 +33,6 @@
 	// NOTE: This package is being progressively typed. You are encouraged to
 	// expand this array with files which can be type-checked. At some point in
 	// the future, this can be simplified to an `includes` of `src/**/*`.
-	"files": [ "src/components/block-context/index.js", "src/utils/dom.js" ]
+	"files": [ "src/components/block-context/index.js", "src/utils/dom.js" ],
+	"include": []
 }
diff --git a/packages/block-library/tsconfig.json b/packages/block-library/tsconfig.json
@@ -2,8 +2,6 @@
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types",
 		"types": [ "gutenberg-env" ],
 		"strictNullChecks": true
 	},

diff --git a/packages/block-serialization-default-parser/tsconfig.json b/packages/block-serialization-default-parser/tsconfig.json
@@ -1,9 +1,4 @@
 {
 	"$schema": "https://json.schemastore.org/tsconfig.json",
-	"extends": "../../tsconfig.base.json",
-	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types"
-	},
-	"include": [ "src/**/*" ]
+	"extends": "../../tsconfig.base.json"
 }
diff --git a/packages/components/tsconfig.json b/packages/components/tsconfig.json
@@ -2,8 +2,6 @@
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types",
 		"types": [
 			"gutenberg-env",
 			"gutenberg-test-env",
@@ -31,7 +29,6 @@
 		{ "path": "../rich-text" },
 		{ "path": "../warning" }
 	],
-	"include": [ "src/**/*" ],
 	"exclude": [
 		"src/**/*.android.js",
 		"src/**/*.ios.js",

diff --git a/packages/core-data/tsconfig.json b/packages/core-data/tsconfig.json
@@ -2,8 +2,6 @@
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types",
 		"checkJs": false,
 		"noImplicitAny": false
 	},
@@ -23,6 +21,5 @@
 		{ "path": "../undo-manager" },
 		{ "path": "../url" },
 		{ "path": "../warning" }
-	],
-	"include": [ "src/**/*" ]
+	]
 }
diff --git a/packages/data-controls/tsconfig.json b/packages/data-controls/tsconfig.json
@@ -2,14 +2,11 @@
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types",
 		"types": [ "gutenberg-env" ]
 	},
 	"references": [
 		{ "path": "../api-fetch" },
 		{ "path": "../data" },
 		{ "path": "../deprecated" }
-	],
-	"include": [ "src/**/*" ]
+	]
 }
diff --git a/packages/data/tsconfig.json b/packages/data/tsconfig.json
@@ -2,8 +2,6 @@
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types",
 		"checkJs": false
 	},
 	"references": [
@@ -14,6 +12,5 @@
 		{ "path": "../is-shallow-equal" },
 		{ "path": "../priority-queue" },
 		{ "path": "../redux-routine" }
-	],
-	"include": [ "src/**/*" ]
+	]
 }
diff --git a/packages/dataviews/tsconfig.json b/packages/dataviews/tsconfig.json
@@ -2,8 +2,6 @@
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types",
 		"types": [
 			"gutenberg-env",
 			"gutenberg-test-env",
@@ -22,7 +20,6 @@
 		{ "path": "../private-apis" },
 		{ "path": "../warning" }
 	],
-	"include": [ "src" ],
 	"exclude": [
 		"src/**/*.android.js",
 		"src/**/*.ios.js",

diff --git a/packages/date/tsconfig.json b/packages/date/tsconfig.json
@@ -1,10 +1,5 @@
 {
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
-	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types"
-	},
-	"references": [ { "path": "../deprecated" } ],
-	"include": [ "src/**/*" ]
+	"references": [ { "path": "../deprecated" } ]
 }
diff --git a/packages/deprecated/tsconfig.json b/packages/deprecated/tsconfig.json
@@ -1,10 +1,5 @@
 {
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
-	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types"
-	},
-	"references": [ { "path": "../hooks" } ],
-	"include": [ "src/**/*" ]
+	"references": [ { "path": "../hooks" } ]
 }
diff --git a/packages/docgen/tsconfig.json b/packages/docgen/tsconfig.json
@@ -2,8 +2,8 @@
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
-		"rootDir": "lib",
-		"declarationDir": "build-types"
+		"rootDir": "lib"
 	},
-	"include": [ "lib/get-leading-comments.js" ]
+	"files": [ "lib/get-leading-comments.js" ],
+	"include": []
 }
diff --git a/packages/dom-ready/tsconfig.json b/packages/dom-ready/tsconfig.json
@@ -1,9 +1,4 @@
 {
 	"$schema": "https://json.schemastore.org/tsconfig.json",
-	"extends": "../../tsconfig.base.json",
-	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types"
-	},
-	"include": [ "src/**/*" ]
+	"extends": "../../tsconfig.base.json"
 }
diff --git a/packages/dom/tsconfig.json b/packages/dom/tsconfig.json
@@ -2,10 +2,7 @@
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types",
 		"types": [ "gutenberg-env" ]
 	},
-	"include": [ "src/**/*" ],
 	"references": [ { "path": "../deprecated" } ]
 }
diff --git a/packages/e2e-test-utils-playwright/tsconfig.json b/packages/e2e-test-utils-playwright/tsconfig.json
@@ -7,16 +7,13 @@
 		"module": "Node16",
 		"moduleResolution": "node16",
 		"types": [ "node" ],
-		"rootDir": "src",
 		"noEmit": false,
 		"outDir": "build",
 		"sourceMap": true,
 		"declaration": true,
 		"declarationMap": true,
-		"declarationDir": "build-types",
 		"emitDeclarationOnly": false,
 		"allowJs": true,
 		"checkJs": false
-	},
-	"include": [ "src/**/*" ]
+	}
 }
diff --git a/packages/editor/tsconfig.json b/packages/editor/tsconfig.json
@@ -2,8 +2,6 @@
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types",
 		"checkJs": false
 	},
 	"references": [
@@ -34,6 +32,5 @@
 		{ "path": "../url" },
 		{ "path": "../warning" },
 		{ "path": "../wordcount" }
-	],
-	"include": [ "src" ]
+	]
 }
diff --git a/packages/element/tsconfig.json b/packages/element/tsconfig.json
@@ -2,12 +2,8 @@
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types",
-
 		"noImplicitAny": false,
 		"strictNullChecks": false
 	},
-	"references": [ { "path": "../escape-html" } ],
-	"include": [ "src/**/*" ]
+	"references": [ { "path": "../escape-html" } ]
 }
diff --git a/packages/escape-html/tsconfig.json b/packages/escape-html/tsconfig.json
@@ -1,9 +1,4 @@
 {
 	"$schema": "https://json.schemastore.org/tsconfig.json",
-	"extends": "../../tsconfig.base.json",
-	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types"
-	},
-	"include": [ "src/**/*" ]
+	"extends": "../../tsconfig.base.json"
 }
diff --git a/packages/eslint-plugin/tsconfig.json b/packages/eslint-plugin/tsconfig.json
@@ -3,12 +3,12 @@
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
 		"module": "CommonJS",
-		"rootDir": "rules",
-		"declarationDir": "build-types"
+		"rootDir": "rules"
 	},
 	"references": [ { "path": "../prettier-config" } ],
 	// NOTE: This package is being progressively typed. You are encouraged to
 	// expand this array with files which can be type-checked. At some point in
 	// the future, this can be simplified to an `includes` of `src/**/*`.
-	"files": [ "rules/dependency-group.js", "rules/no-unsafe-wp-apis.js" ]
+	"files": [ "rules/dependency-group.js", "rules/no-unsafe-wp-apis.js" ],
+	"include": []
 }
diff --git a/packages/fields/tsconfig.json b/packages/fields/tsconfig.json
@@ -2,8 +2,6 @@
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types",
 		"checkJs": false
 	},
 	"references": [
@@ -29,6 +27,5 @@
 		{ "path": "../url" },
 		{ "path": "../block-editor" },
 		{ "path": "../warning" }
-	],
-	"include": [ "src" ]
+	]
 }
diff --git a/packages/hooks/tsconfig.json b/packages/hooks/tsconfig.json
@@ -2,9 +2,6 @@
 	"$schema": "https://json.schemastore.org/tsconfig.json",
 	"extends": "../../tsconfig.base.json",
 	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types",
 		"types": [ "gutenberg-env" ]
-	},
-	"include": [ "src/**/*" ]
+	}
 }
diff --git a/packages/html-entities/tsconfig.json b/packages/html-entities/tsconfig.json
@@ -1,9 +1,4 @@
 {
 	"$schema": "https://json.schemastore.org/tsconfig.json",
-	"extends": "../../tsconfig.base.json",
-	"compilerOptions": {
-		"rootDir": "src",
-		"declarationDir": "build-types"
-	},
-	"include": [ "src/**/*" ]
+	"extends": "../../tsconfig.base.json"
 }