chore: refactor tsconfigs in packages to reuse "include", "exclude" and "outDir" (#582)

kraenhansen · web-flow · commit f7f440240c17 · 2025-10-17T17:46:19.000+02:00
* Renamed ./lib to ./dist in download-url

* Removed unneeded special case in build-info

* Removed unused exclude in native-machine-id

* Moved include, exclude and outDir to base tsconfig.

* Removed unneeded overrides of defaults

* Extend react instead of setting "jsx"

* Updated the create-workspace script

* Remove unused "allowJs": true

* Remove empty compilerOptions objects
diff --git a/configs/tsconfig-devtools/tsconfig.common.json b/configs/tsconfig-devtools/tsconfig.common.json
@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "outDir": "${configDir}/dist",
     "allowJs": false,
     "esModuleInterop": true,
     "downlevelIteration": true,
@@ -14,5 +15,7 @@
     "sourceMap": true,
     "strict": true,
     "target": "ES2021"
-  }
+  },
+  "include": ["${configDir}/src/**/*"],
+  "exclude": ["${configDir}/src/**/*.spec.*"]
 }
diff --git a/packages/device-id/tsconfig.json b/packages/device-id/tsconfig.json
@@ -1,8 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/devtools-connect/tsconfig.json b/packages/devtools-connect/tsconfig.json
@@ -4,12 +4,6 @@
     "target": "es2020",
     "lib": ["es2020", "DOM"],
     "module": "commonjs",
-    "moduleResolution": "node",
-    "outDir": "./dist",
-    "allowJs": true,
-    "strict": true,
-    "jsx": "react"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+    "moduleResolution": "node"
+  }
 }
diff --git a/packages/devtools-proxy-support/tsconfig.json b/packages/devtools-proxy-support/tsconfig.json
@@ -1,10 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/dl-center/tsconfig.json b/packages/dl-center/tsconfig.json
@@ -1,10 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/download-url/.depcheckrc b/packages/download-url/.depcheckrc
@@ -5,4 +5,4 @@ ignores:
  - '@types/sinon-chai'
  - 'sinon'
 ignore-patterns:
- - 'lib'
+ - 'dist'
diff --git a/packages/download-url/.eslintignore b/packages/download-url/.eslintignore
@@ -1,2 +1,2 @@
 .nyc-output
-lib
+dist
diff --git a/packages/download-url/.gitignore b/packages/download-url/.gitignore
@@ -6,7 +6,6 @@ npm-debug.log
 coverage/
 
 package-lock.json
-.esm-wrapper.mjs
-lib/
+dist/
 .nyc_output
 tmp-*/
diff --git a/packages/download-url/.prettierignore b/packages/download-url/.prettierignore
@@ -1,3 +1,3 @@
 .nyc_output
-lib
+dist
 coverage
diff --git a/packages/download-url/bin/mongodb-download-url.js b/packages/download-url/bin/mongodb-download-url.js
@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require('../lib/bin.js');
+require('../dist/bin.js');
diff --git a/packages/download-url/package.json b/packages/download-url/package.json
@@ -5,7 +5,7 @@
   "scripts": {
     "bootstrap": "npm run compile",
     "prepublishOnly": "npm run compile",
-    "compile": "tsc -p tsconfig.json && gen-esm-wrapper . ./.esm-wrapper.mjs && prettier --write .esm-wrapper.mjs",
+    "compile": "tsc -p tsconfig.json && gen-esm-wrapper . ./dist/.esm-wrapper.mjs",
     "typecheck": "tsc --noEmit",
     "eslint": "eslint",
     "prettier": "prettier",
@@ -20,16 +20,16 @@
     "test-ci": "npm run test-cov",
     "reformat": "npm run prettier -- --write ."
   },
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "exports": {
     "require": {
-      "default": "./lib/index.js",
-      "types": "./lib/index.d.ts"
+      "default": "./dist/index.js",
+      "types": "./dist/index.d.ts"
     },
     "import": {
-      "default": "./.esm-wrapper.mjs",
-      "types": "./lib/index.d.ts"
+      "default": "./dist/.esm-wrapper.mjs",
+      "types": "./dist/index.d.ts"
     }
   },
   "bin": {
diff --git a/packages/download-url/tsconfig-lint.json b/packages/download-url/tsconfig-lint.json
@@ -1,5 +1,5 @@
 {
   "extends": "./tsconfig.json",
   "include": ["**/*"],
-  "exclude": ["node_modules", "lib"]
+  "exclude": ["node_modules", "dist"]
 }
diff --git a/packages/download-url/tsconfig.json b/packages/download-url/tsconfig.json
@@ -1,11 +1,8 @@
 {
   "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
   "compilerOptions": {
-    "outDir": "./lib",
     "target": "es2019",
     "lib": ["es2019"],
     "moduleResolution": "node"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  }
 }
diff --git a/packages/get-os-info/tsconfig.json b/packages/get-os-info/tsconfig.json
@@ -1,8 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/mongodb-build-info/tsconfig.json b/packages/mongodb-build-info/tsconfig.json
@@ -1,10 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true
-  },
-  "include": ["src/**/*", "test/**/*"],
-  "exclude": ["./src/**/*.spec.*", "./test/**/*.ts"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/mongodb-cloud-info/tsconfig.json b/packages/mongodb-cloud-info/tsconfig.json
@@ -1,10 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/mongodb-constants/tsconfig.json b/packages/mongodb-constants/tsconfig.json
@@ -1,8 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/mongodb-downloader/tsconfig.json b/packages/mongodb-downloader/tsconfig.json
@@ -1,12 +1,7 @@
 {
   "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
   "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true,
     "target": "es2020",
     "lib": ["es2020"]
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  }
 }
