@codecompose/typescript-config 1.1.2 → 1.2.0

package/README.md

@@ -3,23 +3,23 @@
 Opinionated reusable Typescript configurations, assuming:
 
 - A monorepo setup (\*)
-- Transpile with a bundler
+- Transpile using a bundler
 - Strict rules
 - Use of `src` and `dist` directories
 - Use of `~/` as path alias for `src`
 
 (\*) Use the `single-*.json` variants if you do **not** use a monorepo setup.
 
-All configurations have `incremental` set to `true`. For this reason I recommend
-adding the following script to your manifest based on `del-cli`:
+## Warning
 
-`"clean": "del dist tsconfig.tsbuildinfo"`
-
-In my experience, it can happen that builds get stuck in limbo and you need to
-delete the `tsbuildinfo` file to get things going again.
+At the time of writing, not all tooling correctly interprets the extended
+config.
 
-Source maps are not enabled, because we assume that your bundler will handle
-that.
+- Next.js will require you to explicitly defined "includes". Give it "src" and
+  it will inject its types on startup.
+- TSUP will not understand the tsconfig if you ask it to generate type
+  definitions. I use tsc to generate the types, as demonstrated in
+  [mono-ts](https://github.com/0x80/mono-ts).
 
 ## Install
 
@@ -37,9 +37,25 @@ that.
 
 ## Available Configurations
 
+- base
 - library
 - react-library
 - service
 - nextjs
 - single-library
 - single-react-library
+
+For something else, like a CLI or E2E app you can probably just use the
+`base.json` configuration.
+
+## Assumptions and Recommendations
+
+Source maps are not enabled, because we assume that your bundler will handle
+that.
+
+All configurations have `incremental` set to `true`. In my experience, it can
+happen that builds get stuck in limbo and you need to delete the `tsbuildinfo`
+file to get things going again. For this reason I recommend adding the following
+script to your manifest based on `del-cli`:
+
+`"clean": "del dist tsconfig.tsbuildinfo"`

package/base.json

@@ -20,7 +20,7 @@
 
     /* Opinion */
     "incremental": true,
-    "tsBuildInfoFile": "${configDir}/.tsbuildinfo",
+    "tsBuildInfoFile": "${configDir}/tsconfig.tsbuildinfo",
     "module": "preserve",
     "outDir": "${configDir}/dist",
     "baseUrl": "${configDir}",

package/library.json

@@ -5,9 +5,9 @@
   "compilerOptions": {
     /* AND if you're building for a library: */
     "declaration": true,
+    "declarationMap": true,
 
     /* AND if you're building for a library in a monorepo: */
-    "composite": true,
-    "declarationMap": true
+    "composite": true
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecompose/typescript-config",
   "description": "Opinionated reusable TypeScript configurations",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "license": "MIT",
   "author": "Thijs Koerselman",
   "publishConfig": {

package/react-library.json

@@ -3,7 +3,7 @@
   "display": "A React Component Library",
   "extends": "./base.json",
   "compilerOptions": {
-    "lib": ["dom", "dom.iterable", "es2023"],
+    "lib": ["dom", "dom.iterable", "esnext"],
     "jsx": "react-jsx",
 
     /* AND if you're building for a library: */

package/single-library.json

@@ -4,6 +4,7 @@
   "extends": "./base.json",
   "compilerOptions": {
     /* AND if you're building for a library: */
-    "declaration": true
+    "declaration": true,
+    "declarationMap": true
   }
 }

package/single-react-library.json

@@ -3,10 +3,11 @@
   "display": "A Single React Component Library",
   "extends": "./base.json",
   "compilerOptions": {
-    "lib": ["dom", "dom.iterable", "es2023"],
+    "lib": ["dom", "dom.iterable", "esnext"],
     "jsx": "react-jsx",
 
     /* AND if you're building for a library: */
-    "declaration": true
+    "declaration": true,
+    "declarationMap": true
   }
 }