grist-widget-sdk 0.3.20 → 0.3.25

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # grist-widget-sdk
 
+## 0.3.25
+
+### Patch Changes
+
+- bbcca4d: New: shared TypeScript settings for widgets, to `extends` from a widget's own tsconfig files. `grist-widget-sdk/tsconfig/app.json` covers the browser code in `src/` (bundler resolution, `react-jsx`, `strict` and the unused-code checks); `grist-widget-sdk/tsconfig/node.json` covers `vite.config.ts`. Both are the settings scaffolded widgets have used so far, so a compiler-setting change can now reach widgets with an SDK update instead of a hand edit in each one. They need TypeScript 5.8 or later. A change that makes a check stricter can fail a widget's typecheck, so it only ships in a minor release.
+
 ## 0.3.20
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "grist-widget-sdk",
-  "version": "0.3.20",
+  "version": "0.3.25",
   "description": "React hooks and helpers for Grist custom widgets",
   "license": "MIT",
   "engines": {
@@ -89,10 +89,13 @@
         "types": "./dist/emulator/devtools.d.cts",
         "default": "./dist/emulator/devtools.cjs"
       }
-    }
+    },
+    "./tsconfig/app.json": "./tsconfig/app.json",
+    "./tsconfig/node.json": "./tsconfig/node.json"
   },
   "files": [
     "dist",
+    "tsconfig",
     "CHANGELOG.md",
     "LICENSE"
   ],

package/tsconfig/app.json

@@ -0,0 +1,38 @@
+{
+  // Shared TypeScript settings for a widget's browser code (src/).
+  //
+  //   // tsconfig.app.json
+  //   { "extends": "grist-widget-sdk/tsconfig/app.json", ... }
+  //
+  // The widget's own file keeps whatever names its files and packages:
+  // tsBuildInfoFile, paths and include (TypeScript resolves those relative
+  // to the file that declares them), and types (its own list of global type
+  // packages, e.g. "vite/client"; a list set there would replace this one).
+  //
+  // Needs TypeScript 5.8 or later (erasableSyntaxOnly). Making a check
+  // stricter can fail a widget's typecheck, so it only happens in a minor
+  // (breaking, before 1.0) release of grist-widget-sdk.
+  "compilerOptions": {
+    "target": "ES2022",
+    "useDefineForClassFields": true,
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "erasableSyntaxOnly": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true
+  }
+}

package/tsconfig/node.json

@@ -0,0 +1,36 @@
+{
+  // Shared TypeScript settings for a widget's build config (vite.config.ts),
+  // which runs in Node.
+  //
+  //   // tsconfig.node.json
+  //   { "extends": "grist-widget-sdk/tsconfig/node.json", ... }
+  //
+  // The widget's own file keeps tsBuildInfoFile and include (TypeScript
+  // resolves those relative to the file that declares them) and types
+  // (e.g. "node").
+  //
+  // Needs TypeScript 5.8 or later (erasableSyntaxOnly). Making a check
+  // stricter can fail a widget's typecheck, so it only happens in a minor
+  // (breaking, before 1.0) release of grist-widget-sdk.
+  "compilerOptions": {
+    "target": "ES2023",
+    "lib": ["ES2023"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "erasableSyntaxOnly": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true
+  }
+}