@4mbl/tsconfig 0.0.0-beta.fd64d39

package/CHANGELOG.md

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

package/README.md

@@ -0,0 +1,50 @@
+# @4mbl/tsconfig
+
+> TypeScript configuration templates for various environments.
+
+## 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 settings */
+}
+```
+
+## Available templates
+
+There are currently four `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 settings.
+
+### Node <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/node.json)</kbd>
+
+Extends the base template with settings specific to Node.js.
+
+### Browser <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/browser.json)</kbd>
+
+Extends the base template with settings specific to browser and React applications.
+
+### Next <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/next.json)</kbd>
+
+Extends the base template with settings from the Next.js app template.
+
+## 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.
+* `Z` - Minor fixes to any template.

package/base.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Base",
+  "_version": "3.0.0",
+  "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

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

package/next.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Next.js",
+  "_version": "3.0.0",
+  "extends": "../base/3.0.0.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

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

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@4mbl/tsconfig",
+  "version": "0.0.0-beta.fd64d39",
+  "description": "TypeScript configuration templates for various environments.",
+  "type": "module",
+  "author": "4mbl",
+  "license": "MIT",
+  "homepage": "https://github.com/4mbl/tsconfig#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/4mbl/tsconfig.git"
+  },
+  "keywords": [
+    "typescript",
+    "tsconfig"
+  ],
+  "scripts": {
+    "build": "cp templates/*.json ."
+  },
+  "peerDependencies": {
+    "typescript": ">=5.8.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  }
+}