@temboplus/tsconfig 0.1.0

package/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) TemboPlus Inc. & Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,197 @@
+# temboplus-tsconfig
+
+<!-- start: badges -->
+
+[![pre-commit](https://github.com/TemboPlus-Inc/temboplus-tsconfig/actions/workflows/pre-commit.yaml/badge.svg)](https://github.com/TemboPlus-Inc/temboplus-tsconfig/actions/workflows/pre-commit.yaml)
+[![audit](https://github.com/TemboPlus-Inc/temboplus-tsconfig/actions/workflows/audit.yaml/badge.svg)](https://github.com/TemboPlus-Inc/temboplus-tsconfig/actions/workflows/audit.yaml)
+
+<!-- end: badges -->
+
+Base TypeScript configuration files for TemboPlus applications and packages
+
+## Requirements
+
+- [NodeJS v22.15.0+](https://nodejs.org)
+- [npm v10.9.2+](https://www.npmjs.com/)
+- [typescript v5.8.3+](https://www.typescriptlang.org)
+- [tslib v2.8.1+](https://github.com/microsoft/tslib), [For optimized bundles](https://www.typescriptlang.org/tsconfig/#importHelpers)
+
+## Installation
+
+```sh
+npm install --save-dev @temboplus/tsconfig
+npm install --save tslib
+```
+
+or
+
+```sh
+npm install --save-dev git@github.com:TemboPlus-Inc/temboplus-tsconfig.git
+npm install --save tslib
+```
+
+## Usage
+
+Extend the desired config in your `tsconfig.json` or project-specific config files.
+
+### Base Configuration (Runtime-agnostic)
+
+```jsonc
+// tsconfig.json or tsconfig.base.json
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": ["@temboplus/tsconfig/base.json"],
+  // overrides + other configurations
+}
+```
+
+### Build Configurations
+
+#### Base Build (Runtime-agnostic)
+
+```jsonc
+// tsconfig.build.json
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": ["@temboplus/tsconfig/build.json"],
+  // overrides + other configurations
+}
+```
+
+#### [CJS](https://nodejs.org/api/modules.html#modules-commonjs-modules) Build
+
+```jsonc
+// tsconfig.cjs.json
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": ["@temboplus/tsconfig/cjs.json"],
+  // overrides + other configurations
+}
+```
+
+#### [ESM](https://nodejs.org/api/esm.html#modules-ecmascript-modules) Build
+
+```jsonc
+// tsconfig.esm.json
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": ["@temboplus/tsconfig/esm.json"],
+  // overrides + other configurations
+}
+```
+
+#### [Type Declarations](https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html) Build
+
+```jsonc
+// tsconfig.types.json
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": ["@temboplus/tsconfig/types.json"],
+  // overrides + other configurations
+}
+```
+
+### Test Configurations
+
+#### Base Test (Runtime-agnostic)
+
+```jsonc
+// tsconfig.test.json
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": ["@temboplus/tsconfig/test.json"],
+  // overrides + other configurations
+}
+```
+
+#### [Jest](https://jestjs.io/docs/getting-started) ([ts-jest](https://kulshekhar.github.io/ts-jest/docs/getting-started/installation))
+
+```jsonc
+// tsconfig.test.json or tsconfig.jest.json
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": ["@temboplus/tsconfig/jest.json"],
+  // overrides + other configurations
+}
+```
+
+#### [Vitest](https://vitest.dev/guide/)
+
+```jsonc
+// tsconfig.test.json or tsconfig.vitest.json
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": ["@temboplus/tsconfig/vitest.json"],
+  // overrides + other configurations
+}
+```
+
+### [NestJS](https://nestjs.com) Configurations
+
+### Base Build (CommonJS & node10)
+
+```jsonc
+// tsconfig.json or tsconfig.nestjs.json
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": ["@temboplus/tsconfig/nestjs.json"],
+  // overrides + other configurations
+}
+```
+
+## Contribute
+
+We welcome contributions! Here's how to get started:
+
+### How to Contribute
+
+1. **Open an Issue**
+   Start by [opening an issue](https://github.com/TemboPlus-Inc/temboplus-tsconfig/issues) to discuss your proposed changes.
+
+2. **Clone the Repo**
+
+   ```sh
+   git clone git@github.com:TemboPlus-Inc/temboplus-tsconfig.git
+   cd temboplus-tsconfig
+   ```
+
+3. **Install dependencies**
+
+   ```sh
+   npm install
+   ```
+
+4. **Create a Feature Branch**
+
+   ```sh
+   git checkout -b feature/<your-feature-name> main
+   ```
+
+5. **Make Your Changes & Run Checks**
+
+   ```sh
+   npm run check
+   ```
+
+   For available scripts and automation workflows, see the [Tasks guide](https://github.com/TemboPlus-Inc/temboplus-tsconfig/blob/main/TASKS.md).
+
+6. **Commit Your Changes**
+
+   ```sh
+   git commit -m "feat(<scope>): <add new feature description>"
+   ```
+
+7. **Push & Submit a Pull Request**
+
+   ```sh
+   git push origin feature/<your-feature-name>
+   ```
+
+   Then, open a **Pull Request (PR)** to the **main branch**.
+
+### Contribution Guidelines
+
+- Follow **[Conventional Commits](https://www.conventionalcommits.org/)** (`feat`, `fix`, `chore`, etc.).
+- Write meaningful **commit messages**, **PR titles** and **code comments**.
+- Ensure the code passes **checks** before submitting.
+- Keep changes focused and well-scoped.

package/package.json

@@ -0,0 +1,218 @@
+{
+  "name": "@temboplus/tsconfig",
+  "version": "0.1.0",
+  "description": "Base TypeScript configuration files for TemboPlus applications and packages",
+  "files": [
+    "tsconfig.base.json",
+    "tsconfig.build.json",
+    "tsconfig.cjs.json",
+    "tsconfig.esm.json",
+    "tsconfig.jest.json",
+    "tsconfig.nestjs.json",
+    "tsconfig.test.json",
+    "tsconfig.types.json",
+    "tsconfig.vitest.json"
+  ],
+  "exports": {
+    "./base.json": "./tsconfig.base.json",
+    "./build.json": "./tsconfig.build.json",
+    "./cjs.json": "./tsconfig.cjs.json",
+    "./esm.json": "./tsconfig.esm.json",
+    "./jest.json": "./tsconfig.jest.json",
+    "./nestjs.json": "./tsconfig.jest.json",
+    "./test.json": "./tsconfig.test.json",
+    "./types.json": "./tsconfig.types.json",
+    "./vitest.json": "./tsconfig.vitest.json"
+  },
+  "scripts": {
+    "check": "npm-run-all format:check lint:check spell:check type:check",
+    "clean": "npm-run-all clean:*",
+    "clean:build": "rimraf dist",
+    "clean:docs": "rimraf docs",
+    "clean:test": "rimraf coverage",
+    "commit:lint": "npx commitlint --last --verbose",
+    "deps:check": "ncu",
+    "deps:fix": "ncu -u --install always",
+    "fix": "npm-run-all format:fix lint:fix",
+    "format:check": "npm-run-all format:check:*",
+    "format:check:js": "prettier --check \"./**/*.{js,mjs}\"",
+    "format:check:json": "prettier --check \"./**/*.json\"",
+    "format:check:md": "prettier --check \"./**/*.md\"",
+    "format:check:yaml": "prettier --check \"./**/*.{yaml,yml}\"",
+    "format:fix": "npm-run-all format:fix:*",
+    "format:fix:js": "prettier --write \"./**/*.{js,mjs}\"",
+    "format:fix:json": "prettier --write \"./**/*.json\"",
+    "format:fix:md": "prettier --write \"./**/*.md\"",
+    "format:fix:yaml": "prettier --write \"./**/*.{yaml,yml}\"",
+    "lint:check": "npm-run-all lint:check:*",
+    "lint:check:js": "eslint \"./**/*.{js,mjs}\"",
+    "lint:check:json": "eslint \"./**/*.json\"",
+    "lint:check:md": "eslint \"./**/*.md\"",
+    "lint:check:yaml": "eslint \"./**/*.{yaml,yml}\"",
+    "lint:fix": "npm-run-all lint:fix:*",
+    "lint:fix:js": "eslint --fix \"./**/*.{js,mjs}\"",
+    "lint:fix:json": "eslint --fix \"./**/*.json\"",
+    "lint:fix:md": "eslint --fix \"./**/*.md\"",
+    "lint:fix:yaml": "eslint --fix \"./**/*.{yaml,yml}\"",
+    "prepare": "husky",
+    "release:dry-run": "release-it --dry-run",
+    "release:version": "release-it --release-version",
+    "release": "release-it",
+    "security:check": "npm audit --audit-level=high",
+    "security:fix": "npm audit fix --audit-level=high",
+    "spell:check": "npm-run-all spell:check:*",
+    "spell:check:json": "cspell lint \"./**/*.json\"",
+    "spell:check:md": "cspell lint \"./**/*.md\"",
+    "test": "npm-run-all test:*",
+    "test:jest": "jest",
+    "test:vitest": "vitest run --coverage --exclude=**/jest.spec.ts --typecheck.enabled --typecheck.tsconfig=./tsconfig.vitest.json",
+    "type:check": "npm-run-all type:check:*",
+    "type:check:base": "tsc -p tsconfig.base.json --noEmit",
+    "type:check:build": "tsc -p tsconfig.build.json --noEmit",
+    "type:check:cjs": "tsc -p tsconfig.cjs.json --noEmit",
+    "type:check:esm": "tsc -p tsconfig.esm.json --noEmit",
+    "type:check:jest": "tsc -p tsconfig.jest.json --noEmit",
+    "type:check:nestjs": "tsc -p tsconfig.nestjs.json --noEmit",
+    "type:check:test": "tsc -p tsconfig.test.json --noEmit",
+    "type:check:types": "tsc -p tsconfig.types.json --noEmit",
+    "type:check:vitest": "tsc -p tsconfig.vitest.json --noEmit"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TemboPlus-Inc/temboplus-tsconfig.git"
+  },
+  "keywords": [
+    "tembo",
+    "temboplus",
+    "typescript",
+    "tsc",
+    "tsconfig",
+    "ts",
+    "config"
+  ],
+  "author": {
+    "name": "temboplus",
+    "email": "engineering@temboplus.com",
+    "url": "https://github.com/TemboPlus-Inc"
+  },
+  "contributors": [
+    {
+      "name": "lykmapipo",
+      "email": "lallyelias87@gmail.com",
+      "url": "https://github.com/lykmapipo"
+    }
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/TemboPlus-Inc/temboplus-tsconfig/issues",
+    "email": "engineering@temboplus.com"
+  },
+  "homepage": "https://github.com/TemboPlus-Inc/temboplus-tsconfig",
+  "engines": {
+    "node": ">=22.0.0",
+    "npm": ">=10.9.2"
+  },
+  "dependencies": {
+    "@tsconfig/node22": ">=22.0.2",
+    "@tsconfig/recommended": ">=1.0.8",
+    "@tsconfig/strictest": ">=2.0.5",
+    "tslib": ">=2.8.1"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "@eslint/markdown": "^6.4.0",
+    "@jest/globals": "^29.7.0",
+    "@release-it/conventional-changelog": "^10.0.1",
+    "@vitest/coverage-v8": "^3.2.0",
+    "cspell": "^9.0.2",
+    "eslint": "^9.28.0",
+    "eslint-config-flat-gitignore": "^2.1.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-jsdoc": "^50.7.1",
+    "eslint-plugin-jsonc": "^2.20.1",
+    "eslint-plugin-perfectionist": "^4.13.0",
+    "eslint-plugin-prettier": "^5.4.1",
+    "eslint-plugin-unicorn": "^59.0.1",
+    "eslint-plugin-yml": "^1.18.0",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "npm-check-updates": "^18.0.1",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^3.5.3",
+    "release-it": "^19.0.3",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.3.4",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "cspell": {
+    "version": "0.2",
+    "language": "en",
+    "words": [
+      "tembo",
+      "temboplus",
+      "lykmapipo",
+      "infile"
+    ],
+    "useGitignore": true
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.tsx?$": [
+        "ts-jest",
+        {
+          "tsconfig": "./tsconfig.jest.json"
+        }
+      ]
+    },
+    "testEnvironment": "node",
+    "collectCoverage": true,
+    "coverageProvider": "v8",
+    "coverageReporters": [
+      "text",
+      "cobertura"
+    ],
+    "injectGlobals": false,
+    "testPathIgnorePatterns": [
+      "/node_modules/",
+      "./vitest.spec.ts"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "requireCleanWorkingDir": true,
+      "requireBranch": "main",
+      "requireCommits": true,
+      "requireUpstream": true,
+      "commit": true,
+      "commitMessage": "chore(release): v${version}",
+      "tag": true,
+      "tagName": "v${version}",
+      "tagAnnotation": "v${version}",
+      "push": true
+    },
+    "github": {
+      "release": true
+    },
+    "npm": {
+      "publish": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": "angular",
+        "infile": "CHANGELOG.md",
+        "header": "# Changelog"
+      }
+    }
+  }
+}

package/tsconfig.base.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Base",
+  "_version": "0.1.0",
+  "extends": [
+    "@tsconfig/node22/tsconfig.json",
+    "@tsconfig/strictest/tsconfig.json"
+  ],
+  "compilerOptions": {
+    "allowJs": false,
+    "checkJs": false,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": ["ESNext"],
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "noEmit": true,
+    "pretty": true,
+    "removeComments": false,
+    "resolveJsonModule": true,
+    "strict": true,
+    "target": "ESNext",
+    "useDefineForClassFields": true
+  },
+  "exclude": [
+    "**/build",
+    "**/coverage",
+    "**/dist",
+    "**/docs",
+    "**/node_modules",
+    "**/out"
+  ]
+}

package/tsconfig.build.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Build (base)",
+  "_version": "0.1.0",
+  "extends": ["./tsconfig.base.json"],
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "importHelpers": true,
+    "noEmit": false,
+    "outDir": "dist",
+    "removeComments": false,
+    "skipLibCheck": false,
+    "sourceMap": true,
+    "stripInternal": true
+  },
+  "include": ["src"],
+  "exclude": [
+    "**/build",
+    "**/coverage",
+    "**/dist",
+    "**/docs",
+    "**/node_modules",
+    "**/out",
+    "**/scripts",
+    "**/test",
+    "**/*spec.ts",
+    "**/*test.ts"
+  ]
+}

package/tsconfig.cjs.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Build (cjs)",
+  "_version": "0.1.0",
+  "extends": ["./tsconfig.build.json"],
+  "compilerOptions": {
+    "module": "CommonJS",
+    "moduleResolution": "node10",
+    "outDir": "dist/cjs"
+  }
+}

package/tsconfig.esm.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Build (esm)",
+  "_version": "0.1.0",
+  "extends": ["./tsconfig.build.json"],
+  "compilerOptions": {
+    "outDir": "dist/esm"
+  }
+}

package/tsconfig.jest.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Jest (ts-jest)",
+  "_version": "0.1.0",
+  "extends": ["./tsconfig.test.json"]
+}

package/tsconfig.nestjs.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "NestJS (base)",
+  "_version": "0.1.0",
+  "extends": ["./tsconfig.cjs.json"],
+  "compilerOptions": {
+    "baseUrl": "./",
+    "incremental": true,
+    "lib": ["ES2023"],
+    "module": "CommonJS",
+    "moduleResolution": "node10",
+    "outDir": "dist",
+    "removeComments": true,
+    "skipLibCheck": true,
+    "target": "ES2023"
+  }
+}

package/tsconfig.test.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Test (base)",
+  "_version": "0.1.0",
+  "extends": ["./tsconfig.base.json"],
+  "compilerOptions": {
+    "composite": false,
+    "declaration": false,
+    "declarationMap": false,
+    "emitDeclarationOnly": false,
+    "isolatedModules": false,
+    "module": "ESNext",
+    "noEmit": true,
+    "skipLibCheck": true,
+    "target": "ESNext"
+  }
+}

package/tsconfig.types.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Build (types)",
+  "_version": "0.1.0",
+  "extends": ["./tsconfig.build.json"],
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "outDir": "dist/types"
+  }
+}

package/tsconfig.vitest.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Vitest",
+  "_version": "0.1.0",
+  "extends": ["./tsconfig.test.json"],
+  "compilerOptions": {
+    "moduleResolution": "bundler"
+  }
+}