@4mbl/tsconfig 1.0.0

package/README.md

@@ -0,0 +1,78 @@
+# @4mbl/tsconfig
+
+> Templates for `tsconfig` files 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/latest"
+  /* your custom settings */
+}
+```
+
+To avoid path related problems, you should override the following settings in your project's `tsconfig` file.
+
+```jsonc
+{
+  "extends": "@4mbl/tsconfig/node/latest",
+  "include": ["src/**/*"],
+  "exclude": ["node_modules"],
+  "compilerOptions": {
+    "rootDir": "src",
+    "paths": {
+      "@/*": ["*"]
+    }
+  }
+
+  /* your custom settings */
+}
+```
+
+## Available templates
+
+There are currently three `tsconfig` templates.
+
+### Base <kbd>[tsconfig](./base/latest.json) | [changelog](./base/CHANGELOG.md)</kbd>
+
+This is the base `tsconfig` file that is used by the other `tsconfig` files. It contains the basic configuration for TypeScript without any environment specific settings.
+
+### Node <kbd>[tsconfig](./node/latest.json) | [changelog](./node/CHANGELOG.md)</kbd>
+
+Extends the base `tsconfig` file and adds settings specific to Node.js.
+
+### Browser <kbd>[tsconfig](./browser/latest.json) | [changelog](./browser/CHANGELOG.md)</kbd>
+
+Extends the base `tsconfig` file and adds settings specific to browser and React applications.
+
+## 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 updating the `extends` field in your project's `tsconfig` file.
+
+### Package versioning
+
+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.
+
+If you are using a specific version of the template in your project's `tsconfig` file, you can update the package without worrying about any breaking changes to your project.
+
+### Template versioning
+
+Each template is versioned separately. The versioning scheme is: `major.minor.patch`
+
+* `major` - Major overhaul of the template. Rarely used.
+* `minor` - Breaking changes to the template.
+* `patch` - Non-breaking changes to the template.
+
+Each template also has a `latest` version. However, it is not recommended to use the `latest` version in your project's `tsconfig` file as it may introduce breaking changes when the package is updated.

package/base/1.0.0.json

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

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

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

package/browser/latest.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Browser",
+  "_version": "0.0.1",
+  "extends": "../base/0.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/node/1.0.0.json

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

package/node/latest.json

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

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@4mbl/tsconfig",
+  "version": "1.0.0",
+  "description": "tsconfig templates for typescript projects",
+  "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": "node ./scripts/copyLatest.js *",
+    "get:version": "node -pe \"require('./package.json')['version']\" > version.txt",
+    "release": "npm run get:version && npm run build && npm publish && git add . && git commit --file version.txt && git push && rm version.txt",
+    "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"
+  }
+}