@codecompose/typescript-config 2.0.0 → 2.1.0-0

package/README.md

@@ -18,43 +18,18 @@ Configurations are organized based on their intended use:
 - **Monorepo configurations**: Under the `/monorepo` path for monorepo-specific
   setups
 
-## 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
 
-`pnpm i @codecompose/typescript-config -D`
-
-...or the equivalent for your package manager.
+`npm i @codecompose/typescript-config -D`
 
 ## Usage
 
-For non-monorepo projects:
-
 ```json
 {
-  "extends": "@codecompose/typescript-config/library"
+  "extends": "@codecompose/typescript-config/base"
 }
 ```
 
-For monorepo projects:
-
-```json
-{
-  "extends": "@codecompose/typescript-config/monorepo/library"
-}
-```
-
-Note: The `.json` extension is no longer needed in imports.
-
 ## Available Configurations
 
 ### Base Configuration
@@ -63,6 +38,7 @@ Note: The `.json` extension is no longer needed in imports.
 
 ### Stand-alone Configurations
 
+- `base` - For anything non-specific
 - `library` - For general libraries
 - `react-library` - For React component libraries
 - `nextjs` - For Next.js applications
@@ -71,16 +47,16 @@ Note: The `.json` extension is no longer needed in imports.
 ### Monorepo Configurations
 
 When using a monorepo, the packages that other packages depend on should use the
-enhanced variant.
+"shared" variant.
 
-- `monorepo/library` - For shared libraries in a monorepo
-- `monorepo/react-library` - For shared React component libraries in a monorepo
+- `shared-library` - For shared libraries in a monorepo
+- `shared-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.
+For other project types, like a CLI or E2E app, you can use the `base`
+configuration.
 
 ## Assumptions and Recommendations
 
@@ -93,3 +69,14 @@ happen that builds get stuck in limbo and you need to delete the
 recommend adding the following script to your manifest based on `del-cli`:
 
 `"clean": "del-cli dist tsconfig.tsbuildinfo"`
+
+## Known Issues
+
+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).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecompose/typescript-config",
   "description": "Opinionated reusable TypeScript configurations",
-  "version": "2.0.0",
+  "version": "2.1.0-0",
   "license": "MIT",
   "author": "Thijs Koerselman",
   "publishConfig": {
@@ -28,12 +28,8 @@
     "./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"
+    "./shared-library": "./src/shared-library.json",
+    "./shared-react-library": "./src/shared-react-library.json"
   },
-  "devDependencies": {
-    "eslint": "^8.57.0",
-    "prettier": "^3.3.3",
-    "prettier-plugin-jsdoc": "^1.3.0"
-  }
+  "devDependencies": {}
 }

package/src/base.json

@@ -18,6 +18,9 @@
     "noUncheckedIndexedAccess": true,
     "noImplicitOverride": true,
 
+    /* Assuming bundler will output EVERYTHING. You'll need a modern bundler
+    like tsdown to output declarationMaps for shared monorepo libraries. */
+    "noEmit": true,
     /* Opinion */
     "incremental": true,
     "tsBuildInfoFile": "${configDir}/tsconfig.tsbuildinfo",
@@ -26,9 +29,14 @@
     "baseUrl": "${configDir}",
     "rootDir": "${configDir}/src",
     "paths": {
-      "~/*": ["./src/*"]
+      "~/*": ["./src/*"],
+      "@/*": ["./src/*"]
     }
   },
   "include": ["${configDir}/src", "${configDir}/src/**/*.json"],
-  "exclude": ["${configDir}/node_modules", "${configDir}/dist"]
+  "exclude": [
+    "${configDir}/node_modules",
+    "${configDir}/dist",
+    "${configDir}/isolate"
+  ]
 }

package/src/library.json

@@ -3,8 +3,6 @@
   "display": "Standalone shared library",
   "extends": "./base.json",
   "compilerOptions": {
-    /* AND if you're building for a library: */
-    "declaration": true,
-    "declarationMap": true
+    /* Assuming your bundler will output declaration and declarationMap */
   }
 }

package/src/nextjs.json

@@ -5,7 +5,6 @@
   "compilerOptions": {
     "jsx": "preserve", // next does its own jsx transformation
     "lib": ["dom", "dom.iterable", "esnext"],
-    "noEmit": true,
     "rootDir": "${configDir}", // nextjs targets files outside of src in root as well
     "plugins": [
       {
@@ -18,6 +17,5 @@
     "${configDir}/**/*.json",
     "${configDir}/next-env.d.ts",
     "${configDir}/.next/types/**/*.ts"
-  ],
-  "exclude": ["${configDir}/node_modules"]
+  ]
 }

package/src/react-library.json

@@ -4,10 +4,6 @@
   "extends": "./base.json",
   "compilerOptions": {
     "lib": ["dom", "dom.iterable", "esnext"],
-    "jsx": "react-jsx",
-
-    /* AND if you're building for a library: */
-    "declaration": true,
-    "declarationMap": true
+    "jsx": "react-jsx"
   }
 }

package/src/shared-library.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Monorepo shared library",
+  "extends": "./library.json",
+  "compilerOptions": {
+    /* Required for project references, which provide go-to-definition in your IDE without first having to build the module, which is essential during development. */
+    "composite": true
+    /* Assuming your bundler will output type declarations and declaration-maps */
+  }
+}

package/src/shared-react-library.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Monorepo shared React component library",
+  "extends": "./react-library.json",
+  "compilerOptions": {
+    /* Required for project references, which provide go-to-definition in your IDE without first having to build the module, which is essential during development. */
+    "composite": true
+    /* Assuming your bundler will output type declarations and declaration-maps */
+  }
+}

package/src/monorepo/library.json

@@ -1,9 +0,0 @@
-{
-  "$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

@@ -1,10 +0,0 @@
-{
-  "$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
-  }
-}