@codecompose/typescript-config 2.3.0 → 3.0.0

package/README.md

@@ -1,17 +1,20 @@
 # typescript-config
 
-Opinionated and reusable Typescript configurations, geared towards modern build tooling in both monorepos and single repositories.
+Opinionated and reusable TypeScript configurations, geared towards modern build tooling in both monorepos and single repositories.
 
-- Only use the Typescript compiler for type-checking (*) 
-- Use your bundler to output code, sourcemaps, and type declarations where needed.
-- Use strict settings, including `noUncheckedIndexedAccess` and `erasableSyntaxOnly`.
-- Assume `src` and `dist` directories
-- Use of `~/` or `@/` as path alias for `src`
-- Leverages TS 5.5 feature `${configDir}` to remove all client configuration.
+- Uses the TypeScript compiler for type-checking only (*)
+- Assumes your bundler outputs code, sourcemaps, and type declarations (*)
+- Requires TypeScript 6.0 or later
+- Builds on TS6 strict defaults with additional strictness: `noUncheckedIndexedAccess`, `noImplicitOverride`, and `erasableSyntaxOnly`
+- Assumes `src` and `dist` directories
+- Provides `~/` and `@/` path aliases for `src`
+- Uses `${configDir}` for zero per-project configuration
 
-(*) Project references / shared monorepo packages also emit code.
+(*) The shared-library and shared-react-library configs are an exception: they enable `composite`, `declaration`, and `declarationMap` because project references require TypeScript to emit declarations. Your bundler still handles the JavaScript output.
 
