コンテンツにスキップ

tsconfig.json について

tsconfig.json
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
{
  "compilerOptions": {
    /* Visit https://aka.ms/tsconfig to read more about this file */

    /* Projects */
    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */

    /* Language and Environment */
    "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */

    /* Modules */
    "module": "commonjs" /* Specify what module code is generated. */,
    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
    // "resolveJsonModule": true,                        /* Enable importing .json files. */
    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

    /* JavaScript Support */
    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

    /* Emit */
    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
    // "removeComments": true,                           /* Disable emitting comments. */
    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */

    /* Interop Constraints */
    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,

    /* Type Checking */
    "strict": true /* Enable all strict type-checking options. */,
    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */

    /* Completeness */
    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
    "skipLibCheck": true /* Skip type checking all .d.ts files. */
  }
}

compilerOptions

target

tsconfig.json
1
2
3
4
5
{
  "compilerOptions": {
    "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
  }
}

出力される JavaScript の JavaScript 言語バージョンを設定し、互換性のあるライブラリ宣言を含めます。

TypeScript がどのバージョンの JavaScript にトランスパイルするかを設定する。設定できる値は以下である。

バージョン 説明
ES5 ECMAScript 5(ES5) TypeScript 5.9.3 がサポートする最も古いバージョン。
ES6, ES2015 ECMAScript 2015(ES6) classletconst、アロー関数などが追加されている。
ES2016 ECMAScript 2016(ES7) べき乗演算子(**)、Array.prototype.includesなどが追加されている。
ES2017 ECMAScript 2017(ES8) async/awaitなどが追加されている。
ES2018 ECMAScript 2018(ES9)
ES2019 ECMAScript 2019(ES10)
ES2020 ECMAScript 2020(ES11) オプショナルチェイニング演算子(?.)、Null 合体演算子(??)などが追加されている。
ES2021 ECMAScript 2021(ES12)
ES2022 ECMAScript 2022(ES13) static, private なクラスフィールド、メソッド宣言、Top-level await などが追加されている。
ES2023 ECMAScript 2023(ES14)
ESNext 最新の ECMAScript 提案 実験的な機能を使えるらしい。

ES6ES2015は歴史的経緯で分かれているが指しているものは同じである。

実行対象のブラウザやランタイムの対応状況に沿って、より新しいものを設定すべきである。個人開発やしがらみがないのであればガンガン上げていけば良いし、エンタープライズな開発なら想定利用環境と相談して設定すれば良い。

参考

lib

tsconfig.json
1
2
3
4
5
{
  "compilerOptions": {
    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
  }
}

Specify a set of bundled library declaration files that describe the target runtime environment.

ターゲットのランタイム環境を記述するバンドルされたライブラリ宣言ファイルのセットを指定します。

JavaScript 組み込みのライブラリバージョンを設定する。

設定できる値は以下である。

バージョン 説明
ES5 ECMAScript 5(ES5) すべての ES5 機能のコア定義。
ES2015, ES6 ECMAScript 2015(ES6) ES2015 で利用可能な追加のライブラリ。
ES2016, ES7 ECMAScript 2016(ES7) ES2016 で利用可能な追加のライブラリ。
ES2017 ECMAScript 2017(ES8) ES2017 で利用可能な追加のライブラリ。
ES2018 ECMAScript 2018(ES9) ES2018 で利用可能な追加のライブラリ。
ES2019 ECMAScript 2019(ES10) ES2019 で利用可能な追加のライブラリ。
ES2020 ECMAScript 2020(ES11) ES2020 で利用可能な追加のライブラリ。
ES2021 ECMAScript 2021(ES12) ES2021 で利用可能な追加のライブラリ。
ES2022 ECMAScript 2022(ES13) ES2022 で利用可能な追加のライブラリ。
ES2023 ECMAScript 2023(ES14) ES2023 で利用可能な追加のライブラリ。
ESNext 最新の ECMAScript 提案 ESNext で利用可能な追加のライブラリ。
DOM - DOM 定義。window、document など。
WebWorker - WebWorker コンテキストで利用可能なライブラリ。
ScriptHost - Windows スクリプト ホスティング システム用のライブラリ。

基本的に書かなくても動く。

