@4mbl/tsconfig 0.0.0-beta.00cfefd

package/CHANGELOG.md

@@ -0,0 +1,47 @@
+# @4mbl/tsconfig Changelog
+
+## 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

@@ -0,0 +1,110 @@
+# @4mbl/tsconfig
+
+> 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
+
+Install the [`@4mbl/tsconfig`](https://www.npmjs.com/package/@4mbl/tsconfig) npm package.
+
+```shell
+npm install -D @4mbl/tsconfig
+```
+
+Create a `tsconfig.json` file in the root of your project and extend the desired `tsconfig` template.
+
+```jsonc
+{
+  "extends": "@4mbl/tsconfig/node"
+  // your custom configuration...
+}
+```
+
+## Available 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.
+
+### Node (<kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/node.json)</kbd>)
+
+Extends the base template with configuration specific to Node.js.
+
+### Browser (<kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/browser.json)</kbd>)
+
+Extends the base template with configuration specific to browser and React applications.
+
+### Next (<kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/next.json)</kbd>)
+
+Extends the base template with configuration from the Next.js app template.
+
+[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.
+
+```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
+
+As of version 4.0.0, the package migrated 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.
+
+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. New templates may be introduced.
+* `Z` - Minor fixes to any template.

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@4mbl/tsconfig",
+  "version": "0.0.0-beta.00cfefd",
+  "description": "Strict TypeScript configuration for various environments.",
+  "type": "module",
+  "author": "4mbl",
+  "license": "MIT",
+  "homepage": "https://github.com/4mbl/config/tree/main/packages/tsconfig#readme",
+  "exports": {
+    "./browser": "./dist/browser.json",
+    "./next": "./dist/next.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/config.git",
+    "directory": "packages/tsconfig"
+  },
+  "keywords": [
+    "typescript",
+    "tsconfig"
+  ],
+  "peerDependencies": {
+    "typescript": ">=5.8.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "rm -rf dist && mkdir dist && cp -r templates/* dist/ && node scripts/generate-exports.mjs"
+  }
+}