@4mbl/tsconfig 0.0.0-alpha.9b8878c

package/CHANGELOG.md

@@ -0,0 +1,65 @@
+# @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

@@ -0,0 +1,115 @@
+# @4mbl/tsconfig
+
+> 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
+
+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
+
+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.
+
+### 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/dist/base.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Base",
+  "compilerOptions": {
+    /* Base Options */
+    "lib": ["ESNext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "moduleDetection": "force",
+    "paths": {
+      "@/*": ["${configDir}/src/*"]
+    },
+
+    /* Output */
+    "target": "ES6",
+    "outDir": "${configDir}/dist",
+    "sourceMap": true,
+    "declarationMap": 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/dist/browser.json

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

package/dist/next.json

@@ -0,0 +1,35 @@
+{
+  "$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/*"]
+    }
+  },
+  "include": [
+    "${configDir}/next-env.d.ts",
+    "${configDir}/**/*.ts",
+    "${configDir}/**/*.tsx",
+    "${configDir}/.next/types/**/*.ts"
+  ],
+  "exclude": ["${configDir}/node_modules"]
+}

package/dist/node-ts.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Node (TS)",
+  "extends": "./base.json",
+  "compilerOptions": {
+    // same options as node template
+    "target": "ESNext",
+    "moduleResolution": "NodeNext",
+    "module": "NodeNext",
+    "paths": { "*": ["${configDir}/src/*"] },
+
+    // options for typescript-only
+    // https://nodejs.org/api/typescript.html#type-stripping
+    "noEmit": true,
+    "allowImportingTsExtensions": true,
+    "rewriteRelativeImportExtensions": true
+  }
+}

package/dist/node.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Node",
+  "extends": "./base.json",
+  "compilerOptions": {
+    "target": "ESNext",
+    "moduleResolution": "NodeNext",
+    "module": "NodeNext",
+    "paths": { "*": ["${configDir}/src/*"] }
+  }
+}

package/dist/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/dist/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"]
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@4mbl/tsconfig",
+  "version": "0.0.0-alpha.9b8878c",
+  "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-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/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"
+  }
+}