tsconfig.json Explainer: What Each Option Does
Annotates each option in a tsconfig.json with what it does and flags unknown option names and a few risky combinations.
Use the tool
Why this tool exists
A tsconfig often contains options copied from a template, and nobody remembers why. This page gives one line per option so you can decide what to keep. Comments and trailing commas are accepted, as in a real tsconfig.
Option names were checked against the TSConfig Reference. The notes are short summaries I wrote, and defaults change between TypeScript versions, so confirm details in the reference before changing a build.
How to use it
- Paste your tsconfig.json.
- Read each entry and its note.
- Check the Review list for unknown names and risky settings.
- Look up anything unclear in the TSConfig Reference.
Frequently asked questions
Are the descriptions official?
No. They are short summaries written for this page. The option names are checked against the reference.
Does it read extended configs?
No. Only the pasted file is read, not files named in extends.
Why is my option unknown?
It may be a typo, a wrong capitalisation, or newer than the list used here.
Is the file uploaded?
No.