@4mbl/tsconfig 3.0.0 → 4.0.0

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# @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`
+  * `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

@@ -14,7 +14,7 @@ Create a `tsconfig.json` file in the root of your project and extend the desired
 
 ```jsonc
 {
-  "extends": "@4mbl/tsconfig/node/latest"
+  "extends": "@4mbl/tsconfig/node"
   /* your custom settings */
 }
 ```
@@ -23,42 +23,45 @@ Create a `tsconfig.json` file in the root of your project and extend the desired
 
 There are currently four `tsconfig` templates.
 
-### Base <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/base/latest.json) | [changelog](./base/changelog.md)</kbd>
+### 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 the basic configuration for TypeScript without any environment specific settings.
+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/latest.json) | [changelog](./node/changelog.md)</kbd>
+### Node <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/node.json)</kbd>
 
-Extends the base template and adds settings specific to Node.js.
+Extends the base template with settings specific to Node.js.
 
-### Browser <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/browser/latest.json) | [changelog](./browser/changelog.md)</kbd>
+### Browser <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/browser.json)</kbd>
 
-Extends the base template and adds settings specific to browser and React applications.
+Extends the base template with settings specific to browser and React applications.
 
-### Next.js <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/next/latest.json) | [changelog](./next/changelog.md)</kbd>
+### Next <kbd>[tsconfig](https://unpkg.com/@4mbl/tsconfig@latest/next.json)</kbd>
 
-Extends the base template and with settings from the Next.js app template.
+Extends the base template with settings from the Next.js app template.
 
-## Versioning
-
-The package and each template are versioned separately. Seperate versioning allows you to update the package without worrying about breaking changes to the templates. It also allows you to easily test newer versions of the templates by just changing the `extends` field in the `tsconfig` file of your project.
-
-### Package versioning
+[Next.js does not yet support tsconfig template variables](https://github.com/vercel/next.js/issues/70912), so you need to configure the path settings manually on the `tsconfig.json` file of your project.
 
-The package itself follows the following versioning scheme: `major.minor.patch`
-
-* `major` - Base template is changed and older template versions may be removed.
-* `minor` - Non-base template is changed or added.
-* `patch` - Non-breaking changes to the templates.
+```jsonc
+{
+  "extends": "@4mbl/tsconfig/next",
+  "compilerOptions": {
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}
+```
 
-If you are extending a specific version of a template in your project, you can update the package without worrying about any breaking changes to your project.
+The Next.js template should work without extra configuration as soon as Next.js supports tsconfig template variables. Until then, you need to set the paths settings manually.
 
-### Template versioning
+## Versioning
 
-Each template is versioned separately. The versioning scheme is: `major.minor.patch`
+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.
 
-* `major` - Major overhaul of the template. Major changes to upstream templates warrant a major version on the inheriting templates.
-* `minor` - Breaking changes to the template.
-* `patch` - Non-breaking changes to the template.
+The package follows the following versioning scheme: `X.Y.Z`
 
-Each template also has a `latest` version. However, it is not recommended to extend the `latest` version in your project as it may introduce breaking changes when the package is updated.
+* `X` - Breaking changes to the base template.
+* `Y` - Breaking changes to individual, non-base templates.
+* `Z` - Minor fixes to any template.

package/{base/latest.json → base.json}

@@ -1,7 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "display": "Base",
-  "_version": "3.0.0",
   "compilerOptions": {
     /* Base Options */
     "lib": ["ESNext"],
@@ -9,8 +8,7 @@
     "skipLibCheck": true,
     "resolveJsonModule": true,
     "moduleDetection": "force",
-    "rootDir": "${configDir}/src",
-    "baseUrl": "${configDir}/",
+    "baseUrl": "${configDir}/src",
     "paths": {
       "@/*": ["${configDir}/src/*"]
     },
@@ -19,18 +17,23 @@
     "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,

package/{browser/1.0.0.json → browser.json}

@@ -1,15 +1,13 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "display": "Browser",
-  "_version": "1.0.0",
-  "extends": "../base/1.0.0.json",
-  "compilerOptions": {
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
-    "jsx": "react-jsx",
-    "tsBuildInfoFile": "tsconfig.browser.tsbuildinfo",
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "noEmit": true,
-    "sourceMap": true
-  }
-}
+{
+  "$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/3.0.0.json → next.json}

@@ -1,9 +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"],
@@ -12,7 +10,7 @@
     "strict": true,
     "noEmit": true,
     "esModuleInterop": true,
-    "module": "esnext",
+    "module": "preserve",
     "moduleResolution": "bundler",
     "resolveJsonModule": true,
     "isolatedModules": true,
@@ -24,9 +22,14 @@
       }
     ],
     "paths": {
-      "@/*": ["./src/*"]
+      "@/*": ["${configDir}/src/*"]
     }
   },
-  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
-  "exclude": ["node_modules"]
+  "include": [
+    "${configDir}/next-env.d.ts",
+    "${configDir}/**/*.ts",
+    "${configDir}/**/*.tsx",
+    "${configDir}/.next/types/**/*.ts"
+  ],
+  "exclude": ["${configDir}/node_modules"]
 }

package/{node/1.0.0.json → node.json}

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4mbl/tsconfig",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "TypeScript configuration templates for various environments.",
   "type": "module",
   "author": "4mbl",
@@ -15,14 +15,7 @@
     "tsconfig"
   ],
   "scripts": {
-    "build": "node ./scripts/copyLatest.js '*'",
-    "delete:latest": "node ./scripts/deleteLatestJson.js",
-    "delete:version": "node ./scripts/deleteVersionFile.js",
-    "get:version": "node -pe \"require('./package.json')['version']\" > version.txt",
-    "release": "npm run get:version && npm run build && npm publish && npm run delete:latest && git add . && git commit --file version.txt && git push && npm run delete:version",
-    "release:patch": "npm version patch --no-git-tag-version && npm run release",
-    "release:minor": "npm version minor --no-git-tag-version && npm run release",
-    "release:major": "npm version major --no-git-tag-version && npm run release"
+    "build": "cp templates/*.json ."
   },
   "peerDependencies": {
     "typescript": ">=5.8.0"

package/base/1.0.0.json

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

package/base/2.0.0.json

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

package/base/2.0.1.json

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

package/base/3.0.0.json

@@ -1,41 +0,0 @@
-{
-  "$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",
-    "rootDir": "${configDir}/src",
-    "baseUrl": "${configDir}/",
-    "paths": {
-      "@/*": ["${configDir}/src/*"]
-    },
-
-    /* Output */
-    "target": "ES6",
-    "outDir": "${configDir}/dist",
-    "sourceMap": true,
-    "declaration": true,
-    "incremental": true,
-    "isolatedModules": true,
-    "esModuleInterop": true,
-
-    /* Linting */
-    "strict": true,
-    "checkJs": true,
-    "erasableSyntaxOnly": true,
-    "forceConsistentCasingInFileNames": true,
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitAny": true,
-    "noImplicitReturns": false,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noUncheckedIndexedAccess": true
-  },
-  "include": ["${configDir}/src/**/*"],
-  "exclude": ["${configDir}/node_modules"]
-}

package/browser/2.0.0.json

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

package/browser/2.0.1.json

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

package/browser/3.0.0.json

@@ -1,15 +0,0 @@
-{
-  "$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",
-    "tsBuildInfoFile": "tsconfig.browser.tsbuildinfo",
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "noEmit": true,
-    "sourceMap": true
-  }
-}

package/browser/latest.json

@@ -1,15 +0,0 @@
-{
-  "$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",
-    "tsBuildInfoFile": "tsconfig.browser.tsbuildinfo",
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "noEmit": true,
-    "sourceMap": true
-  }
-}

package/next/latest.json

@@ -1,32 +0,0 @@
-{
-  "$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": "esnext",
-    "moduleResolution": "bundler",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "jsx": "preserve",
-    "incremental": true,
-    "plugins": [
-      {
-        "name": "next"
-      }
-    ],
-    "paths": {
-      "@/*": ["./src/*"]
-    }
-  },
-  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
-  "exclude": ["node_modules"]
-}

package/node/2.0.0.json

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

package/node/2.0.1.json

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

package/node/3.0.0.json

@@ -1,11 +0,0 @@
-{
-  "$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/node/latest.json

@@ -1,11 +0,0 @@
-{
-  "$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"
-  }
-}