$ ryokkkke.com/TypeScript/tsconfig.json

tsconfig.jsonの全オプションを理解する(随時追加中)

概要

TypeScript のコンパイルにはtsconfig.jsonファイルが必要です。
ここではtsconfig.jsonの全てのオプションそれぞれについて、意味や用途を詳しく解説します。

左のリストから該当するオプション名をクリックすると個別の説明ページに飛びます。

更新日

ページそれぞれに更新日があります。
更新日が古いページもあるかもしれないので気をつけてください。
オプションの仕様が根本から変わることは無いと思いますが、指定できる値はバージョンによって変わったりします。
ES2020みたいな JS の仕様を指定できる系とか)

公式のドキュメント

2020 年 5 月あたりに公式のtsconfig.jsonのドキュメントが更新され、情報量が増えました。
それまでは個別の説明が無かったのですが、今はオプションそれぞれについて説明がつきました。
まずは公式のドキュメント見るようにしましょう。

tsconfig.jsonについて
https://www.typescriptlang.org/docs/handbook/tsconfig-json.html

compilerOptionsのそれぞれのオプションについて
https://www.typescriptlang.org/tsconfig

準備

tsconfig.jsonは自分で作っても良いですが、typescriptをインストールしてからtsc --initすることで作成できます。

$ mkdir tsconfig; cd tsconfig
$ npm init

# TypeScriptは開発環境でしか使わないので --save-dev でdevDependenciesに入れる
$ npm install --save-dev typescript

$ npx tsc -v
Version 3.7.2

# tsconfig.jsonを作成
$ npx tsc --init
message TS6071: Successfully created a tsconfig.json file.

$ ls -1
node_modules
package-lock.json
package.json
tsconfig.json
$ cat tsconfig.json

この一連の文章を一度書いてから最近一部リライトした関係で、一部上記と異なる新しい TypeScript のバージョンで試している部分があるんですが、その時は都度記載しています。

と言いつついきなり下の init 直後のtsconfig.jsonはバージョン4.0.3のものです。

init直後のtsconfig.jsonを表示(長い)
{
  "compilerOptions": {
    /* Visit https://aka.ms/tsconfig.json to read more about this file */

    /* Basic Options */
    // "incremental": true,                   /* Enable incremental compilation */
    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
    // "lib": [],                             /* Specify library files to be included in the compilation. */
    // "allowJs": true,                       /* Allow javascript files to be compiled. */
    // "checkJs": true,                       /* Report errors in .js files. */
    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
    // "outFile": "./",                       /* Concatenate and emit output to single file. */
    // "outDir": "./",                        /* Redirect output structure to the directory. */
    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    // "composite": true,                     /* Enable project compilation */
    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
    // "removeComments": true,                /* Do not emit comments to output. */
    // "noEmit": true,                        /* Do not emit outputs. */
    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

    /* Strict Type-Checking Options */
    "strict": true,                           /* Enable all strict type-checking options. */
    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
    // "strictNullChecks": true,              /* Enable strict null checks. */
    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */

    /* Additional Checks */
    // "noUnusedLocals": true,                /* Report errors on unused locals. */
    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */

    /* Module Resolution Options */
    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
    // "typeRoots": [],                       /* List of folders to include type definitions from. */
    // "types": [],                           /* Type declaration files to be included in compilation. */
    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */

    /* Source Map Options */
    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

    /* Experimental Options */
    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */

    /* Advanced Options */
    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
  }
}

tsconfig.jsonは、json と言いつつコメントが書けます。

ここにざくっとした説明は書かれていますが、正直この説明だけでは何のことやらわからないので、一つずつ見ていきましょう。

ちなみに、VSCode を使っている場合は、使用できるオプション名やその値は補完が効くので便利です。