TypeScript tsconfig.json

概述

如果一個目錄下存在一個tsconfig.json文件，那么它意味著這個目錄是TypeScript項目的根目錄。tsconfig.json文件中指定了用來編譯這個項目的根文件和編譯選項。 一個項目可以通過以下方式之一來編譯：

使用tsconfig.json

• 不帶任何輸入文件的情況下調(diào)用tsc，編譯器會從當前目錄開始去查找tsconfig.json文件，逐級向上搜索父目錄。
• 不帶任何輸入文件的情況下調(diào)用tsc，且使用命令行參數(shù)--project（或-p）指定一個包含tsconfig.json文件的目錄。

當命令行上指定了輸入文件時，tsconfig.json文件會被忽略。

示例

tsconfig.json示例文件:

• 使用"files"屬性

{
    "compilerOptions": {
        "module": "commonjs",
        "noImplicitAny": true,
        "removeComments": true,
        "preserveConstEnums": true,
        "outFile": "../../built/local/tsc.js",
        "sourceMap": true
    },
    "files": [
        "core.ts",
        "sys.ts",
        "types.ts",
        "scanner.ts",
        "parser.ts",
        "utilities.ts",
        "binder.ts",
        "checker.ts",
        "emitter.ts",
        "program.ts",
        "commandLineParser.ts",
        "tsc.ts",
        "diagnosticInformationMap.generated.ts"
    ]
}

• 使用"include"和"exclude"屬性

  {
      "compilerOptions": {
          "module": "commonjs",
          "noImplicitAny": true,
          "removeComments": true,
          "preserveConstEnums": true,
          "outFile": "../../built/local/tsc.js",
          "sourceMap": true
      },
      "include": [
          "src/**/*"
      ],
      "exclude": [
          "node_modules",
          "**/*.spec.ts"
      ]
  }
  

細節(jié)

"compilerOptions"可以被忽略，這時編譯器會使用默認值。在這里查看完整的[編譯器選項](./Compiler Options.md)列表。

"files"指定一個包含相對或絕對文件路徑的列表。 "include"和"exclude"屬性指定一個文件glob匹配模式列表。 支持的glob通配符有：

• * 匹配0或多個字符（不包括目錄分隔符）
• ? 匹配一個任意字符（不包括目錄分隔符）
• **/ 遞歸匹配任意子目錄

如果一個glob模式里的某部分只包含*或.*，那么僅有支持的文件擴展名類型被包含在內(nèi)（比如默認.ts，.tsx，和.d.ts， 如果allowJs設(shè)置能true還包含.js和.jsx）。

如果"files"和"include"都沒有被指定，編譯器默認包含當前目錄和子目錄下所有的TypeScript文件（.ts,.d.ts 和 .tsx），排除在"exclude"里指定的文件。JS文件（.js和.jsx）也被包含進來如果allowJs被設(shè)置成true。 如果指定了 "files"或"include"，編譯器會將它們結(jié)合一并包含進來。 使用 "outDir"指定的目錄下的文件永遠會被編譯器排除，除非你明確地使用"files"將其包含進來（這時就算用exclude指定也沒用）。

使用"include"引入的文件可以使用"exclude"屬性過濾。 然而，通過 "files"屬性明確指定的文件卻總是會被包含在內(nèi)，不管"exclude"如何設(shè)置。 如果沒有特殊指定， "exclude"默認情況下會排除node_modules，bower_components，和jspm_packages目錄。

任何被"files"或"include"指定的文件所引用的文件也會被包含進來。A.ts引用了B.ts，因此B.ts不能被排除，除非引用它的A.ts在"exclude"`列表中。

tsconfig.json文件可以是個空文件，那么所有默認的文件（如上面所述）都會以默認配置選項編譯。

在命令行上指定的編譯選項會覆蓋在tsconfig.json文件里的相應(yīng)選項。

compileOnSave

在最頂層設(shè)置compileOnSave標記，可以讓IDE在保存文件的時候根據(jù)tsconfig.json重新生成文件。

{
    "compileOnSave": true,
    "compilerOptions": {
        "noImplicitAny" : true
    }
}

要想支持這個特性需要Visual Studio 2015， TypeScript1.8.4以上并且安裝atom-typescript插件。

模式

到這里查看模式: http://json.schemastore.org/tsconfig.