序文
tsconfig.json は TypeScript をコンパイルするための設定ファイルです. TypeScript のコードを書く上で非常に重要です. 一部のオプションを設定しない場合は, TypeScript のルールに厳密に従って書く必要があります. ルールにそぐわないコードを書くことコンパイル エラーが発生します。js から ts 開発に切り替えるのがより快適になるように、初期段階でいくつかのルール設定をオフにすることができます
分析する
実験的なデコレータ
実験的な ES デコレータを有効にするかどうか。ブール型、デフォルト値: false。
vex-class を有効にするには、strictFunctionTypes オプションを false に設定する必要もあります
厳密なプロパティの初期化
クラスの未定義でないプロパティがコンストラクターで初期化されているかどうか。ブール型、デフォルト値: false
すべての属性値に初期値を割り当てる必要があります。It is recommend to set strictPropertyInitialization to false, so that there is no need to define a variable and must be assigned a initial value.
true に設定した場合、-strictNullChecks を有効にするか、-strict を同時に有効にする必要があります。
noImplicitAny
ts には多くの型があり、すべての変数またはパラメーター定義がそれがどの型であるかを示すわけではありません。この値を有効にすると、暗黙の any 型がある場合にエラーが報告されます。
TypeScript を使い始めるには、このオプションを初めて false に設定することをお勧めします。
// 当开启noImplicitAny时，需要隐含当any需要明确指出
arr.find(item => item.age=== age) // error
arr.find((item: any) => item.age=== age) // ok
目標
コンパイルの ECMAScript ターゲット バージョンを指定します。列挙値: "ES3"、"ES5"、"ES6" / "ES2015"、"ES2016"、"ES2017"、"ESNext"。デフォルト: 「ES3」
モジュール
生成するモジュール システム コードを指定します。列挙値: "None"、"CommonJS"、"AMD"、"System"、"UMD"、"ES6"、"ES2015"、"ESNext"。デフォルト値は --target オプションによって異なります.ターゲットがES6に設定されている場合、デフォルトのモジュールは「ES6」です.それ以外の場合は「commonjs」です.
ライブラリ
コンパイル中にインポートする必要があるライブラリ ファイルのリスト。string[] 型には多くのオプション値があり、一般的に使用される値は ES5、ES6、ESNext、DOM、DOM.Iterable、WebWorker、ScriptHost などです。この値のデフォルト値は --target オプションによって異なります。ターゲットが ES5 の場合、デフォルト値は ['DOM ', 'ES5', 'ScriptHost'] であり、ターゲットが ES6 の場合、デフォルト値は ['DOM', 'ES6', 'DOM.Iterable', '] です。 ScriptHost' ]
Array.form、Set、Reflect などの TS コードで ES6 クラスを使用するには、lib オプションを設定し、コンパイル中にこれらの標準ライブラリをインポートする必要があります。このように、コンパイル プロセス中にこれらの標準ライブラリに属するクラスまたは API が検出された場合、ts コンパイラはエラーを報告しません。
モジュール解像度
モジュールの処理方法を決定します。文字列型、「node」または「classic」、デフォルト値：「classic」。
パスは非常に便利です
モジュール名またはパスマップのリスト。オブジェクトの値
'./src/util/help' の代わりに '@/util/help' を使用することが多く、'./' か '.../' かを毎回気にする必要がありませんモジュールをさまざまなレベルのファイルにインポートします。
このオプションは、一致する値が見つかったときに、マップされたパスの下にモジュールをロードするようにコンパイラに指示します。
{
"baseUrl": ".", // 注意：baseUrl不可少
"paths": {
// 映射列表
"@/*": [
"src/*"
],
"moduleA": [
"src/libs/moduleA"
]
}
}
// in ts code
import Setting from '@/components/Setting.vue' // 模块实际位置: src/components/Setting.vue
import TestModule from 'moduleA/index.js' // 模块实际位置: src/libs/moduleA/index.js
strictNullChecks
厳密な null チェック モードを有効にするかどうか。ブール値、デフォルト値: false
noUnusedLocals
未使用の変数がある場合にエラーをスローするかどうか。ブール値、デフォルト値: false
変数定義が見つかったが使用されていない場合、コンパイルはエラーを報告しません。eslint のルールにもこの項目がありますが、公式プロジェクトではこのオプションを有効にして true に設定することで、コードをすっきりさせることが推奨されています。
未使用パラメータなし
JavaScript ファイルのコンパイルを許可するかどうか。ブール値、デフォルト値: false
true に設定すると、js サフィックスを持つファイルも typescript によってコンパイルされます。
typeRootsとtypes
デフォルトでは、すべての可視の「@types」パッケージがコンパイル中に含まれます。typeRoots が指定されている場合、typeRoots の下のパッケージのみが含まれます。タイプが指定されている場合、リストされている npm パッケージのみが含まれます。
ファイル、包含および除外
ビルド ファイルに含まれるファイルと除外されるファイル。
include が設定されていない場合、コンパイラはデフォルトで現在のディレクトリとサブディレクトリにすべての TypeScript ファイル (.ts、.d.ts、および .tsx) を含めます。allowJs が true に設定されている場合、JS ファイル (.js および .jsx) も含まれます。exclude は、コンパイルする必要のないファイルまたはフォルダーを除外します。
tsconfig.json の完全な分析
{
"compilerOptions": {
/* 基本选项 */
"target": "es5", // 指定 ECMAScript 目标版本: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'（"ESNext"表示最新的ES语法，包括还处在stage X阶段）
"module": "commonjs", // 指定使用模块: 'commonjs', 'amd', 'system', 'umd' or 'es2015'
"lib": [], // 指定要包含在编译中的库文件
"allowJs": true, // 允许编译 javascript 文件
"checkJs": true, // 报告 javascript 文件中的错误
"jsx": "preserve", // 指定 jsx 代码的生成: 'preserve', 'react-native', or 'react'
"declaration": true, // 生成相应的 '.d.ts' 文件
"sourceMap": true, // 生成相应的 '.map' 文件
"outFile": "./", // 将输出文件合并为一个文件
"outDir": "./", // 指定输出目录
"rootDir": "./", // 用来控制输出目录结构 --outDir.
"removeComments": true, // 删除编译后的所有的注释
"noEmit": true, // 不生成输出文件
"importHelpers": true, // 从 tslib 导入辅助工具函数
"isolatedModules": true, // 将每个文件做为单独的模块 （与 'ts.transpileModule' 类似）.
/* 严格的类型检查选项 */
"strict": true, // 启用所有严格类型检查选项
"noImplicitAny": true, // 在表达式和声明上有隐含的 any类型时报错
"strictNullChecks": true, // 启用严格的 null 检查
"noImplicitThis": true, // 当 this 表达式值为 any 类型的时候，生成一个错误
"alwaysStrict": true, // 以严格模式检查每个模块，并在每个文件里加入 'use strict'
/* 额外的检查 */
"noUnusedLocals": true, // 有未使用的变量时，抛出错误
"noUnusedParameters": true, // 有未使用的参数时，抛出错误
"noImplicitReturns": true, // 并不是所有函数里的代码都有返回值时，抛出错误
"noFallthroughCasesInSwitch": true, // 报告 switch 语句的 fallthrough 错误。（即，不允许 switch 的 case 语句贯穿）
/* 模块解析选项 */
"moduleResolution": "node", // 选择模块解析策略： 'node' (Node.js) or 'classic' (TypeScript pre-1.6)。默认是classic
"baseUrl": "./", // 用于解析非相对模块名称的基目录
"paths": {
}, // 模块名到基于 baseUrl 的路径映射的列表
"rootDirs": [], // 根文件夹列表，其组合内容表示项目运行时的结构内容
"typeRoots": [], // 包含类型声明的文件列表
"types": [], // 需要包含的类型声明文件名列表
"allowSyntheticDefaultImports": true, // 允许从没有设置默认导出的模块中默认导入。
/* Source Map Options */
"sourceRoot": "./", // 指定调试器应该找到 TypeScript 文件而不是源文件的位置
"mapRoot": "./", // 指定调试器应该找到映射文件而不是生成文件的位置
"inlineSourceMap": true, // 生成单个 soucemaps 文件，而不是将 sourcemaps 生成不同的文件
"inlineSources": true, // 将代码与 sourcemaps 生成到一个文件中，要求同时设置了 --inlineSourceMap 或 --sourceMap 属性
/* 其他选项 */
"experimentalDecorators": true, // 启用装饰器
"emitDecoratorMetadata": true, // 为装饰器提供元数据的支持
"strictFunctionTypes": false // 禁用函数参数双向协变检查。
},
/* 指定编译文件或排除指定编译文件 */
"include": [
"src/**/*"
],
"exclude": [
"node_modules",
"**/*.spec.ts"
],
"files": [
"core.ts",
"sys.ts"
],
// 从另一个配置文件里继承配置
"extends": "./config/base",
// 让IDE在保存文件的时候根据tsconfig.json重新生成文件
"compileOnSave": true // 支持这个特性需要Visual Studio 2015， TypeScript1.8.4以上并且安装atom-typescript插件
}