## File: README.md

## Centralized Recommendations for TSConfig bases

Hosts TSConfigs for you to extend in your apps, tuned to a particular runtime environment. Owned and improved by the community.
Basically Definitely Typed for TSConfigs.

We target the latest stable version of TypeScript, note that because we want to be consistent with the versioning the target runtime we can't always do semver releases.

### Table of TSConfigs

| Name                                                                 | Package                                                                              |
| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| [Recommended](#recommended-tsconfigjson)                             | [`@tsconfig/recommended`](https://npmjs.com/package/@tsconfig/recommended)           |
| [Bun](#bun-tsconfigjson)                                             | [`@tsconfig/bun`](https://npmjs.com/package/@tsconfig/bun)                           |
| [Create React App](#create-react-app-tsconfigjson)                   | [`@tsconfig/create-react-app`](https://npmjs.com/package/@tsconfig/create-react-app) |
| [Cypress](#cypress-tsconfigjson)                                     | [`@tsconfig/cypress`](https://npmjs.com/package/@tsconfig/cypress)                   |
| [Deno](#deno-tsconfigjson)                                           | [`@tsconfig/deno`](https://npmjs.com/package/@tsconfig/deno)                         |
| [Docusaurus v2](#docusaurus-v2-tsconfigjson)                         | [`@tsconfig/docusaurus`](https://npmjs.com/package/@tsconfig/docusaurus)             |
| [Ember](#ember-tsconfigjson)                                         | [`@tsconfig/ember`](https://npmjs.com/package/@tsconfig/ember)                       |
| [Next.js](#nextjs-tsconfigjson)                                      | [`@tsconfig/next`](https://npmjs.com/package/@tsconfig/next)                         |
| [Node LTS](#node-lts-22-tsconfigjson)                                | [`@tsconfig/node-lts`](https://npmjs.com/package/@tsconfig/node-lts)                 |
| [Node 10](#node-10-tsconfigjson)                                     | [`@tsconfig/node10`](https://npmjs.com/package/@tsconfig/node10)                     |
| [Node 12](#node-12-tsconfigjson)                                     | [`@tsconfig/node12`](https://npmjs.com/package/@tsconfig/node12)                     |
| [Node 14](#node-14-tsconfigjson)                                     | [`@tsconfig/node14`](https://npmjs.com/package/@tsconfig/node14)                     |
| [Node 16](#node-16-tsconfigjson)                                     | [`@tsconfig/node16`](https://npmjs.com/package/@tsconfig/node16)                     |
| [Node 17](#node-17-tsconfigjson)                                     | [`@tsconfig/node17`](https://npmjs.com/package/@tsconfig/node17)                     |
| [Node 18](#node-18-tsconfigjson)                                     | [`@tsconfig/node18`](https://npmjs.com/package/@tsconfig/node18)                     |
| [Node 19](#node-19-tsconfigjson)                                     | [`@tsconfig/node19`](https://npmjs.com/package/@tsconfig/node19)                     |
| [Node 20](#node-20-tsconfigjson)                                     | [`@tsconfig/node20`](https://npmjs.com/package/@tsconfig/node20)                     |
| [Node 21](#node-21-tsconfigjson)                                     | [`@tsconfig/node21`](https://npmjs.com/package/@tsconfig/node21)                     |
| [Node 22](#node-22-tsconfigjson)                                     | [`@tsconfig/node22`](https://npmjs.com/package/@tsconfig/node22)                     |
| [Node 23](#node-23-tsconfigjson)                                     | [`@tsconfig/node23`](https://npmjs.com/package/@tsconfig/node23)                     |
| [Node 24](#node-24-tsconfigjson)                                     | [`@tsconfig/node24`](https://npmjs.com/package/@tsconfig/node24)                     |
| [Node 26](#node-26-tsconfigjson)                                     | [`@tsconfig/node26`](https://npmjs.com/package/@tsconfig/node26)                     |
| [Node with TypeScript](#node-with-typescript-ts-58-only-tsconfigjson)| [`@tsconfig/node-ts`](https://npmjs.com/package/@tsconfig/node-ts)                   |
| [Nuxt](#nuxt-tsconfigjson)                                           | [`@tsconfig/nuxt`](https://npmjs.com/package/@tsconfig/nuxt)                         |
| [QJSEngine](#qjsengine-tsconfigjson)                                 | [`@tsconfig/qjsengine`](https://npmjs.com/package/@tsconfig/qtsengine)               |
| [React Native](#react-native-tsconfigjson)                           | [`@tsconfig/react-native`](https://npmjs.com/package/@tsconfig/react-native)         |
| [Remix](#remix-tsconfigjson)                                         | [`@tsconfig/remix`](https://npmjs.com/package/@tsconfig/remix)                       |
| [Strictest](#strictest-tsconfigjson)                                 | [`@tsconfig/strictest`](https://npmjs.com/package/@tsconfig/strictest)               |
| [Svelte](#svelte-tsconfigjson)                                       | [`@tsconfig/svelte`](https://npmjs.com/package/@tsconfig/svelte)                     |
| [Taro](#taro-tsconfigjson)                                           | [`@tsconfig/taro`](https://npmjs.com/package/@tsconfig/taro)                         |
| [Vite React](#vite-react-tsconfigjson)                               | [`@tsconfig/vite-react`](https://npmjs.com/package/@tsconfig/vite-react)             |
| [Bases](#bases-tsconfigjson)                               | [`@tsconfig/bases`](https://npmjs.com/package/@tsconfig/bases)             |


### Available TSConfigs


### Recommended <kbd>[tsconfig.json](./bases/recommended.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/recommended
yarn add --dev @tsconfig/recommended
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/recommended/tsconfig.json"
```

### Bun <kbd>[tsconfig.json](./bases/bun.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/bun
yarn add --dev @tsconfig/bun
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/bun/tsconfig.json"
```

### Create React App <kbd>[tsconfig.json](./bases/create-react-app.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/create-react-app
yarn add --dev @tsconfig/create-react-app
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/create-react-app/tsconfig.json"
```

### Cypress <kbd>[tsconfig.json](./bases/cypress.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/cypress
yarn add --dev @tsconfig/cypress
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/cypress/tsconfig.json"
```

### Deno <kbd>[tsconfig.json](./bases/deno.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/deno
yarn add --dev @tsconfig/deno
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/deno/tsconfig.json"
```

### Docusaurus v2 <kbd>[tsconfig.json](./bases/docusaurus.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/docusaurus
yarn add --dev @tsconfig/docusaurus
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/docusaurus/tsconfig.json"
```



> **NOTE**: You may need to add `"baseUrl": "."` to your `tsconfig.json` to support proper file resolution.

### Ember <kbd>[tsconfig.json](./bases/ember.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/ember
yarn add --dev @tsconfig/ember
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/ember/tsconfig.json"
```



> **NOTE**: You may need to add `"baseUrl": "."` to your `tsconfig.json` to support proper file resolution.

### Next.js <kbd>[tsconfig.json](./bases/next.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/next
yarn add --dev @tsconfig/next
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/next/tsconfig.json"
```

### Node LTS (24) <kbd>[tsconfig.json](./bases/node-lts.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node-lts
yarn add --dev @tsconfig/node-lts
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/node-lts/tsconfig.json"
```

### Node with TypeScript (TS >=5.8 ONLY) <kbd>[tsconfig.json](./bases/node-ts.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node-ts
yarn add --dev @tsconfig/node-ts
```


> This base require TypeScript 5.8+ (See [announcement](https://devblogs.microsoft.com/typescript/announcing-typescript-5-8-beta/#the---erasablesyntaxonly-option))

This file is meant to be used in conjunction with other Node.js configurations, you can do so by extending multiple files in the `extends` clause of your `tsconfig.json`:

```json
{
  "extends": ["@tsconfig/node22/tsconfig.json", "@tsconfig/node-ts/tsconfig.json"]
}
```

### Node 10 <kbd>[tsconfig.json](./bases/node10.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node10
yarn add --dev @tsconfig/node10
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/node10/tsconfig.json"
```

### Node 12 <kbd>[tsconfig.json](./bases/node12.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node12
yarn add --dev @tsconfig/node12
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/node12/tsconfig.json"
```

### Node 14 <kbd>[tsconfig.json](./bases/node14.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node14
yarn add --dev @tsconfig/node14
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/node14/tsconfig.json"
```

### Node 16 <kbd>[tsconfig.json](./bases/node16.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node16
yarn add --dev @tsconfig/node16
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/node16/tsconfig.json"
```

### Node 17 <kbd>[tsconfig.json](./bases/node17.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node17
yarn add --dev @tsconfig/node17
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/node17/tsconfig.json"
```

### Node 18 <kbd>[tsconfig.json](./bases/node18.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node18
yarn add --dev @tsconfig/node18
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/node18/tsconfig.json"
```

### Node 19 <kbd>[tsconfig.json](./bases/node19.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node19
yarn add --dev @tsconfig/node19
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/node19/tsconfig.json"
```

### Node 20 <kbd>[tsconfig.json](./bases/node20.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node20
yarn add --dev @tsconfig/node20
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/node20/tsconfig.json"
```

### Node 21 <kbd>[tsconfig.json](./bases/node21.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node21
yarn add --dev @tsconfig/node21
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/node21/tsconfig.json"
```

### Node 22 <kbd>[tsconfig.json](./bases/node22.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node22
yarn add --dev @tsconfig/node22
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/node22/tsconfig.json"
```

### Node 23 <kbd>[tsconfig.json](./bases/node23.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node23
yarn add --dev @tsconfig/node23
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/node23/tsconfig.json"
```

### Node 24 <kbd>[tsconfig.json](./bases/node24.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node24
yarn add --dev @tsconfig/node24
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/node24/tsconfig.json"
```

### Node 26 <kbd>[tsconfig.json](./bases/node26.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/node26
yarn add --dev @tsconfig/node26
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/node26/tsconfig.json"
```

### Nuxt <kbd>[tsconfig.json](./bases/nuxt.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/nuxt
yarn add --dev @tsconfig/nuxt
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/nuxt/tsconfig.json"
```



> **NOTE**: You may need to add `"baseUrl": "."` to your `tsconfig.json` to support proper file resolution.

### QJSEngine <kbd>[tsconfig.json](./bases/qjsengine.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/qjsengine
yarn add --dev @tsconfig/qjsengine
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/qjsengine/tsconfig.json"
```

### React Native <kbd>[tsconfig.json](./bases/react-native.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/react-native
yarn add --dev @tsconfig/react-native
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/react-native/tsconfig.json"
```

### Remix <kbd>[tsconfig.json](./bases/remix.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/remix
yarn add --dev @tsconfig/remix
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/remix/tsconfig.json"
```



> **NOTE**: You may need to add `"baseUrl": "."` to your `tsconfig.json` to support proper file resolution.

### Strictest <kbd>[tsconfig.json](./bases/strictest.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/strictest
yarn add --dev @tsconfig/strictest
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/strictest/tsconfig.json"
```

### Svelte <kbd>[tsconfig.json](./bases/svelte.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/svelte
yarn add --dev @tsconfig/svelte
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/svelte/tsconfig.json"
```



> **NOTE**: After `@tsconfig/svelte@2.0.0`, you should add `/// <reference types="svelte" />` to a `d.ts` or a `index.ts`(entry) file to prevent typescript error.

### Taro <kbd>[tsconfig.json](./bases/taro.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/taro
yarn add --dev @tsconfig/taro
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/taro/tsconfig.json"
```

### Vite React <kbd>[tsconfig.json](./bases/vite-react.json)</kbd>

Install:

```sh
npm install --save-dev @tsconfig/vite-react
yarn add --dev @tsconfig/vite-react
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/vite-react/tsconfig.json"
```




### Bases tsconfig.json

Install:

```sh
npm install --save-dev @tsconfig/bases
yarn add --dev @tsconfig/bases
```

Add to your `tsconfig.json`:

```json
// "extends": "@tsconfig/bases/"
"extends": "@tsconfig/bases/node-lts"
```

### What about combined configs?

Because of previous limitations in the config extension system of TypeScript,
this repo used to provide combined configs from a few common bases (like Node + ESM,
Node + Strictest and so on).

This issue is now moot since TypeScript v5.0.0, which provides the [ability to
extend from multiple configs at once](https://devblogs.microsoft.com/typescript/announcing-typescript-5-0-rc/#supporting-multiple-configuration-files-in-extends). For instance, if you want
to start from a Node 18 + Strictest base config, you can install [@tsconfig/bases](#bases-tsconfigjson) (or both
`@tsconfig/node18` and `@tsconfig/strictest`) package and extend those configs like so:

```jsonc
// tsconfig.json
{
  "extends": ["@tsconfig/bases/strictest", "@tsconfig/bases/node18"]
  // or "extends": ["@tsconfig/strictest/tsconfig", "@tsconfig/node18/tsconfig"]
}
```

You can see the result of the combined configs via `tsc --showConfig`.

### What about `@tsconfig/esm`?

We deprecated it in favour of setting [module/moduleResolution](https://github.com/tsconfig/bases/pull/197) to node/bundler.

### Contributing

```sh
git clone https://github.com/tsconfig/bases.git tsconfig-bases
cd tsconfig-bases
```

Then edit the tsconfig.json files in [`bases/`](./bases).

Every morning there is a GitHub Action which deploys any changed bases.

To generate the recommended TSConfig which is generated via `tsc --init`, run:

```sh
deno run --allow-read --allow-run --allow-env --allow-write --allow-net scripts/generate-recommend.ts
```

### Developing

Create a set of npm packages via:

```sh
deno run --allow-read --allow-write --allow-net scripts/create-npm-packages.ts
```

You can inspect them in the `packages/` folder, then they are deployed by passing in the paths to the base files via stdin:

```sh
deno run --allow-read --allow-run --allow-env --allow-net scripts/deploy-changed-npm-packages.ts
```

The rest of the files in this repo are for deploying, which uses [Deno](https://deno.land) 1.0.

If you add a new json file, please run `deno run --allow-read --allow-write scripts/update-markdown-readme.ts` to update the README.

---

## File: template/README.md

### [display_title].

Add the package to your `"devDependencies"`:

```sh
npm install --save-dev @tsconfig/[filename]
yarn add --dev @tsconfig/[filename]
```

Add to your `tsconfig.json`:

```json
"extends": "@tsconfig/[filename]/tsconfig.json"
```
[readme-extra]
---

The `tsconfig.json`: 

```jsonc
[tsconfig]
```

You can find the [code here](https://github.com/tsconfig/bases/blob/master/bases/[filename].json).