Skip to content

Latest commit

 

History

History
490 lines (350 loc) · 13.6 KB

README.md

File metadata and controls

490 lines (350 loc) · 13.6 KB
Raw

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 @tsconfig/recommended
Bun @tsconfig/bun
Create React App @tsconfig/create-react-app
Cypress @tsconfig/cypress
Deno @tsconfig/deno
Docusaurus v2 @tsconfig/docusaurus
Ember @tsconfig/ember
Next.js @tsconfig/next
Node LTS @tsconfig/node-lts
Node 10 @tsconfig/node10
Node 12 @tsconfig/node12
Node 14 @tsconfig/node14
Node 16 @tsconfig/node16
Node 17 @tsconfig/node17
Node 18 @tsconfig/node18
Node 19 @tsconfig/node19
Node 20 @tsconfig/node20
Node 21 @tsconfig/node21
Node 22 @tsconfig/node22
Nuxt @tsconfig/nuxt
React Native @tsconfig/react-native
Remix @tsconfig/remix
Strictest @tsconfig/strictest
Svelte @tsconfig/svelte
Taro @tsconfig/taro
Vite React @tsconfig/vite-react

Available TSConfigs

Recommended tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Bun tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Create React App tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Cypress tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Deno tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Docusaurus v2 tsconfig.json

Install:

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

Add to your tsconfig.json:

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

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

Ember tsconfig.json

Install:

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

Add to your tsconfig.json:

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

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

Next.js tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Node LTS (22) tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Node 10 tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Node 12 tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Node 14 tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Node 16 tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Node 17 tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Node 18 tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Node 19 tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Node 20 tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Node 21 tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Node 22 tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Node 23 tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Nuxt tsconfig.json

Install:

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

Add to your tsconfig.json:

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

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

React Native tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Remix tsconfig.json

Install:

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

Add to your tsconfig.json:

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

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

Strictest tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Svelte tsconfig.json

Install:

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

Add to your tsconfig.json:

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

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

Taro tsconfig.json

Install:

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

Add to your tsconfig.json:

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

Vite React tsconfig.json

Install:

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

Add to your tsconfig.json:

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

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. For instance, if you want to start from a Node 18 + Strictest base config, you can install both @tsconfig/node18 and @tsconfig/strictest packages and extend those configs like so:

// tsconfig.json
{
  "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 to node/bundler.

Contributing

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

Then edit the tsconfig.json files in 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:

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

Developing

Create a set of npm packages via:

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:

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 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.