@codecompose/typescript-config 1.1.3 → 2.0.0

package/README.md

@@ -1,25 +1,33 @@
 # typescript-config
 
-Opinionated reusable Typescript configurations, assuming:
+Opinionated reusable Typescript configurations. Out-of-the-box we assume:
 
-- A monorepo setup (\*)
-- Transpile with a bundler
-- Strict rules
+- You transpile using a bundler
+- You want 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.
+Of course, you can still choose to override any of the defaults in your own
+config.
 
-All configurations have `incremental` set to `true`. For this reason I recommend
-adding the following script to your manifest based on `del-cli`:
+## Structure
 
-`"clean": "del dist tsconfig.tsbuildinfo"`
+Configurations are organized based on their intended use:
 
-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.
+- **Root configurations**: For stand-alone projects or general use
+- **Monorepo configurations**: Under the `/monorepo` path for monorepo-specific
+  setups
 
-Source maps are not enabled, because we assume that your bundler will handle
-that.
+## Warning
+
+At the time of writing, not all tooling correctly interprets the use of
+`${configDir}` introduced in TS v5.5 that this package depends on.
+
+- 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
 
@@ -29,17 +37,59 @@ that.
 
 ## Usage
 
+For non-monorepo projects:
+
 ```json
 {
-  "extends": "@codecompose/typescript-config/single-react-library.json"
+  "extends": "@codecompose/typescript-config/library"
 }
 ```
 
+For monorepo projects:
+
+```json
+{
+  "extends": "@codecompose/typescript-config/monorepo/library"
+}
+```
+
+Note: The `.json` extension is no longer needed in imports.
+
 ## Available Configurations
 
-- library
-- react-library
-- service
-- nextjs
-- single-library
-- single-react-library
+### Base Configuration
+
+- `base` - Base configuration with common settings
+
+### Stand-alone Configurations
+
+- `library` - For general libraries
+- `react-library` - For React component libraries
+- `nextjs` - For Next.js applications
+- `service` - For a backend service like and API server or cloud function
+
+### Monorepo Configurations
+
+When using a monorepo, the packages that other packages depend on should use the
+enhanced variant.
+
+- `monorepo/library` - For shared libraries in a monorepo
+- `monorepo/react-library` - For shared React component libraries in a monorepo
+
+The `nextjs` and `service` configs are compatible with both monorepo and
+non-monorepo.
+
+For other project types, like a CLI or E2E app, you can probably just use the
+`base` 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
+`tsconfig.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-cli dist tsconfig.tsbuildinfo"`

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecompose/typescript-config",
   "description": "Opinionated reusable TypeScript configurations",
-  "version": "1.1.3",
+  "version": "2.0.0",
   "license": "MIT",
   "author": "Thijs Koerselman",
   "publishConfig": {
@@ -11,22 +11,26 @@
     "typescript",
     "config",
     "configuration",
+    "monorepo",
     "strict",
     "reusable",
-    "base",
     "nextjs",
+    "react",
     "library",
     "service"
   ],
   "files": [
-    "base.json",
-    "library.json",
-    "nextjs.json",
-    "react-library.json",
-    "service.json",
-    "single-library.json",
-    "single-react-library.json"
+    "src"
   ],
+  "exports": {
+    "./base": "./src/base.json",
+    "./library": "./src/library.json",
+    "./nextjs": "./src/nextjs.json",
+    "./react-library": "./src/react-library.json",
+    "./service": "./src/service.json",
+    "./monorepo/library": "./src/monorepo/library.json",
+    "./monorepo/react-library": "./src/monorepo/react-library.json"
+  },
   "devDependencies": {
     "eslint": "^8.57.0",
     "prettier": "^3.3.3",

package/{base.json → src/base.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
-  "display": "Base Configuration",
+  "display": "Base configuration",
   "compilerOptions": {
     /* Base Options: */
     "esModuleInterop": true,

package/{library.json → src/library.json}

@@ -1,13 +1,10 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
-  "display": "A Shared Library",
+  "display": "Standalone shared library",
   "extends": "./base.json",
   "compilerOptions": {
     /* AND if you're building for a library: */
     "declaration": true,
-
-    /* AND if you're building for a library in a monorepo: */
-    "composite": true,
     "declarationMap": true
   }
 }

package/src/monorepo/library.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Monorepo shared library",
+  "extends": "../library.json",
+  "compilerOptions": {
+    /* AND if you're building for a library in a monorepo: */
+    "composite": true
+  }
+}

package/src/monorepo/react-library.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Monorepo React component library",
+  "extends": "../react-library.json",
+  "compilerOptions": {
+    /* AND if you're building for a library in a monorepo: */
+    "composite": true,
+    "declarationMap": true
+  }
+}

package/{nextjs.json → src/nextjs.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
-  "display": "A Next.js App",
+  "display": "Next.js app",
   "extends": "./base.json",
   "compilerOptions": {
     "jsx": "preserve", // next does its own jsx transformation

package/{react-library.json → src/react-library.json}

@@ -1,16 +1,13 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
-  "display": "A React Component Library",
+  "display": "Standalone 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,
-
-    /* AND if you're building for a library in a monorepo: */
-    "composite": true,
     "declarationMap": true
   }
 }

package/{service.json → src/service.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
-  "display": "A Backend Service",
+  "display": "Backend service",
   "extends": "./base.json",
   "compilerOptions": {}
 }

package/single-library.json

@@ -1,9 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "display": "A Single Shared Library",
-  "extends": "./base.json",
-  "compilerOptions": {
-    /* AND if you're building for a library: */
-    "declaration": true
-  }
-}

package/single-react-library.json

@@ -1,12 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "display": "A Single React Component Library",
-  "extends": "./base.json",
-  "compilerOptions": {
-    "lib": ["dom", "dom.iterable", "es2023"],
-    "jsx": "react-jsx",
-
-    /* AND if you're building for a library: */
-    "declaration": true
-  }
-}