core(tsc): add base tsconfig for config inheritance (#13072)

GoogleChrome · Sep 16, 2021 · c9ce384 · c9ce384
1 parent 92f1c2c
commit c9ce384
Show file tree

Hide file tree

Showing 10 changed files with 81 additions and 137 deletions.
diff --git a/flow-report/tsconfig.json b/flow-report/tsconfig.json
@@ -1,39 +1,23 @@
 {
+  "extends": "../tsconfig-base.json",
   "compilerOptions": {
-    "composite": true,
     "outDir": "../.tmp/tsbuildinfo/flow-report",
-    "emitDeclarationOnly": false,
-    "declarationMap": true,
 
     // Limit to base JS and DOM defs.
     "lib": ["es2020", "dom", "dom.iterable"],
-    // Selectively include types from node_modules.
+    // Selectively include types from node_modules/.
     "types": ["node", "jest"],
-    "target": "es2020",
-    "module": "es2020",
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-
-    "allowJs": true,
-    "checkJs": true,
-    "strict": true,
-    // TODO: remove the next line to be fully `strict`.
-    "useUnknownInCatchVariables": false,
-
-    // "listFiles": true,
-    // "noErrorTruncation": true,
-    "extendedDiagnostics": true,
 
     "jsx": "react-jsx",
     "jsxImportSource": "preact",
   },
+  "references": [
+    {"path": "../types/lhr/"},
+    {"path": "../report"},
+  ],
   "include": [
     "**/*.ts",
     "**/*.tsx",
     "./types",
   ],
-  "references": [
-    {"path": "../types/lhr/"},
-    {"path": "../report"},
-  ],
 }
diff --git a/lighthouse-treemap/tsconfig.json b/lighthouse-treemap/tsconfig.json
@@ -1,36 +1,20 @@
 {
+  "extends": "../tsconfig-base.json",
   "compilerOptions": {
-    "composite": true,
     "outDir": "../.tmp/tsbuildinfo/lighthouse-treemap",
-    "emitDeclarationOnly": true,
-    "declarationMap": true,
 
     // Limit to base JS and DOM defs.
     "lib": ["es2020", "dom", "dom.iterable"],
-    // Selectively include types from node_modules.
+    // Selectively include types from node_modules/.
     "types": ["tabulator-tables"],
-    "target": "es2020",
-    "module": "es2020",
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-
-    "allowJs": true,
-    "checkJs": true,
-    "strict": true,
-    // TODO: remove the next line to be fully `strict`.
-    "useUnknownInCatchVariables": false,
-
-    // "listFiles": true,
-    // "noErrorTruncation": true,
-    "extendedDiagnostics": true,
   },
-  "include": [
-    "app/src/**/*.js",
-    "types/**/*.d.ts",
-  ],
   "references": [
     {"path": "../types/lhr/"},
     {"path": "../report/"},
     {"path": "../lighthouse-viewer/"},
   ],
+  "include": [
+    "app/src/**/*.js",
+    "types/**/*.d.ts",
+  ],
 }
diff --git a/lighthouse-viewer/tsconfig.json b/lighthouse-viewer/tsconfig.json
@@ -1,35 +1,19 @@
 {
+  "extends": "../tsconfig-base.json",
   "compilerOptions": {
-    "composite": true,
     "outDir": "../.tmp/tsbuildinfo/lighthouse-viewer",
-    "emitDeclarationOnly": true,
-    "declarationMap": true,
 
     // Limit to base JS and DOM defs.
     "lib": ["es2020", "dom", "dom.iterable"],
-    // Don't include any types from node_modules.
+    // Don't include any types from node_modules/.
     "types": [],
-    "target": "es2020",
-    "module": "es2020",
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-
-    "allowJs": true,
-    "checkJs": true,
-    "strict": true,
-    // TODO: remove the next line to be fully `strict`.
-    "useUnknownInCatchVariables": false,
-
-    // "listFiles": true,
-    // "noErrorTruncation": true,
-    "extendedDiagnostics": true,
   },
-  "include": [
-    "app/src/**/*.js",
-    "./types/*.d.ts",
-  ],
   "references": [
     {"path": "../types/lhr/"},
     {"path": "../report/"}
   ],
+  "include": [
+    "app/src/**/*.js",
+    "./types/*.d.ts",
+  ],
 }
diff --git a/package.json b/package.json
@@ -68,7 +68,7 @@
     "dogfood-lhci": "./lighthouse-core/scripts/dogfood-lhci.sh",
     "timing-trace": "node lighthouse-core/scripts/generate-timing-trace.js",
     "changelog": "conventional-changelog --config ./build/changelog-generator/index.js --infile changelog.md --same-file",
-    "type-check": "tsc --build ./ report/ lighthouse-viewer/ lighthouse-treemap/ flow-report/",
+    "type-check": "tsc --build ./tsconfig-all.json",
     "i18n:checks": "./lighthouse-core/scripts/i18n/assert-strings-collected.sh",
     "i18n:collect-strings": "node lighthouse-core/scripts/i18n/collect-strings.js",
     "update:lantern-baseline": "node lighthouse-core/scripts/lantern/update-baseline-lantern-values.js",

diff --git a/report/generator/tsconfig.json b/report/generator/tsconfig.json
@@ -1,23 +1,12 @@
 {
+  "extends": "../../tsconfig-base.json",
   "compilerOptions": {
-    "composite": true,
     "outDir": "../../.tmp/tsbuildinfo/report/generator",
-    "emitDeclarationOnly": true,
-    "declarationMap": true,
 
-    "target": "ES2020",
-    "module": "commonjs",
-    "moduleResolution": "node",
-
-    "allowJs": true,
-    "checkJs": true,
-    "strict": true,
-    // TODO: remove the next line to be fully `strict`.
-    "useUnknownInCatchVariables": false,
-
-    // "listFiles": true,
-    // "noErrorTruncation": true,
-    "extendedDiagnostics": true,
+    // Limit defs to base JS and DOM (for URL: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/34960).
+    "lib": ["es2020", "dom"],
+    // Only include `@types/node` from node_modules/.
+    "types": ["node"],
   },
   "references": [
     {"path": "../../types/lhr/"},

diff --git a/report/tsconfig.json b/report/tsconfig.json
@@ -1,36 +1,21 @@
 {
+  "extends": "../tsconfig-base.json",
   "compilerOptions": {
-    "composite": true,
     "outDir": "../.tmp/tsbuildinfo/report",
-    "emitDeclarationOnly": true,
-    "declarationMap": true,
 
     // Limit to base JS and DOM defs.
     "lib": ["es2020", "dom", "dom.iterable"],
-    // Don't include any types from node_modules.
+    // Don't include any types from node_modules/.
     "types": [],
-    "target": "es2020",
-    "module": "es2020",
-    "moduleResolution": "node",
-
-    "allowJs": true,
-    "checkJs": true,
-    "strict": true,
-    // TODO: remove the next line to be fully `strict`.
-    "useUnknownInCatchVariables": false,
-
-    // "listFiles": true,
-    // "noErrorTruncation": true,
-    "extendedDiagnostics": true,
   },
-  "include": [
-    "**/*.js",
-    "types/**/*.d.ts",
-  ],
   "references": [
     {"path": "../types/lhr/"},
     {"path": "./generator/"}
   ],
+  "include": [
+    "**/*.js",
+    "types/**/*.d.ts",
+  ],
   "exclude": [
     "generator/**/*.js",
     // These test files require further changes before they can be type checked.

diff --git a/tsconfig-all.json b/tsconfig-all.json
@@ -0,0 +1,15 @@
+// Compilation entry point for all tsc projects within Lighthouse.
+
+{
+  "references": [
+    {"path": "./"},
+    {"path": "./types/lhr/"},
+    {"path": "./report/"},
+    {"path": "./report/generator/"},
+    {"path": "./lighthouse-viewer/"},
+    {"path": "./lighthouse-treemap/"},
+    {"path": "./flow-report/"},
+  ],
+  "files": [],
+  "include": [],
+}
diff --git a/tsconfig-base.json b/tsconfig-base.json
@@ -0,0 +1,24 @@
+// Base compiler options for all tsconfig files.
+
+{
+  "compilerOptions": {
+    "composite": true,
+    "emitDeclarationOnly": true,
+    "declarationMap": true,
+
+    "target": "es2020",
+    "module": "es2020",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+
+    "allowJs": true,
+    "checkJs": true,
+    "strict": true,
+    // TODO: remove the next line to be fully `strict`.
+    "useUnknownInCatchVariables": false,
+
+    // "listFiles": true,
+    // "noErrorTruncation": true,
+    "extendedDiagnostics": true,
+  },
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,22 +1,16 @@
 {
+  "extends": "./tsconfig-base.json",
   "compilerOptions": {
-    "emitDeclarationOnly": true,
-    "module": "commonjs",
-    "target": "ES2020",
-    "allowJs": true,
-    "checkJs": true,
-    "strict": true,
-    // TODO: remove the next line to be fully `strict`.
-    "useUnknownInCatchVariables": false,
-    // "listFiles": true,
-    // "noErrorTruncation": true,
+    "outDir": ".tmp/tsbuildinfo/",
 
+    // TODO(esmodules): included to support require('file.json'). Remove on the switch to ES Modules.
     "resolveJsonModule": true,
-    "diagnostics": true,
-    "composite": true,
-    "outDir": ".tmp/tsbuildinfo/",
-    "esModuleInterop": true,
   },
+  "references": [
+    {"path": "./types/lhr/"},
+    {"path": "./report/"},
+    {"path": "./report/generator/"},
+  ],
   "include": [
     "root.js",
     "lighthouse-cli/**/*.js",
@@ -36,11 +30,6 @@
     "third-party/snyk/snapshot.json",
     "lighthouse-core/audits/byte-efficiency/polyfill-graph-data.json",
   ],
-  "references": [
-    {"path": "./types/lhr/"},
-    {"path": "./report/"},
-    {"path": "./report/generator/"},
-  ],
   "exclude": [
     "lighthouse-core/test/audits/**/*.js",
     "lighthouse-core/test/fixtures/**/*.js",

diff --git a/types/lhr/tsconfig.json b/types/lhr/tsconfig.json
@@ -1,22 +1,12 @@
 {
+  "extends": "../../tsconfig-base.json",
   "compilerOptions": {
-    "module": "esnext",
-    "target": "esnext",
-    "esModuleInterop": true,
-    "moduleResolution": "node",
-
-    "strict": true,
-    "extendedDiagnostics": true,
+    "outDir": "../../.tmp/tsbuildinfo/types/lhr",
 
-    // We only need the base JS definitions, no libs in node_modules, no DOM, etc.
+    // We only need the base JS definitions, no DOM, etc.
     "lib": ["esnext"],
+    // Don't include any types from node_modules/.
     "types": [],
-
-    // "listFiles": true,
-    // "noErrorTruncation": true,
-
-    "composite": true,
-    "outDir": "../../.tmp/tsbuildinfo/types/lhr",
   },
   "include": [
     "*.d.ts",