@tractorbeam/typescript-config 0.3.0 → 0.5.0

package/README.md

@@ -1,6 +1,17 @@
 # @tractorbeam/typescript-config
 
-Shared `tsconfig` presets for Tractorbeam projects.
+Shared `tsconfig` presets for Tractorbeam projects. A package's `tsconfig.json` extends one base preset, adds any add-ons, and lists only the files it checks:
+
+```json
+{
+  "extends": [
+    "@tractorbeam/typescript-config/cloudflare-workers",
+    "@tractorbeam/typescript-config/effect",
+    "@tractorbeam/typescript-config/vitest"
+  ],
+  "include": ["src", "tests", "vitest.config.ts"]
+}
+```
 
 ## Install
 
@@ -8,23 +19,31 @@ Shared `tsconfig` presets for Tractorbeam projects.
 pnpm add -D @tractorbeam/typescript-config
 ```
 
-## Usage
+Install the packages a preset names in `types`, such as `@types/node`, too.
 
-In your project’s `tsconfig.json`:
+## Base presets
 
-```json
-{
-  "extends": "@tractorbeam/typescript-config/node22.json"
-}
-```
+Extend exactly one.
+
+The four bundler presets type-check code that a bundler or a type-stripping runner resolves. They emit nothing, preserve import syntax, allow `.ts` extensions in imports, and report unused locals and parameters. They share one `lib`, ES2023 with the DOM library for web-standard APIs such as `fetch` and `URL`, and differ only in the ambient `types` each environment needs:
+
+| Preset | For | `types` |
+| --- | --- | --- |
+| `bundler` | Runtime-neutral libraries | none |
+| `browser` | Browser code built with Vite, with its `vite.config.ts` | `node`, `vite/client` |
+| `node-bundler` | Node code that a bundler builds | `node` |
+| `cloudflare-workers` | Cloudflare Workers with `nodejs_compat` | `@cloudflare/workers-types`, `node` |
+
+The other bases keep their own conventions:
+
+- `node` and `node22`: Node code that `tsc` resolves with `nodenext`.
+- `next`: Next.js.
+- `tanstack-start`: TanStack Start.
+
+## Add-ons
 
-## Presets
+Add-ons go after the base in `extends` and set nothing a base sets, so they combine freely:
 
-- `@tractorbeam/typescript-config/node.json`
-- `@tractorbeam/typescript-config/node22.json`
-- `@tractorbeam/typescript-config/strictest.json`
-- `@tractorbeam/typescript-config/react.json`
-- `@tractorbeam/typescript-config/next.json`
-- `@tractorbeam/typescript-config/tanstack-start.json`
-- `@tractorbeam/typescript-config/vite.json`
-- `@tractorbeam/typescript-config/cloudflare-workers.json`
+- `effect`: the Effect language service, with its diagnostics off.
+- `vitest`: `import.meta.vitest` for in-source tests. It loads the types from a file, because a later preset's `types` would replace the base's instead of adding to them. Install `vitest` alongside it.
+- `strictest`: the strictest checking flags.

package/browser.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "lib": ["es2023", "esnext.disposable", "dom", "dom.iterable"],
+    "types": ["node", "vite/client"],
+    "target": "es2022",
+    "module": "preserve",
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "noEmit": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "skipLibCheck": true
+  }
+}

package/bundler.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "lib": ["es2023", "esnext.disposable", "dom", "dom.iterable"],
+    "types": [],
+    "target": "es2022",
+    "module": "preserve",
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "noEmit": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "skipLibCheck": true
+  }
+}

package/cloudflare-workers.json

@@ -1,19 +1,20 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
-    "target": "es2024",
-    "lib": ["es2024"],
+    "lib": ["es2023", "esnext.disposable", "dom", "dom.iterable"],
+    "types": ["@cloudflare/workers-types", "node"],
+    "target": "es2022",
+    "module": "preserve",
+    "moduleResolution": "bundler",
     "jsx": "react-jsx",
-    "module": "es2022",
-    "moduleResolution": "Bundler",
-    "resolveJsonModule": true,
-    "allowJs": true,
-    "checkJs": false,
+    "strict": true,
     "noEmit": true,
     "isolatedModules": true,
-    "allowSyntheticDefaultImports": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
     "skipLibCheck": true
   }
 }

package/effect.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "plugins": [{ "name": "@effect/language-service", "diagnostics": false }]
+  }
+}

package/node-bundler.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "lib": ["es2023", "esnext.disposable", "dom", "dom.iterable"],
+    "types": ["node"],
+    "target": "es2022",
+    "module": "preserve",
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "noEmit": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "skipLibCheck": true
+  }
+}

package/node.json

@@ -1,13 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
-    "lib": [
-      "es2024",
-      "ESNext.Array",
-      "ESNext.Collection",
-      "ESNext.Iterator",
-      "ESNext.Promise"
-    ],
+    "lib": ["es2024", "ESNext.Array", "ESNext.Collection", "ESNext.Iterator", "ESNext.Promise"],
     "module": "nodenext",
     "target": "es2024",
     "strict": true,

package/package.json

@@ -1,46 +1,60 @@
 {
   "name": "@tractorbeam/typescript-config",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Shared tsconfig presets for Tractorbeam projects",
   "keywords": [
+    "cloudflare-workers",
+    "effect",
+    "nextjs",
+    "tanstack",
     "tractorbeam",
     "tractorbeamai",
-    "typescript",
     "tsconfig",
     "tsconfig-bases",
-    "react",
-    "nextjs",
-    "vite",
-    "tanstack"
+    "typescript",
+    "vitest"
   ],
   "homepage": "https://github.com/tractorbeamai/reusables/tree/main/packages/typescript-config#readme",
   "bugs": {
     "url": "https://github.com/tractorbeamai/reusables/issues"
   },
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/tractorbeamai/reusables.git",
     "directory": "packages/typescript-config"
   },
-  "license": "MIT",
+  "files": [
+    "*.json",
+    "*.ts",
+    "package.json",
+    "README.md"
+  ],
   "type": "module",
   "exports": {
+    "./bundler": "./bundler.json",
+    "./browser": "./browser.json",
+    "./node-bundler": "./node-bundler.json",
+    "./cloudflare-workers": "./cloudflare-workers.json",
     "./node": "./node.json",
     "./node22": "./node22.json",
-    "./strictest": "./strictest.json",
-    "./react": "./react.json",
     "./next": "./next.json",
     "./tanstack-start": "./tanstack-start.json",
-    "./vite": "./vite.json",
-    "./cloudflare-workers": "./cloudflare-workers.json"
+    "./effect": "./effect.json",
+    "./vitest": "./vitest.json",
+    "./strictest": "./strictest.json",
+    "./presets": "./presets.ts"
   },
-  "files": [
-    "*.json",
-    "package.json",
-    "README.md"
-  ],
   "publishConfig": {
     "access": "public",
     "provenance": true
+  },
+  "peerDependencies": {
+    "vitest": "*"
+  },
+  "peerDependenciesMeta": {
+    "vitest": {
+      "optional": true
+    }
   }
 }

package/presets.ts

@@ -0,0 +1,25 @@
+import browser from "./browser.json" with { type: "json" };
+import bundler from "./bundler.json" with { type: "json" };
+import cloudflareWorkers from "./cloudflare-workers.json" with { type: "json" };
+import effect from "./effect.json" with { type: "json" };
+import next from "./next.json" with { type: "json" };
+import node from "./node.json" with { type: "json" };
+import nodeBundler from "./node-bundler.json" with { type: "json" };
+import node22 from "./node22.json" with { type: "json" };
+import strictest from "./strictest.json" with { type: "json" };
+import tanstackStart from "./tanstack-start.json" with { type: "json" };
+import vitest from "./vitest.json" with { type: "json" };
+
+export const presets = {
+  browser,
+  bundler,
+  "cloudflare-workers": cloudflareWorkers,
+  effect,
+  next,
+  node,
+  "node-bundler": nodeBundler,
+  node22,
+  strictest,
+  "tanstack-start": tanstackStart,
+  vitest,
+};

package/vitest.d.ts

@@ -0,0 +1 @@
+/// <reference types="vitest/importMeta" />

package/vitest.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "files": ["./vitest.d.ts"]
+}

package/react.json

@@ -1,23 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "compilerOptions": {
-    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
-    "target": "ES2022",
-    "useDefineForClassFields": true,
-    "lib": ["ES2022", "DOM", "DOM.Iterable"],
-    "module": "ESNext",
-    "skipLibCheck": true,
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "moduleDetection": "force",
-    "noEmit": true,
-    "jsx": "react-jsx",
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "erasableSyntaxOnly": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedSideEffectImports": true
-  }
-}

package/vite.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "isolatedModules": true,
-    "types": ["vite/client"],
-    "skipLibCheck": true
-  }
-}