@4mbl/tsconfig 5.0.0-beta.0 → 5.0.0-beta.2

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @4mbl/tsconfig Changelog
 
+## 5.0.0-beta.2
+
+### Major Changes
+
+- f95bc32: [base] Enable noPropertyAccessFromIndexSignature
+- f95bc32: [base] Disable allowUnreachableCode
+- f95bc32: [base] Enable exactOptionalPropertyTypes
+
+### Minor Changes
+
+- fe250ba: Add template for Bun.
+
+## 5.0.0-beta.1
+
+### Minor Changes
+
+- 1bd158c: [next] Include framework generated files in rootDir scope
+
 ## 5.0.0-beta.0
 
 ### Major Changes

package/README.md

@@ -2,15 +2,16 @@
 
 > Strict TypeScript configuration for various environments.
 
-* [Usage](#usage)
-* [Available templates](#available-templates)
-  * [Base (tsconfig)](#base-tsconfig)
-  * [Node (tsconfig)](#node-tsconfig)
-  * [Node-TS (tsconfig)](#node-ts-tsconfig)
-  * [Browser (tsconfig)](#browser-tsconfig)
-  * [Next (tsconfig)](#next-tsconfig)
-  * [Vite React (app | node)](#vite-react-app--node)
-* [Versioning](#versioning)
+- [Usage](#usage)
+- [Available templates](#available-templates)
+  - [Base (tsconfig)](#base-tsconfig)
+  - [Node (tsconfig)](#node-tsconfig)
+  - [Node-TS (tsconfig)](#node-ts-tsconfig)
+  - [Bun (tsconfig)](#bun-tsconfig)
+  - [Browser (tsconfig)](#browser-tsconfig)
+  - [Next (tsconfig)](#next-tsconfig)
+  - [Vite React (app | node)](#vite-react-app--node)
+- [Versioning](#versioning)
 
 ---
 
@@ -22,11 +23,21 @@ Install the [`@4mbl/tsconfig`](https://www.npmjs.com/package/@4mbl/tsconfig) npm
 npm install -D @4mbl/tsconfig
 ```
 
+Install the type definitions required by your environment:
+
+```shell
+# When using /node, /node-ts, /next, or /vite-react/node template
+npm install -D @types/node
+
+# When using /bun template
+bun add -D @types/bun
+```
+
 Create a `tsconfig.json` file in the root of your project and extend the desired `tsconfig` template.
 
 ```jsonc
 {
-  "extends": "@4mbl/tsconfig/node"
+  "extends": "@4mbl/tsconfig/node",
   // your custom configuration...
 }
 ```
@@ -47,6 +58,10 @@ Extends the base template with configuration specific to Node.js.
 
 Extends the node template with configuration for TypeScript-only projects.
 
+### Bun (<kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/bun.json)</kbd>)
+
+Extends the base template with configuration specific to Bun.
+
 ### Browser (<kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/browser.json)</kbd>)
 
 Extends the base template with configuration specific to browser and React applications.
@@ -62,11 +77,11 @@ Extends the base template with configuration from the Next.js app template.
   "extends": "@4mbl/tsconfig/next",
   "compilerOptions": {
     "paths": {
-      "@/*": ["./src/*"]
-    }
+      "@/*": ["./src/*"],
+    },
   },
   "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules"],
 }
 ```
 
@@ -83,8 +98,8 @@ Vite uses seperate `tsconfig` files for the application and the node environment
   "files": [],
   "references": [
     { "path": "./tsconfig.app.json" },
-    { "path": "./tsconfig.node.json" }
-  ]
+    { "path": "./tsconfig.node.json" },
+  ],
 }
 ```
 
@@ -92,7 +107,7 @@ Vite uses seperate `tsconfig` files for the application and the node environment
 
 ```jsonc
 {
-  "extends": "@4mbl/tsconfig/vite-react/app"
+  "extends": "@4mbl/tsconfig/vite-react/app",
 }
 ```
 
@@ -100,7 +115,7 @@ Vite uses seperate `tsconfig` files for the application and the node environment
 
 ```jsonc
 {
-  "extends": "@4mbl/tsconfig/vite-react/node"
+  "extends": "@4mbl/tsconfig/vite-react/node",
 }
 ```
 

package/dist/base.json

@@ -32,16 +32,19 @@
     "strict": true,
     "checkJs": true,
     "erasableSyntaxOnly": true,
-    "forceConsistentCasingInFileNames": true,
     "allowSyntheticDefaultImports": true,
+    "allowUnreachableCode": false,
+    "exactOptionalPropertyTypes": true,
+    "forceConsistentCasingInFileNames": true,
     "noFallthroughCasesInSwitch": true,
     "noImplicitAny": true,
     "noImplicitOverride": true,
     "noImplicitReturns": false,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
+    "noPropertyAccessFromIndexSignature": true,
     "noUncheckedIndexedAccess": true,
-    "noUncheckedSideEffectImports": true
+    "noUncheckedSideEffectImports": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true
   },
   "include": ["${configDir}/src/**/*"],
   "exclude": ["${configDir}/node_modules"]

package/dist/bun.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Bun",
+  "extends": "./base.json",
+  "compilerOptions": {
+    "moduleResolution": "bundler",
+    "module": "preserve",
+    "paths": { "*": ["${configDir}/src/*"] },
+    "types": ["bun"],
+
+    "noEmit": true,
+    "allowImportingTsExtensions": true
+  }
+}

package/dist/next.json

@@ -3,6 +3,7 @@
   "display": "Next.js",
   "extends": "./base.json",
   "compilerOptions": {
+    "rootDir": "${configDir}",
     "lib": ["esnext", "dom"],
     "allowJs": true,
     "skipLibCheck": true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4mbl/tsconfig",
-  "version": "5.0.0-beta.0",
+  "version": "5.0.0-beta.2",
   "description": "Strict TypeScript configuration for various environments.",
   "type": "module",
   "author": "4mbl",
@@ -8,6 +8,7 @@
   "homepage": "https://github.com/4mbl/config/tree/main/packages/tsconfig#readme",
   "exports": {
     "./browser": "./dist/browser.json",
+    "./bun": "./dist/bun.json",
     "./next": "./dist/next.json",
     "./node-ts": "./dist/node-ts.json",
     "./node": "./dist/node.json",