Basic

It is extremely easy to get started with tsconfig.json as the basic file you need is:

  1. {}

i.e. an empty JSON file at the root of your project. This way TypeScript will include all the .ts files in this directory (and sub directories) as a part of the compilation context. It will also select a few sane default compiler options.

compilerOptions

You can customize the compiler options using compilerOptions:

  1. {
  2.   "compilerOptions": {
  4.     /* Basic Options */                       
  5.     "target": "es5",                       /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'. */
  6.     "module": "commonjs",                  /* Specify module code generation: 'commonjs', 'amd', 'system', 'umd' or 'es2015'. */
  7.     "lib": [],                             /* Specify library files to be included in the compilation:  */
  8.     "allowJs": true,                       /* Allow javascript files to be compiled. */
  9.     "checkJs": true,                       /* Report errors in .js files. */
  10.     "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
  11.     "declaration": true,                   /* Generates corresponding '.d.ts' file. */
  12.     "sourceMap": true,                     /* Generates corresponding '.map' file. */
  13.     "outFile": "./",                       /* Concatenate and emit output to single file. */
  14.     "outDir": "./",                        /* Redirect output structure to the directory. */
  15.     "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
  16.     "removeComments": true,                /* Do not emit comments to output. */
  17.     "noEmit": true,                        /* Do not emit outputs. */
  18.     "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
  19.     "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
  20.     "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
  22.     /* Strict Type-Checking Options */        
  23.     "strict": true,                        /* Enable all strict type-checking options. */
  24.     "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
  25.     "strictNullChecks": true,              /* Enable strict null checks. */
  26.     "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
  27.     "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
  29.     /* Additional Checks */                   
  30.     "noUnusedLocals": true,                /* Report errors on unused locals. */
  31.     "noUnusedParameters": true,            /* Report errors on unused parameters. */
  32.     "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
  33.     "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
  35.     /* Module Resolution Options */           
  36.     "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
  37.     "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
  38.     "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
  39.     "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
  40.     "typeRoots": [],                       /* List of folders to include type definitions from. */
  41.     "types": [],                           /* Type declaration files to be included in compilation. */
  42.     "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
  44.     /* Source Map Options */                  
  45.     "sourceRoot": "./",                    /* Specify the location where debugger should locate TypeScript files instead of source locations. */
  46.     "mapRoot": "./",                       /* Specify the location where debugger should locate map files instead of generated locations. */
  47.     "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
  48.     "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
  50.     /* Experimental Options */                
  51.     "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
  52.     "emitDecoratorMetadata": true          /* Enables experimental support for emitting type metadata for decorators. */
  53.   }
  54. }

These (and more) compiler options will be discussed later.

TypeScript compiler

Good IDEs come with built in support for on the fly ts to js compilation. If however you want to run the TypeScript compiler manually from the command line when using tsconfig.json you can do it in a few ways.

  • Just run tsc and it will look for tsconfig.json in the current as well as all parent folders till it finds it.
  • Run tsc -p ./path-to-project-directory. Of course the path can be a complete or relative to the current directory.

You can even start the TypeScript compiler in watch mode using tsc -w and it will watch your TypeScript project files for changes.