@4mbl/tsconfig 0.0.0-beta.1ef7e27 → 0.0.0-beta.2891e8a

package/CHANGELOG.md

@@ -1,26 +1,65 @@
-# @4mbl/tsconfig Changelog
-
-## 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`
-  * `noImplicitOverride`
-* In the Next.js all paths now use paths relative to the project.
-* Removed `tsBuildInfoFile` from browser template in favor of the base template value.
-
-## 3.0.0
-
-* Enabled `erasableSyntaxOnly` option in the base template. Requires TypeScript 5.8.0+.
-
-## 2.0.0
-
-* Changed path options to use `${configDir}` instead of relative paths in base template. Requires TypeScript 5.5.0+.
-
-## 1.0.0
-
-* Initial release
+# @4mbl/tsconfig Changelog
+
+## 4.4.0
+
+### Minor Changes
+
+- 05ab9ba: [browser,node,node-ts] Replace `baseUrl` with `paths` catch-all to improve TypeScript 7 support.
+
+## 4.3.0
+
+### Minor Changes
+
+- ce274df: node-ts: add rewriteRelativeImportExtensions
+
+## 4.2.0
+
+### Minor Changes
+
+- 090f642: Add node-ts template.
+
+## 4.1.3
+
+### Patch Changes
+
+- 0957212: Migrate to monorepo setup internally. No changes to the package itself.
+
+## 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`
+  - `tsBuildInfoFile` set to `node_modules/.tmp/tsbuildinfo`
+  - `verbatimModuleSyntax`
+  - `allowSyntheticDefaultImports`
+  - `noImplicitOverride`
+- In the Next.js all paths now use paths relative to the project.
+- Removed `tsBuildInfoFile` from browser template in favor of the base template value.
+
+## 3.0.0
+
+- Enabled `erasableSyntaxOnly` option in the base template. Requires TypeScript 5.8.0+.
+
+## 2.0.0
+
+- Changed path options to use `${configDir}` instead of relative paths in base template. Requires TypeScript 5.5.0+.
+
+## 1.0.0
+
+- Initial release

package/README.md

@@ -1,6 +1,18 @@
 # @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)
+  * [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
 
@@ -15,29 +27,82 @@ 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.
+These are the currently available `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.
+
+### Node (<kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/node.json)</kbd>)
+
+Extends the base template with configuration specific to Node.js.
+
+### Node-TS (<kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/node-ts.json)</kbd>)
+
+Extends the node template with configuration for TypeScript-only projects.
 
-### Base <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/base.json)</kbd>
+### Browser (<kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/browser.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 browser and React applications.
 
-### Node <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/node.json)</kbd>
+### Next (<kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/next.json)</kbd>)
 
-Extends the base template with settings specific to Node.js.
+Extends the base template with configuration from the Next.js app template.
 
-### Browser <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/browser.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 specific to browser and React applications.
+```jsonc
+{
+  "extends": "@4mbl/tsconfig/next",
+  "compilerOptions": {
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}
+```
 
-### Next <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/next.json)</kbd>
+### 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 settings from the Next.js app template.
+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
 
@@ -45,6 +110,6 @@ 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.
-* `Z` - Minor fixes to any template.
+- `X` - Breaking changes to the base template.
+- `Y` - Breaking changes to individual, non-base templates. New templates may be introduced.
+- `Z` - Minor fixes to any template.

package/package.json

@@ -1,22 +1,34 @@
 {
   "name": "@4mbl/tsconfig",
-  "version": "0.0.0-beta.1ef7e27",
-  "description": "TypeScript configuration templates for various environments.",
+  "version": "0.0.0-beta.2891e8a",
+  "description": "Strict TypeScript configuration for various environments.",
   "type": "module",
   "author": "4mbl",
   "license": "MIT",
-  "homepage": "https://github.com/4mbl/tsconfig#readme",
+  "homepage": "https://github.com/4mbl/config/tree/main/packages/tsconfig#readme",
+  "exports": {
+    "./browser": "./dist/browser.json",
+    "./next": "./dist/next.json",
+    "./node-ts": "./dist/node-ts.json",
+    "./node": "./dist/node.json",
+    "./vite-react/app": "./dist/vite-react/app.json",
+    "./vite-react/node": "./dist/vite-react/node.json"
+  },
+  "files": [
+    "dist",
+    "package.json",
+    "README.md",
+    "CHANGELOG.md"
+  ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/4mbl/tsconfig.git"
+    "url": "git+https://github.com/4mbl/config.git",
+    "directory": "packages/tsconfig"
   },
   "keywords": [
     "typescript",
     "tsconfig"
   ],
-  "scripts": {
-    "build": "cp templates/*.json ."
-  },
   "peerDependencies": {
     "typescript": ">=5.8.0"
   },
@@ -24,5 +36,8 @@
     "typescript": {
       "optional": true
     }
+  },
+  "scripts": {
+    "build": "rm -rf dist && mkdir dist && cp -r templates/* dist/ && node scripts/generate-exports.mjs"
   }
-}
+}

package/base.json

@@ -1,45 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "display": "Base",
-  "compilerOptions": {
-    /* Base Options */
-    "lib": ["ESNext"],
-    "allowJs": true,
-    "skipLibCheck": true,
-    "resolveJsonModule": true,
-    "moduleDetection": "force",
-    "baseUrl": "${configDir}/src",
-    "paths": {
-      "@/*": ["${configDir}/src/*"]
-    },
-
-    /* Output */
-    "target": "ES6",
-    "outDir": "${configDir}/dist",
-    "sourceMap": true,
-    "declarationMap": true,
-    "composite": true,
-    "declaration": true,
-    "incremental": true,
-    "isolatedModules": true,
-    "esModuleInterop": true,
-    "tsBuildInfoFile": "${configDir}/node_modules/.tmp/tsconfig.tsbuildinfo",
-    "verbatimModuleSyntax": true,
-
-    /* Linting */
-    "strict": true,
-    "checkJs": true,
-    "erasableSyntaxOnly": true,
-    "forceConsistentCasingInFileNames": true,
-    "allowSyntheticDefaultImports": true,
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitAny": true,
-    "noImplicitOverride": true,
-    "noImplicitReturns": false,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noUncheckedIndexedAccess": true
-  },
-  "include": ["${configDir}/src/**/*"],
-  "exclude": ["${configDir}/node_modules"]
-}

package/browser.json

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

package/next.json

@@ -1,37 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "display": "Next.js",
-  "extends": "./base.json",
-  "compilerOptions": {
-    "target": "ES2017",
-    "lib": ["dom", "dom.iterable", "esnext"],
-    "allowJs": true,
-    "skipLibCheck": true,
-    "strict": true,
-    "noEmit": true,
-    "esModuleInterop": true,
-    "module": "preserve",
-    "moduleResolution": "bundler",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "jsx": "preserve",
-    "incremental": true,
-    "plugins": [
-      {
-        "name": "next"
-      }
-    ],
-    "paths": {
-      "@/*": ["${configDir}/src/*"]
-    },
-    "rootDir": "${configDir}/src",
-    "baseUrl": "${configDir}"
-  },
-  "include": [
-    "${configDir}/next-env.d.ts",
-    "${configDir}/**/*.ts",
-    "${configDir}/**/*.tsx",
-    "${configDir}/.next/types/**/*.ts"
-  ],
-  "exclude": ["${configDir}/node_modules"]
-}

package/node.json

@@ -1,10 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "display": "Node",
-  "extends": "./base.json",
-  "compilerOptions": {
-    "target": "ESNext",
-    "moduleResolution": "NodeNext",
-    "module": "NodeNext"
-  }
-}