-To use this successfully, you would need a modern bundler like [tsdown](https://tsdown.dev/). You can check out the [mono-ts](https://github.com/0x80/mono-ts) boilerplate for a working example of a modern monorepo setup with tsdown.
+To use this successfully, you would need a modern bundler like [tsdown](https://tsdown.dev/). You can check out the [typescript-monorepo](https://github.com/0x80/typescript-monorepo) boilerplate for a working example of a modern monorepo setup with tsdown.
+
+These configurations are also compatible with [TSGo](https://github.com/nicksrandall/tsgo), the native Go port of the TypeScript compiler.
 
 
 ## Install
@@ -30,7 +33,7 @@ Often, no configuration is needed apart from `extends`.
 
 ## Available Configurations
 
-- `base` -  Anything non-specific
+- `base` - Anything non-specific
 - `library` - Standalone libraries (not part of a monorepo)
 - `shared-library` - Shared libraries in a monorepo
 - `react-library` - Standalone React component libraries (not part of a monorepo)
@@ -41,10 +44,39 @@ Often, no configuration is needed apart from `extends`.
 
 For other project types, like a CLI or E2E app, you can use the `base` configuration.
 
-## Assuming Bundler Output
+## V3 — TypeScript 6
+
+V3 is a major release that requires TypeScript 6.0 or later.
+
+TypeScript 6 aligns its defaults with the strict-by-default philosophy that this package has always followed. As a result, the base config is now leaner — options that are now TS6 defaults (`strict`, `esModuleInterop`) have been removed, and `isolatedModules` was dropped since it is implied by `verbatimModuleSyntax`.
 
-Outputs like sourcemaps and type declarations are disabled because it is assumed that your bundler will handle that.
+TS6 also defaults `types` to `[]`, meaning `@types/*` packages are no longer auto-included. If your project depends on ambient type packages, you need to explicitly add them to your tsconfig:
+
+```json
+{
+  "extends": "@codecompose/typescript-config/base",
+  "compilerOptions": {
+    "types": ["node"]
+  }
+}
+```
+
+This aligns with the strict-by-default philosophy — type dependencies should be explicit.
+
+For users upgrading from v2, see the migration guide below.
+
+## Migrating from v2
+
+- **TypeScript 6 is required** — there is no backward compatibility with TS5
+- **Removed `strict: true`** — now a TS6 default
+- **Removed `esModuleInterop: true`** — safe interop behavior is always on in TS6
+- **Removed `isolatedModules: true`** — implied by `verbatimModuleSyntax`
+- **Removed commented-out `baseUrl`** — deprecated in TS6
+- **Action required:** if you relied on auto-included `@types/*` packages, add `"types": ["node"]` (or whatever types you need) to your tsconfig
+
+## Assuming Bundler Output
 
+Outputs like sourcemaps and type declarations are disabled because it is assumed that your bundler will handle that. The shared-library and shared-react-library configs are an exception — they enable `declaration` and `declarationMap` because `composite` mode requires it for project references to work.
 
 ## Incremental Builds
 
@@ -57,7 +89,7 @@ recommend adding the following script to your manifest based on `del-cli`:
 
 ## Project References
 
-The shared-library and shared-react-library configurations have `composite` set to `true`. This is required for Typescript "project references" to work in a monorepo. They provide IDE go-to-definition, without having to emit the module output.
+The shared-library and shared-react-library configurations have `composite` set to `true`. This is required for TypeScript "project references" to work in a monorepo. They provide IDE go-to-definition, without having to emit the module output.
 
 In practice, this means that if you alter code in a shared package, the consuming app or library will pick up the changes, without requiring a watch task on the shared package to trigger a rebuild on every change.
 
@@ -67,13 +99,13 @@ If you prefer to work without project references, you should set your bundler to
 
 ## Publishing to NPM
 
-If you publish your package, it is recommended to include the Typescript source and type declaration maps. This allows the consumer to jump straight to the source code, which is great for overall readability and learning.
+If you publish your package, it is recommended to include the TypeScript source and type declaration maps. This allows the consumer to jump straight to the source code, which is great for overall readability and learning.
 
 To export source files next to your dist output, you define the `files` field in your package.json as `["src", "dist"]`.
 
 ## Caveats
 
-Older tooling might not correctly interpret the use of `${configDir}`, which this package uses extensively, and was only introduced in TS v5.5.
+Next.js v15 requires you to explicitly configure `include`. If you give it just "src" it will inject its own types on startup. I assume this will improve in the future.
 
-Next.js v15 requires you to explicitly configure "includes". If you give it just "src" it will inject its own types on startup. I assume this will improve in the future.
+The base configuration includes `"${configDir}/src/**/*.json"` alongside `"${configDir}/src"` because TypeScript's `include` only picks up supported extensions (`.ts`, `.tsx`, etc.) when given a directory path. If you override `include` in your project tsconfig, make sure to keep the JSON glob if you import JSON files.
 

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@codecompose/typescript-config",
   "description": "Opinionated reusable TypeScript configurations",
-  "version": "2.3.0",
+  "version": "3.0.0",
   "license": "MIT",
   "author": "Thijs Koerselman",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/0x80/typescript-config"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -31,5 +35,9 @@
     "./shared-library": "./src/shared-library.json",
     "./shared-react-library": "./src/shared-react-library.json"
   },
-  "devDependencies": {}
-}
+  "peerDependencies": {
+    "typescript": ">=6.0.0"
+  },
+  "devDependencies": {},
+  "packageManager": "pnpm@9.8.0"
+}

package/src/base.json

@@ -3,18 +3,15 @@
   "display": "Base configuration",
   "compilerOptions": {
     /* Base Options: */
-    "esModuleInterop": true,
     "skipLibCheck": true,
     "target": "esnext",
     "lib": ["esnext"],
     "allowJs": true,
     "resolveJsonModule": true,
     "moduleDetection": "force",
-    "isolatedModules": true,
     "verbatimModuleSyntax": true,
 
     /* Strictness */
-    "strict": true,
     "noUncheckedIndexedAccess": true,
     "noImplicitOverride": true,
     "erasableSyntaxOnly": true,
@@ -24,7 +21,6 @@
     "tsBuildInfoFile": "${configDir}/tsconfig.tsbuildinfo",
     "module": "preserve",
     "outDir": "${configDir}/dist",
-    // "baseUrl": "${configDir}",
     "rootDir": "${configDir}/src",
     "paths": {
       "~/*": ["${configDir}/src/*"],