@foxglove/tsconfig 2.0.1-trusted-publishing-test.2 → 3.1.0

package/README.md

@@ -4,11 +4,27 @@
 
 Base tsconfig for Foxglove projects.
 
-To use, run `yarn add -D @foxglove/tsconfig`, then extend your `tsconfig.json` like so:
+## Requirements
+
+- TypeScript v5.8+
+
+## Installation
+
+```sh
+yarn add -D @foxglove/tsconfig
+```
+
+## Usage
+
+Choose the config that matches your environment:
+
+### Node.js applications and libraries
+
+Uses `module: "NodeNext"` which enforces Node.js ESM rules, where imports must include explicit file extensions (e.g., `import { foo } from "./bar.ts"`).
 
 ```json
 {
-  "extends": "@foxglove/tsconfig/base",
+  "extends": "@foxglove/tsconfig/node.json",
   "include": ["./src/**/*"],
   "compilerOptions": {
     "rootDir": "./src",
@@ -17,6 +33,39 @@ To use, run `yarn add -D @foxglove/tsconfig`, then extend your `tsconfig.json` l
 }
 ```
 
+> **Note:** Uses `target: "ESNext"`. For older Node.js versions, set a lower target (e.g., `"ES2022"` for Node 18).
+
+> **Cross-platform libraries:** Use `node.json` even if your library will be used in bundled apps. Bundlers consume Node-style packages natively, just remember to avoid Node-specific APIs like `fs` or `process`.
+
+### Bundled applications (Vite, Webpack, esbuild, etc)
+
+Uses `module: "Preserve"` which allows extensionless imports (e.g., `import { foo } from "./bar"`, where the bundler handles resolution.
+
+```json
+{
+  "extends": "@foxglove/tsconfig/bundler.json",
+  "include": ["./src/**/*"],
+  "compilerOptions": {
+    "noEmit": true,
+    "lib": ["ESNext", "DOM"]
+  }
+}
+```
+
+### Base config
+
+Provides strict type-checking and modern defaults, but no `module` or `moduleResolution` settings. Use this when `node.json` and `bundler.json` don't fit your environment:
+
+```json
+{
+  "extends": "@foxglove/tsconfig/base.json",
+  "compilerOptions": {
+    "module": "...",
+    "moduleResolution": "..."
+  }
+}
+```
+
 ## License
 
 [MIT License](/LICENSE.md)

package/base.json

@@ -1,51 +1,41 @@
 // -*- jsonc -*-
 // Base TypeScript configuration
+// You typically shouldn't extend from this file directly
+// See `node.json` and `bundler.json` for environment-specific settings
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
-    // build es2022 modules by default
-    "module": "es2022",
-    "target": "es2022",
-    "lib": ["es2022"],
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "importHelpers": true,
+    // Language
+    "target": "ESNext",
 
-    // enable JS only as needed on per-project basis
-    "allowJs": false,
-
-    // required to support esbuild, babel, and similar transpilers
-    "isolatedModules": true,
-
-    // disable composite/incremental builds by default to prevent .tsbuildinfo files from being
-    // accidentally included in package archives
-    "composite": false,
-    "incremental": false,
-
-    // produce consistent output across all platforms
-    "newLine": "lf",
+    // Type checking
+    "strict": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
 
-    // allow typed JSON imports
+    // Modules
+    "erasableSyntaxOnly": true,
+    "noUncheckedSideEffectImports": true,
     "resolveJsonModule": true,
+    "rewriteRelativeImportExtensions": true,
+    "verbatimModuleSyntax": true,
 
-    // produce .js.map, .d.ts and .d.ts.map files when emit is enabled
-    "noEmit": false,
+    // Interop
+    "forceConsistentCasingInFileNames": true,
+    "isolatedModules": true,
+
+    // Emit
     "declaration": true,
     "declarationMap": true,
+    "isolatedDeclarations": true,
+    "newLine": "lf",
     "sourceMap": true,
 
-    // recommended for faster compilation
-    "skipLibCheck": true,
-
-    // be as strict as possible, but no stricter
-    "strict": true,
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitAny": true,
-    "noImplicitReturns": true,
-    "noUncheckedIndexedAccess": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noImplicitOverride": true,
-    "forceConsistentCasingInFileNames": true
+    // Performance
+    "skipLibCheck": true
   }
 }

package/bundler.json

@@ -0,0 +1,11 @@
+// -*- jsonc -*-
+// TypeScript configuration for frontend/bundled applications (Webpack, esbuild, etc)
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./base.json",
+  "compilerOptions": {
+    // Bundler handles module resolution
+    "module": "Preserve",
+    "moduleResolution": "Bundler"
+  }
+}

package/node.json

@@ -0,0 +1,11 @@
+// -*- jsonc -*-
+// TypeScript configuration for Node.js applications and libraries
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./base.json",
+  "compilerOptions": {
+    // Node.js ESM
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foxglove/tsconfig",
-  "version": "2.0.1-trusted-publishing-test.2",
+  "version": "3.1.0",
   "description": "Base TypeScript configuration for Foxglove projects",
   "license": "MIT",
   "repository": {
@@ -14,16 +14,18 @@
     "url": "https://foxglove.dev/"
   },
   "packageManager": "yarn@4.12.0",
+  "type": "module",
   "files": [
-    "base.json"
+    "base.json",
+    "node.json",
+    "bundler.json"
   ],
   "scripts": {
-    "clean": "rm -rf dist",
-    "build": "yarn clean && tsc --project base.json --outDir dist",
     "fmt": "prettier --write .",
     "fmt:check": "prettier --check .",
     "lint": "eslint --fix .",
-    "lint:check": "eslint ."
+    "lint:check": "eslint .",
+    "test": "tsc -p test/node.tsconfig.json && tsc -p test/bundler.tsconfig.json"
   },
   "devDependencies": {
     "@foxglove/eslint-plugin": "2.1.0",