@btravstack/tsconfig 0.1.0 → 0.3.0

package/README.md

@@ -17,7 +17,38 @@ pnpm add -D @btravstack/tsconfig
 
 `base.json` enables `strict`, `exactOptionalPropertyTypes`,
 `noUncheckedIndexedAccess`, `noPropertyAccessFromIndexSignature`,
-`noImplicitOverride`, `noImplicitReturns`, and friends, on `NodeNext` /
-`ES2022`. Override anything in your own `compilerOptions`.
+`noImplicitOverride`, `noImplicitReturns`, `verbatimModuleSyntax`,
+`moduleDetection: "force"`, and friends, on `NodeNext` / `ES2022`. Override
+anything in your own `compilerOptions`.
+
+## `app.json`, for a package that emits no declarations
+
+An application — a deployment, an example, a test workspace — extends
+`app.json` instead, which is `base.json` with `declaration` and
+`declarationMap` off:
+
+```jsonc
+// tsconfig.json
+{
+  "extends": "@btravstack/tsconfig/app.json",
+  "compilerOptions": { "noEmit": true },
+  "include": ["src/**/*"],
+}
+```
+
+The flag is not free when nothing consumes the declarations it type-checks:
+declaration emit is checked even under `noEmit`, so an exported value whose
+type reaches a library's unexported brand symbols reports `TS4023` — **before**
+the error the developer actually made. Measured on a DI composition root with
+one unmet dependency: two `TS4023` lines about internal `ID` / `SERVICE`
+symbols came first, and the sentence naming the missing port came third. With
+`app.json` the actionable diagnostic is the only one.
+
+A library keeps `base.json`: there the declaration check is the guarantee that
+its consumers can build.
+
+It does **not** set `types` — TypeScript auto-includes every reachable
+`@types/*` package (Node included). This avoids forcing each consuming package to
+declare a direct `@types/node` just to satisfy a `types: ["node"]` list.
 
 MIT © Benoit Travers

package/app.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./base.json",
+  "compilerOptions": {
+    "declaration": false,
+    "declarationMap": false
+  }
+}

package/base.json

@@ -6,7 +6,7 @@
 
     "target": "ES2022",
     "lib": ["ES2023"],
-    "types": ["node"],
+    "moduleDetection": "force",
 
     "resolveJsonModule": true,
     "allowJs": true,
@@ -17,6 +17,7 @@
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "isolatedModules": true,
+    "verbatimModuleSyntax": true,
     "skipLibCheck": true,
     "strict": true,
     "noUnusedLocals": true,

package/package.json

@@ -1,28 +1,30 @@
 {
   "name": "@btravstack/tsconfig",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Shared strict TypeScript configuration for btravstack packages",
   "keywords": [
     "config",
     "tsconfig",
     "typescript"
   ],
-  "homepage": "https://github.com/btravstack/config/tree/main/packages/tsconfig#readme",
+  "homepage": "https://github.com/btravstack/tools/tree/main/packages/tsconfig#readme",
   "bugs": {
-    "url": "https://github.com/btravstack/config/issues"
+    "url": "https://github.com/btravstack/tools/issues"
   },
   "license": "MIT",
   "author": "Benoit TRAVERS <benoit.travers.fr@gmail.com>",
   "repository": {
     "type": "git",
-    "url": "https://github.com/btravstack/config.git",
+    "url": "https://github.com/btravstack/tools.git",
     "directory": "packages/tsconfig"
   },
   "files": [
+    "app.json",
     "base.json"
   ],
   "type": "module",
   "exports": {
+    "./app.json": "./app.json",
     "./base.json": "./base.json"
   },
   "publishConfig": {