temboplus-tsconfig

Base TypeScript configuration files for TemboPlus applications and packages

Requirements

• NodeJS v24.13.0+
• npm v11.6.2+
• typescript v5.9.3+
• tslib v2.8.1+, for optimized bundles

Installation

npm install --save-dev @temboplus/tsconfig
npm install --save tslib

Usage

Extend the desired config in your tsconfig.json or project-specific config files.

Base Configuration (Runtime-agnostic)

// tsconfig.json or tsconfig.base.json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": ["@temboplus/tsconfig/base.json"],
  // overrides + other configurations
  // see: https://www.typescriptlang.org/tsconfig/
}

Build Configurations

Base Build (Runtime-agnostic)

// tsconfig.build.json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": ["@temboplus/tsconfig/build.json"],
  "include": ["src"],
  "exclude": [
    "**/dist",
    "**/node_modules",
    "**/test",
    "**/*fixtures.ts",
    "**/*spec.ts",
    "**/*test.ts",
  ],
  // overrides + other configurations
  // see: https://www.typescriptlang.org/tsconfig/
}

CJS Build

// tsconfig.cjs.json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": ["@temboplus/tsconfig/cjs.json"],
  "include": ["src"],
  "exclude": [
    "**/dist",
    "**/node_modules",
    "**/test",
    "**/*fixtures.ts",
    "**/*spec.ts",
    "**/*test.ts",
  ],
  // overrides + other configurations
  // see: https://www.typescriptlang.org/tsconfig/
}

ESM Build

// tsconfig.esm.json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": ["@temboplus/tsconfig/esm.json"],
  "include": ["src"],
  "exclude": [
    "**/dist",
    "**/node_modules",
    "**/test",
    "**/*fixtures.ts",
    "**/*spec.ts",
    "**/*test.ts",
  ],
  // overrides + other configurations
  // see: https://www.typescriptlang.org/tsconfig/
}

Type Declarations Build

// tsconfig.types.json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": ["@temboplus/tsconfig/types.json"],
  "include": ["src"],
  "exclude": [
    "**/dist",
    "**/node_modules",
    "**/test",
    "**/*fixtures.ts",
    "**/*spec.ts",
    "**/*test.ts",
  ],
  // overrides + other configurations
  // see: https://www.typescriptlang.org/tsconfig/
}

Test Configurations

Base Test (Runtime-agnostic)

// tsconfig.test.json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": ["@temboplus/tsconfig/test.json"],
  // overrides + other configurations
  // see: https://www.typescriptlang.org/tsconfig/
}

Jest (ts-jest)

// tsconfig.test.json or tsconfig.jest.json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": ["@temboplus/tsconfig/jest.json"],
  // overrides + other configurations
  // see: https://www.typescriptlang.org/tsconfig/
}

Vitest

// tsconfig.test.json or tsconfig.vitest.json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": ["@temboplus/tsconfig/vitest.json"],
  // overrides + other configurations
  // see: https://www.typescriptlang.org/tsconfig/
}

NestJS Configurations

Base Configuration (CommonJS & nodenext)

// tsconfig.json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": ["@temboplus/tsconfig/nestjs.json"],
  "include": ["src", "test"],
  "exclude": [
    "**/dist",
    "**/docs",
    "**/logs",
    "**/node_modules",
    "**/out",
    "**/scripts",
    "**/tmp",
  ],
  // overrides + other configurations
  // see: https://www.typescriptlang.org/tsconfig/
}

Build Configuration (CommonJS & nodenext)

// tsconfig.build.json
{
  "$schema": "https://json.schemastore.org/tsconfig",
  "extends": ["./tsconfig.json"],
  "exclude": [
    "**/build",
    "**/coverage",
    "**/dist",
    "**/docs",
    "**/logs",
    "**/node_modules",
    "**/out",
    "**/scripts",
    "**/tmp",
    "**/*fixtures.ts",
    "**/*spec.ts",
    "**/*test.ts",
  ],
  // overrides + other configurations
  // see: https://www.typescriptlang.org/tsconfig/
}

Contribute

We welcome contributions! Here's how to get started:

How to Contribute

1. Open an Issue Start by opening an issue to discuss your proposed changes.

2. Clone the Repo

   git clone [email protected]:TemboPlus-Inc/temboplus-tsconfig.git
   cd temboplus-tsconfig

3. Install dependencies

   npm install

4. Create a Feature Branch

   git checkout -b feature/ < your-feature-name > main

5. Make Your Changes & Run Checks

   npm run check

   For available scripts and automation workflows, see the Tasks guide.

6. Commit Your Changes

   git commit -m "feat(<scope>): <add new feature description>"

7. Push & Submit a Pull Request

   git push origin feature/<your-feature-name>

   Then, open a Pull Request (PR) to the main branch.

Contribution Guidelines

• Follow Conventional Commits (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.