targetに指定したバージョンで動かしたいが組み込みのライブラリに関してはより新しいものを使いたいという場合はlibを指定することでポリフィルを利用できる。

また Web ブラウザ上で DOM を操作したい場合は、libDOMを追加する必要がある。

参考

module

tsconfig.json
1
2
3
4
5
{
  "compilerOptions": {
    "module": "commonjs" /* Specify what module code is generated. */
  }
}

Specify what module code is generated.

生成されるモジュール コードを指定します。

TypeScript から JavaScript にトランスパイルする際、モジュールの形式をどう変換するかを設定する。設定できる値は以下である。

説明
CommonJS requiremodule.exportsを使用してモジュールを管理する。Node.js や CommonJS で使われる形式。
AMD Asynchronous Module Definition の略。define()を使用する。RequireJS で使われる形式。
System SystemJS で使われる形式。
UMD Universal Module Definition の略。CommonJS、AMD、およびグローバル変数としての動作に対応した形式。
ES6, ES2015 ECMAScript Modules(ESModules)の形式。importexportを使用してモジュールを管理する。Node.js は 14.x から正式対応している。
ES2020 ECMAScript Modules の形式。dynamic import に対応する。
ESNext 提案中の内容も含む最新の ECMAScript Modules の形式。
None モジュールの出力を行わない。
ES2022 ECMAScript Modules の形式。Top-level await に対応する。
Node16, NodeNext 最新の Node.js に合わせた形式。CommonJS も ESModules も対応している。
Preserve TypeScript で書いたモジュールの形式をそのまま維持して JavaScript にする。

Node16については以下に情報がある。

TypeScript の module オプションの話、あるいは TypeScript 開発者の苦悩、あるいは CJS と ESM の話

moduleResolution

tsconfig.json
1
2
3
4
5
{
  "compilerOptions": {
    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
  }
}

Specify how TypeScript looks up a file from a given module specifier.

TypeScript が指定されたモジュール指定子からファイルを検索する方法を指定します。

TypeScript におけるモジュールの探し方を設定する。

設定できる値は以下である。

説明
Classic TypeScript 1.6 より前に使われていたモジュール解決の仕組み。TypeScript の公式ドキュメントには使うべきでないとある。
Node, Node10 Node.js v10 より古いバージョンで使われる CommonJS 形式。TypeScript の公式ドキュメントにはモダンなコードで使うことはないとある。
Node16, NodeNext 最新の Node.js に従う。ESModules も CommonJS も対応している。
Bundler TypeScript の公式ドキュメントにはバンドラーを使うときに指定するとあるが詳細不明。Vite でプロジェクトを作成したときは初期値がこれ。

tsxts-nodeを使ったバックエンド Web アプリケーションなどはNode16、Vite で React を使ったフロントエンド Web アプリケーションはBundlerが良いのだと思う。

参考

types

tsconfig.json
1
2
3
4
5
{
  "compilerOptions": {
    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
  }
}

Specify type package names to be included without being referenced in a source file.

ソース ファイルで参照されずに含まれるタイプ パッケージ名を指定します。

インクルードする TypeScript の型定義ファイルを設定する。このオプションを設定しない場合、node_modules/@typesディレクトリ内のすべての型定義を自動的にインクルードする。

型定義が複数のパッケージで競合する際、明示的に設定することで競合を回避できるらしい。

tsconfig.jsonの例

例えば Node.js で Top-level await を使いたいとする。

Top-level await は以下のようにasyncで囲わなくても await を使える機能である。

src/app.ts
1
2
3
4
// (async () => {
const res = await fetch("https://google.com/");
console.log(res.status);
// }());

Top-level await は ES2022 以降で対応しているので、targetES2023にすれば使えることになる。

tsconfig.json
1
2
3
4
5
6
{
  "compilerOptions": {
    "target": "ES2023",
    "module": "Node16"
  }
}

なお Node.js で ESModules を使いたい場合、package.json のtypemoduleにする必要がある。

typecommonjsmoduleのどちらかを設定する。commonjsは CommonJS 形式でモジュールを解決する。moduleは ESModules 形式でモジュールを解決する。typeを設定しない場合はcommonjsを設定したものとみなされるので、以下の通り設定してやる必要がある。

package.json
1
2
3
{
  "type": "module"
}