tsconfig.json

Contents
Generate it
Target and module
Strict on
Which files compile

Generate it

tsconfig.json stores compiler options for the whole project. Generate a starter file once per project folder, then tune a few fields by hand instead of typing long flag lists on every compile:

tsc --init

Created a new tsconfig.json

After this step, a bare tsc call with no file names compiles the project using the settings below. The rest of this lesson explains the four fields that matter first.

Target and module

Target picks the JavaScript version of the emitted code, and module picks how files import each other. Older targets run in more places, while newer targets keep modern syntax intact:

{ "compilerOptions": { "target": "ES2020", "module": "commonjs" } }

The pair above suits plain Node scripts well. Browser projects built with a bundler often switch module to a newer style later, once imports span many files.

Strict on

Strict mode turns a family of careful checks on at once. It catches missing values and loose assignments that beginners hit most, so keep it enabled from day one:

{ "compilerOptions": { "strict": true } }

Every snippet in this course assumes strict mode is on. Turning it off hides errors instead of fixing them, which trades a quiet compiler for broken programs.

Which files compile

Include lists the folders the compiler reads, and exclude lists the folders it must skip. With this pair, stray scripts and installed packages never pollute the build:

{ "include": ["src"], "exclude": ["node_modules"] }

Place source files under src and run bare tsc from the project root. The compiler finds the sources on its own and reports errors with file names and line numbers.

Next: Basic types

Article author: Arthur Isaev

Related articles
TypeScript
TypeScript course: zero to hero in 100 lessons
What is TypeScript and where it runs
Install TypeScript
Your first program
tsconfig.json
Basic types
any, unknown, never
Arrays and tuples
Type aliases
Interfaces
Unions and literals
Function types
Parameters
Overloads
Generics
Constraints
Return types
Arrow functions
Callbacks
Narrowing
Assertions
Classes
Constructors
Modifiers
implements
Abstract classes
static
Getters and setters
Enums
ES modules
Decorators
Discriminated unions
Intersections
Mapped types
Conditional types
infer
Template literal types
keyof and typeof
Utility types
satisfies
const assertions
tsc CLI
tsconfig deep dive
Strict mode
Source maps
Declaration files
Linting
Formatting
Debugging
Project references
Publishing packages
Run with Node
npm scripts
argv and env
Files with fs
path and os
JSON IO
Dates
Crypto random
Timers
process
Callbacks to promises
Promises
async and await
Promise.all
Promise.race
HTTPS client
Abort and timeouts
Async error handling
Sequential vs parallel
Event loop
Tests with assert
Test layout
Fixtures
Test doubles
CI tests
DOM basics
DOM events
Fetch in browsers
Forms
Web storage
Npm packages
Bundling concept
SPA concepts
Typed API client
Hand-rolled validation
Iterators and generators
Mixins
Branding nominal types
Result types
Options objects
Builder
Event emitters
Streams
Workers
Deserialization
Capstone: todo CLI
Capstone: JSON API
Capstone: utils library
Modern TypeScript tour
Hero roadmap: the whole course on one page
Install TypeScript on Windows 11
Install TypeScript on Ubuntu
Install TypeScript on Rocky Linux
Install TypeScript on macOS
Install TypeScript on FreeBSD
TypeScript in Docker
Banner image

Search this site

Channel @aofeed Chat @aofeedchat

Contacts and cooperation:
I recommend our hosting beget.ru
Write to info@urn.su, info@aredel.com if you:
1. Want to write an article for our site or translate an article into your native language.
2. Want to place thematically relevant ads on the site.
3. Ads on my site pass maximum censorship. If you see an ad block unsuitable for school-age children, shocking or misleading - please contact us by e-mail
4. Found a mistake, inaccuracy, bug, etc. on the site. ... .......
5. Articles can be shared on social media by clicking a network icon: