@4mbl/tsconfig 0.0.0-beta.d1ebf2c → 0.0.0-beta.eaadc61

package/CHANGELOG.md

@@ -1,11 +1,26 @@
 # @4mbl/tsconfig Changelog
 
+## 4.1.2
+
+* Setup npm trusted publishing. No changes to the package itself.
+
+## 4.1.1
+
+* Fixed missing artifacts in the previous release.
+
+## 4.1.0
+
+* Add vite-react template.
+
+## 4.0.1
+
+* Move `baseUrl` definition from the base template to child templates to improve Next.js support.
+
 ## 4.0.0
 
 * Migrated from versioned templates to a single template per type. The package version is now used to determine the template version. This simplifies both the maintenance and usage of the package.
 * Enabled the following options in the base template:
   * `declarationMap`
-  * `composite`
   * `tsBuildInfoFile` set to `node_modules/.tmp/tsbuildinfo`
   * `verbatimModuleSyntax`
   * `allowSyntheticDefaultImports`

package/README.md

@@ -1,6 +1,17 @@
 # @4mbl/tsconfig
 
-> TypeScript configuration templates for various environments.
+> Strict TypeScript configuration for various environments.
+
+* [Usage](#usage)
+* [Available templates](#available-templates)
+  * [Base (tsconfig)](#base-tsconfig)
+  * [Node (tsconfig)](#node-tsconfig)
+  * [Browser (tsconfig)](#browser-tsconfig)
+  * [Next (tsconfig)](#next-tsconfig)
+  * [Vite React (app | node)](#vite-react-app--node)
+* [Versioning](#versioning)
+
+---
 
 ## Usage
 
@@ -15,29 +26,78 @@ Create a `tsconfig.json` file in the root of your project and extend the desired
 ```jsonc
 {
   "extends": "@4mbl/tsconfig/node"
-  /* your custom settings */
+  // your custom configuration...
 }
 ```
 
 ## Available templates
 
-There are currently four `tsconfig` templates.
+There are currently five `tsconfig` templates.
+
+### Base (<kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/base.json)</kbd>)
+
+This is the base `tsconfig` file that is used by the other templates. It contains common configuration for TypeScript with minimal environment specific configuration.
 
-### Base <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/base.json)</kbd>
+### Node (<kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/node.json)</kbd>)
 
-This is the base `tsconfig` file that is used by the other templates. It contains common configuration for TypeScript with minimal environment specific settings.
+Extends the base template with configuration specific to Node.js.
 
-### Node <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/node.json)</kbd>
+### Browser (<kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/browser.json)</kbd>)
 
-Extends the base template with settings specific to Node.js.
+Extends the base template with configuration specific to browser and React applications.
 
-### Browser <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/browser.json)</kbd>
+### Next (<kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/next.json)</kbd>)
 
-Extends the base template with settings specific to browser and React applications.
+Extends the base template with configuration from the Next.js app template.
 
-### Next <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/next.json)</kbd>
+[Next.js does not yet support tsconfig template variables](https://github.com/vercel/next.js/issues/70912), so you need to override the paths manually on the `tsconfig.json` file of your project.
 
-Extends the base template with settings from the Next.js app template.
+```jsonc
+{
+  "extends": "@4mbl/tsconfig/next",
+  "compilerOptions": {
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}
+```
+
+### Vite React (<kbd>[app](https://unpkg.com/@4mbl/tsconfig@latest/vite-react/app.json)</kbd> | <kbd>[node](https://unpkg.com/@4mbl/tsconfig@latest/vite-react/node.json)</kbd>)
+
+Extends the base template with configuration from Vite's `react-ts` preset.
+
+Vite uses seperate `tsconfig` files for the application and the node environment. So you need to have three files in total:
+
+**`tsconfig.json`**
+
+```jsonc
+{
+  "files": [],
+  "references": [
+    { "path": "./tsconfig.app.json" },
+    { "path": "./tsconfig.node.json" }
+  ]
+}
+```
+
+**`tsconfig.app.json`**
+
+```jsonc
+{
+  "extends": "@4mbl/tsconfig/vite-react/app"
+}
+```
+
+**`tsconfig.node.json`**
+
+```jsonc
+{
+  "extends": "@4mbl/tsconfig/vite-react/node"
+}
+```
 
 ## Versioning
 
@@ -46,5 +106,5 @@ As of version 4.0.0, the package migrated to a single template per type. The pac
 The package follows the following versioning scheme: `X.Y.Z`
 
 * `X` - Breaking changes to the base template.
-* `Y` - Breaking changes to individual, non-base templates.
+* `Y` - Breaking changes to individual, non-base templates. New templates may be introduced.
 * `Z` - Minor fixes to any template.

package/base.json

@@ -1,7 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "display": "Base",
-  "_version": "3.0.0",
   "compilerOptions": {
     /* Base Options */
     "lib": ["ESNext"],
@@ -9,7 +8,6 @@
     "skipLibCheck": true,
     "resolveJsonModule": true,
     "moduleDetection": "force",
-    "baseUrl": "${configDir}/src",
     "paths": {
       "@/*": ["${configDir}/src/*"]
     },
@@ -19,7 +17,6 @@
     "outDir": "${configDir}/dist",
     "sourceMap": true,
     "declarationMap": true,
-    "composite": true,
     "declaration": true,
     "incremental": true,
     "isolatedModules": true,

package/browser.json

@@ -1,13 +1,13 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "display": "Browser",
-  "_version": "3.0.0",
-  "extends": "../base/3.0.0.json",
+  "extends": "./base.json",
   "compilerOptions": {
     "lib": ["DOM", "DOM.Iterable", "ESNext"],
     "jsx": "react-jsx",
     "module": "ESNext",
     "moduleResolution": "Bundler",
+    "baseUrl": "${configDir}/src",
     "noEmit": true,
     "sourceMap": true
   }

package/next.json

@@ -1,8 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "display": "Next.js",
-  "_version": "3.0.0",
-  "extends": "../base/3.0.0.json",
+  "extends": "./base.json",
   "compilerOptions": {
     "target": "ES2017",
     "lib": ["dom", "dom.iterable", "esnext"],
@@ -24,9 +23,7 @@
     ],
     "paths": {
       "@/*": ["${configDir}/src/*"]
-    },
-    "rootDir": "${configDir}/src",
-    "baseUrl": "${configDir}"
+    }
   },
   "include": [
     "${configDir}/next-env.d.ts",

package/node.json

@@ -1,11 +1,11 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "display": "Node",
-  "_version": "3.0.0",
-  "extends": "../base/3.0.0.json",
+  "extends": "./base.json",
   "compilerOptions": {
     "target": "ESNext",
     "moduleResolution": "NodeNext",
-    "module": "NodeNext"
+    "module": "NodeNext",
+    "baseUrl": "${configDir}/src"
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@4mbl/tsconfig",
-  "version": "0.0.0-beta.d1ebf2c",
-  "description": "TypeScript configuration templates for various environments.",
+  "version": "0.0.0-beta.eaadc61",
+  "description": "Strict TypeScript configuration for various environments.",
   "type": "module",
   "author": "4mbl",
   "license": "MIT",
@@ -15,7 +15,7 @@
     "tsconfig"
   ],
   "scripts": {
-    "build": "cp templates/*.json ."
+    "build": "cp -r templates/* ."
   },
   "peerDependencies": {
     "typescript": ">=5.8.0"

package/vite-react/app.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Vite React (App)",
+  "extends": "../base.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "${configDir}/node_modules/.tmp/tsconfig.app.tsbuildinfo",
+    "target": "ES2022",
+    "useDefineForClassFields": true,
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    /* Linting */
+    "noUncheckedSideEffectImports": true
+  },
+  "include": ["${configDir}/src"]
+}

package/vite-react/node.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Vite React (Node)",
+  "extends": "../base.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "${configDir}/node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "target": "ES2023",
+    "lib": ["ES2023"],
+    "module": "ESNext",
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "noEmit": true,
+
+    /* Linting */
+    "noUncheckedSideEffectImports": true
+  },
+  "include": ["${configDir}/vite.config.ts"]
+}