feat!: validate presence of outDir in tsconfig

BREAKING CHANGE: `outDir` is now required in `tsconfig.json`. Run `plugin-kit verify-package` to get hints about how to apply required changes.
sanity-io · Jan 2, 2023 · 89d0978 · 89d0978
1 parent 34aaf9b
commit 89d0978
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 1 deletion.
diff --git a/assets/inject/template-tsconfig.json b/assets/inject/template-tsconfig.json
@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "outDir": "./lib",
     "jsx": "preserve",
     "moduleResolution": "node",
     "target": "esnext",

diff --git a/src/actions/verify/validations.ts b/src/actions/verify/validations.ts
@@ -34,6 +34,7 @@ const expectedCompilerOptions = {
   declaration: true,
   allowSyntheticDefaultImports: true,
   rootDir: 'src',
+  outDir: 'lib',
 }
 
 export function validateNodeEngine(packageJson: PackageJson) {

diff --git a/tap-snapshots/test/verify-package.test.ts.test.cjs b/tap-snapshots/test/verify-package.test.ts.test.cjs
@@ -128,7 +128,7 @@ To skip this validation add the following to your package.json:
 [error] 
 Recommended tsconfig.json compilerOptions missing:
 
-The following fields had unexpected values: [jsx, moduleResolution, target, module, sourceMap, inlineSourceMap, esModuleInterop, skipLibCheck, isolatedModules, downlevelIteration, declaration, allowSyntheticDefaultImports, rootDir]
+The following fields had unexpected values: [jsx, moduleResolution, target, module, sourceMap, inlineSourceMap, esModuleInterop, skipLibCheck, isolatedModules, downlevelIteration, declaration, allowSyntheticDefaultImports, rootDir, outDir]
 Expected to find these values:
 "jsx": "preserve",
 "moduleResolution": "node",
@@ -143,6 +143,7 @@ Expected to find these values:
 "declaration": true,
 "allowSyntheticDefaultImports": true,
 "rootDir": "src",
+"outDir": "lib",
 
 Please update your tsconfig.json accordingly.