# @petbee/tsconfig

> This is the default `tsconfig.json` that should be used by all Petbee projects.

Latest version **5.3.0** (published 2026-09-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @petbee/tsconfig
pnpm add @petbee/tsconfig
yarn add @petbee/tsconfig
bun add @petbee/tsconfig
```

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 5.3.0 |
| Published | 2026-09-26 |
| First published | 2023-11-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 24.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | mateussaggin, contatopetbee |

## Links

- npm: https://www.npmjs.com/package/@petbee/tsconfig
- Repository: https://github.com/petbee/typescript
- Issues: https://github.com/petbee/typescript/issues
- npm.io page: https://npm.io/package/@petbee/tsconfig

## Recent versions

- 5.3.0 (latest) — 2026-09-26
- 5.2.0 — 2026-09-22
- 5.1.1 — 2026-09-22
- 5.1.0 — 2026-09-22
- 5.0.1 — 2026-09-21
- 5.0.0 — 2026-09-19
- 4.1.0 — 2026-09-19
- 4.0.1 — 2026-05-17
- 4.0.0 — 2026-05-09
- 3.0.7 — 2026-05-09
- 3.0.6 — 2026-04-20
- 3.0.5 — 2026-04-13
- 3.0.4 — 2026-02-18
- 3.0.3 — 2026-02-01
- 3.0.2 — 2026-02-01
- … 8 more at https://npm.io/package/@petbee/tsconfig/versions

## README

# `@petbee/tsconfig`

This is the default `tsconfig.json` that should be used by all Petbee projects.

## Features (v4.0.0)

- ✅ **TypeScript 6.0+ tested** - Updated tooling while preserving broad peer compatibility
- ✅ **ES2022+ Target** - Modern JavaScript features
- ✅ **Modern Module Resolution** - `bundler` for web apps, `NodeNext` for Node.js
- ✅ **Strict Type Safety** - Including `noUncheckedIndexedAccess` for safer array access
- ✅ **Verbatim Module Syntax** - Better ESM compatibility
- ✅ **React 17+ JSX** - New JSX transform (`react-jsx`)

## Install

```bash
yarn add -D @petbee/tsconfig typescript
```

## Module Resolution Guide

This package provides entry-point configs for each framework, making it easy to extend the right config for your project:

- **`base.json`** – Safe, strict defaults for all projects (modern web, library, etc.)
- **`react.json`** – For React projects (extends `react/dom.json`)
- **`node.json`** – For Node.js ESM projects (extends `node/base.json`)
- **`nestjs.json`** – For NestJS projects (extends `nestjs/base.json`)
- **`nextjs.json`** – For Next.js projects (extends `nextjs/base.json`)
- **`node/commonjs.json`** – For legacy Node.js CommonJS projects

You can also extend the more granular configs in each framework folder if you need a specific variant (e.g., `react/library.json`, `node/library.json`).

## Usage

### React Project

#### React Project

To start, create a `tsconfig.json` in the root of your project:

```json
{
  "extends": "@petbee/tsconfig/react.json",
  "compilerOptions": {
    "baseUrl": ".",
    "rootDir": "."
  },
  "include": ["./src/**/*"]
}
```

#### React Library Project

Similarly for a react library project. Create a `tsconfig.json` in the root of your project with a setup below assuming the library code sit in `[project root]/src` folder.

```json
{
  "extends": "@petbee/tsconfig/react/library.json",
  "compilerOptions": {
    "baseUrl": "./src",
    "rootDir": "."
  },
  "include": ["./src/**/*"]
}
```

#### Project that run in the browser

A configuration file is provided that includes styles setup and modern React JSX transform.

**Note:** This config uses `"jsx": "react-jsx"` (the new JSX transform from React 17+), which means you don't need to import React in every file that uses JSX.

```json
{
  "extends": "@petbee/tsconfig/react/dom.json",
  "compilerOptions": {
    "baseUrl": ".",
    "rootDir": "."
  }
}
```

The React DOM config includes type definitions for:

- Image imports (`.svg`, `.png`, `.jpg`, etc.)
- Style imports (`.css`, `.scss`, `.module.css`, etc.)

### NestJS Project

To start, create a `tsconfig.json` in the root of your project.

**Note:** The NestJS config uses CommonJS module system (`"module": "commonjs"`) and Node.js module resolution, which is optimal for NestJS applications.

**Note:** The NestJS config declares `"types": ["node", "jest"]`. TypeScript 6 no longer loads every `@types/*` package it finds in `node_modules`; only the packages listed in `types` are visible, so without this line every Jest spec fails with `Cannot find name 'describe'` the moment a project upgrades. Every Petbee NestJS project has both `@types/node` and `@types/jest` installed. A project that needs more (for example `multer`) redeclares the full list in its own `tsconfig.json`, since `types` replaces rather than merges.

A typical setup where the application sit in `[project root]/src` folder is as follow:

```json
{
  "extends": "@petbee/tsconfig/nestjs.json",
  "compilerOptions": {
    "rootDir": "./src"
  },
  "exclude": ["node_modules", "dist", "tests/**/*", "**/*.spec.ts"]
}
```

### NodeJS Project

**Note:** The Node.js config uses modern ESM module resolution (`"moduleResolution": "NodeNext"`). This is optimal for Node.js 18+ with native ESM support. If you're using CommonJS, consider using the NestJS config instead.

#### Node.js Project (ESM)

To start, create a `tsconfig.json` in the root of your project:

```json
{
  "extends": "@petbee/tsconfig/node.json",
  "compilerOptions": {
    "baseUrl": "./",
    "outDir": "./dist"
  }
}
```

**For ESM projects**, ensure your `package.json` has:

```json
{
  "type": "module"
}
```

#### Node.js Project (CommonJS)

For legacy Node.js projects using CommonJS, extend the CommonJS config:

```json
{
  "extends": "@petbee/tsconfig/node/commonjs.json",
  "compilerOptions": {
    "baseUrl": "./",
    "outDir": "./dist"
  }
}
```

### Custom/Advanced Usage

If you need more control, you can extend any of the granular configs in the framework folders (e.g., `react/library.json`, `node/library.json`, etc.) or the base config directly:

```json
{
  "extends": "@petbee/tsconfig/base.json",
  "compilerOptions": {
    "baseUrl": ".",
    "rootDir": "."
  }
}
```

### TypeScript Configuration Notes

#### Plugins

- If you override the `plugins` array in your project’s tsconfig.json, **always include** the Next.js plugin for Next.js projects:
  ```json
  "plugins": [
    { "name": "next" }
  ]
  ```
- Omitting the Next.js plugin may cause type-checking and IDE features to break.

#### Include/Exclude

- If you set your own `include` or `exclude` arrays, they will completely replace those from the base config.
- Use the recommended patterns from the base config unless you have a specific need.

## Common Got Ya

#### Type Checking does not honour `skipLibCheck: true` setting

There are times when the type failure occur inside of a library your project is consuming, and having `skipLibCheck: true` does not resolved it. In this scenario, add an `exclude` option to your `tsconfig.json`.

eg.

```json
{
  "extends": "@petbee/tsconfig/base.json",
  "compilerOptions": {
    "baseUrl": ".",
    "rootDir": ".",
    "exclude": ["./node_modules/**/*"]
  }
}
```

---
_Source: https://npm.io/package/@petbee/tsconfig · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._