diff --git a/packages/mongodb-log-writer/tsconfig.json b/packages/mongodb-log-writer/tsconfig.json
@@ -1,8 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/mongodb-ns/tsconfig.json b/packages/mongodb-ns/tsconfig.json
@@ -1,8 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/mongodb-redact/tsconfig.json b/packages/mongodb-redact/tsconfig.json
@@ -1,11 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true,
-    "esModuleInterop": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/mongodb-runner/tsconfig.json b/packages/mongodb-runner/tsconfig.json
@@ -1,12 +1,7 @@
 {
   "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
   "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true,
     "target": "es2020",
     "lib": ["es2020"]
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  }
 }
diff --git a/packages/mongodb-ts-autocomplete/tsconfig.json b/packages/mongodb-ts-autocomplete/tsconfig.json
@@ -2,12 +2,6 @@
   "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
   "compilerOptions": {
     "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/types/*"],
-  "exclude": ["./src/**/*.spec.*"]
+    "moduleResolution": "NodeNext"
+  }
 }
diff --git a/packages/monorepo-tools/tsconfig.json b/packages/monorepo-tools/tsconfig.json
@@ -1,10 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/mql-typescript/tsconfig.json b/packages/mql-typescript/tsconfig.json
@@ -1,10 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/native-machine-id/tsconfig.json b/packages/native-machine-id/tsconfig.json
@@ -1,8 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*", "scripts/benchmark.ts"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/node-webpack-startup-snapshot-checker/tsconfig.json b/packages/node-webpack-startup-snapshot-checker/tsconfig.json
@@ -1,10 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/oidc-http-server-pages/tsconfig.json b/packages/oidc-http-server-pages/tsconfig.json
@@ -1,11 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true,
-    "jsx": "react"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.react.json"
 }
diff --git a/packages/oidc-mock-provider/tsconfig.json b/packages/oidc-mock-provider/tsconfig.json
@@ -1,10 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/query-parser/tsconfig.json b/packages/query-parser/tsconfig.json
@@ -1,10 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/saslprep/tsconfig.json b/packages/saslprep/tsconfig.json
@@ -1,10 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/sbom-tools/tsconfig.json b/packages/sbom-tools/tsconfig.json
@@ -1,10 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/shell-bson-parser/tsconfig.json b/packages/shell-bson-parser/tsconfig.json
@@ -1,10 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/signing-utils/tsconfig.json b/packages/signing-utils/tsconfig.json
@@ -1,10 +1,3 @@
 {
-  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "allowJs": true,
-    "strict": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["./src/**/*.spec.*"]
+  "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"
 }
diff --git a/packages/ts-autocomplete/tsconfig.json b/packages/ts-autocomplete/tsconfig.json
diff --git a/scripts/src/create-workspace.js b/scripts/src/create-workspace.js

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,3 @@`
`1`	`1`	`{`
`2`		`- "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",`
`3`		`- "compilerOptions": {`
`4`		`- "outDir": "dist"`
`5`		`- },`
`6`		`- "include": ["src/*/"],`
`7`		`- "exclude": ["./src/*/.spec.*"]`
	`2`	`+ "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"`
`8`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,3 @@`
`1`	`1`	`{`
`2`		`- "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json",`
`3`		`- "compilerOptions": {`
`4`		`- "outDir": "dist",`
`5`		`- "allowJs": true,`
`6`		`- "strict": true`
`7`		`- },`
`8`		`- "include": ["src/*/"],`
`9`		`- "exclude": ["./src/*/.spec.*"]`
	`2`	`+ "extends": "@mongodb-js/tsconfig-devtools/tsconfig.common.json"`
`10`	`3`	`}`
-Original file line number
+Diff line change
@@ @@ -1,3 +1,3 @@ @@
 .nyc_output
 -lib
 +dist
 coverage
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`#!/usr/bin/env node`
`2`		`-require('../lib/bin.js');`
	`2`	`+require('../dist/bin.js');`