@codecompose/typescript-config 1.0.5 → 1.1.1

package/README.md

@@ -1,31 +1,45 @@
 # typescript-config
 
-Opinionated reusable Typescript configurations.
+Opinionated reusable Typescript configurations, assuming:
 
-It assumes:
-
-- A monorepo setup
-- You transpile using a bundler
+- A monorepo setup (\*)
+- Transpile with a bundler
 - Strict rules
-- src and dist directories
-- ~/ as path alias for src
+- 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`:
+
+`"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.
+
+Source maps are not enabled, because we assume that your bundler will handle
+that.
 
 ## Install
 
-pnpm i @codecompose/typescript-config
+`pnpm i @codecompose/typescript-config -D`
+
+...or the equivalent for your package manager.
 
 ## Usage
 
 ```json
 {
-  "extends": "@codecompose/typescript-config/library.json"
+  "extends": "@codecompose/typescript-config/single-react-library.json"
 }
 ```
 
 ## Available Configurations
 
-- base
 - library
 - react-library
 - service
 - nextjs
+- single-library
+- single-react-library

package/library.json

@@ -3,9 +3,6 @@
   "display": "A Shared Library",
   "extends": "./base.json",
   "compilerOptions": {
-    /* If transpiling with TypeScript: */
-    "sourceMap": true,
-
     /* AND if you're building for a library: */
     "declaration": true,
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecompose/typescript-config",
   "description": "Opinionated reusable TypeScript configurations",
-  "version": "1.0.5",
+  "version": "1.1.1",
   "license": "MIT",
   "author": "Thijs Koerselman",
   "publishConfig": {
@@ -20,12 +20,16 @@
   ],
   "files": [
     "base.json",
-    "nextjs.json",
     "library.json",
+    "nextjs.json",
     "react-library.json",
-    "service.json"
+    "service.json",
+    "single-library.json",
+    "single-react-library.json"
   ],
   "devDependencies": {
-    "eslint": "^8.57.0"
+    "eslint": "^8.57.0",
+    "prettier": "^3.3.3",
+    "prettier-plugin-jsdoc": "^1.3.0"
   }
 }

package/react-library.json

@@ -5,8 +5,6 @@
   "compilerOptions": {
     "lib": ["dom", "dom.iterable", "es2023"],
     "jsx": "react-jsx",
-    /* If transpiling with TypeScript: */
-    "sourceMap": true,
 
     /* AND if you're building for a library: */
     "declaration": true,

package/single-library.json

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

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