feat!: validate emitDeclarationOnly compiler option

BREAKING CHANGE: `emitDeclarationOnly` is now a required compiler option. Run `plugin-kit verify-package` to get hints about how to apply required changes.
sanity-io · Jan 2, 2023 · d60d46e · d60d46e
1 parent 9d753c2
commit d60d46e
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 4 deletions.
diff --git a/src/actions/verify/validations.ts b/src/actions/verify/validations.ts
@@ -125,6 +125,7 @@ export async function validateTsConfig(
     moduleResolution: 'node',
     target: 'esnext',
     module: 'esnext',
+    emitDeclarationOnly: true,
     esModuleInterop: true,
     skipLibCheck: true,
     isolatedModules: true,

diff --git a/tap-snapshots/test/verify-package.test.ts.test.cjs b/tap-snapshots/test/verify-package.test.ts.test.cjs
@@ -125,12 +125,13 @@ 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, esModuleInterop, skipLibCheck, isolatedModules, downlevelIteration, declaration, allowSyntheticDefaultImports, rootDir, outDir]
+The following fields had unexpected values: [jsx, moduleResolution, target, module, emitDeclarationOnly, esModuleInterop, skipLibCheck, isolatedModules, downlevelIteration, declaration, allowSyntheticDefaultImports, rootDir, outDir]
 Expected to find these values:
 "jsx": "preserve",
 "moduleResolution": "node",
 "target": "esnext",
 "module": "esnext",
+"emitDeclarationOnly": true,
 "esModuleInterop": true,
 "skipLibCheck": true,
 "isolatedModules": true,

diff --git a/test/fixtures/inject/valid/tsconfig.json b/test/fixtures/inject/valid/tsconfig.json
@@ -18,7 +18,8 @@
     "skipLibCheck": true,
     "isolatedModules": true,
     "checkJs": false,
-    "rootDir": "."
+    "rootDir": ".",
+    "emitDeclarationOnly": true
   },
   "include": ["src/**/*"]
 }
diff --git a/test/fixtures/verify-package/invalid-eslint/tsconfig.json b/test/fixtures/verify-package/invalid-eslint/tsconfig.json
@@ -17,7 +17,8 @@
     "outDir": "dist",
     "skipLibCheck": true,
     "isolatedModules": true,
-    "checkJs": false
+    "checkJs": false,
+    "emitDeclarationOnly": true
   },
   "include": ["src/**/*"]
 }
diff --git a/test/fixtures/verify-package/valid/tsconfig.json b/test/fixtures/verify-package/valid/tsconfig.json
@@ -18,7 +18,8 @@
     "skipLibCheck": true,
     "isolatedModules": true,
     "checkJs": false,
-    "rootDir": "."
+    "rootDir": ".",
+    "emitDeclarationOnly": true
   },
   "include": ["src/**/*"]
 }