tsconfig.json


概述

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

使用tsconfig.json

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

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

示例

tsconfig.json示例文件:

  • 使用"files"屬性
{
    "compilerOptions": { "module": "commonjs", "noImplicitAny": true, "removeComments": true, "preserveConstEnums": true, "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": "system", "noImplicitAny": true, "removeComments": true, "preserveConstEnums": true, "outFile": "../../built/local/tsc.js", "sourceMap": true }, "include": [ "src/**/*" ], "exclude": [ "node_modules", "**/*.spec.ts" ] } 

細節

"compilerOptions"可以被忽略,這時編譯器會使用默認值。在這里查看完整的編譯器選項列表。

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

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

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

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

使用"include"引入的文件可以使用"exclude"屬性過濾。 然而,通過 "files"屬性明確指定的文件卻總是會被包含在內,不管"exclude"如何設置。 如果沒有特殊指定, "exclude"默認情況下會排除node_modulesbower_componentsjspm_packages<outDir>目錄。

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

需要注意編譯器不會去引入那些可能做為輸出的文件;比如,假設我們包含了index.ts,那么index.d.tsindex.js會被排除在外。 通常來講,不推薦只有擴展名的不同來區分同目錄下的文件。

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

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

@typestypeRootstypes

默認所有可見的"@types"包會在編譯過程中被包含進來。 node_modules/@types文件夾下以及它們子文件夾下的所有包都是可見的; 也就是說, ./node_modules/@types/../node_modules/@types/../../node_modules/@types/等等。

如果指定了typeRoots只有typeRoots下面的包才會被包含進來。 比如:

{
   "compilerOptions": { "typeRoots" : ["./typings"] } } 

這個配置文件會包含所有./typings下面的包,而不包含./node_modules/@types里面的包。

如果指定了types,只有被列出來的包才會被包含進來。 比如:

{
   "compilerOptions": { "types" : ["node", "lodash", "express"] } } 

這個tsconfig.json文件將僅會包含 ./node_modules/@types/node./node_modules/@types/lodash./node_modules/@types/express。/@types/。 node_modules/@types/*里面的其它包不會被引入進來。

指定"types": []來禁用自動引入@types包。

注意,自動引入只在你使用了全局的聲明(相反於模塊)時是重要的。 如果你使用 import "foo"語句,TypeScript仍然會查找node_modulesnode_modules/@types文件夾來獲取foo包。

使用extends繼承配置

tsconfig.json文件可以利用extends屬性從另一個配置文件里繼承配置。

extendstsconfig.json文件里的頂級屬性(與compilerOptionsfilesinclude,和exclude一樣)。 extends的值是一個字符串,包含指向另一個要繼承文件的路徑。

在原文件里的配置先被加載,然后被來至繼承文件里的配置重寫。 如果發現循環引用,則會報錯。

來至所繼承配置文件的filesincludeexclude覆蓋源配置文件的屬性。

配置文件里的相對路徑在解析時相對於它所在的文件。

比如:

configs/base.json

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

tsconfig.json

{
  "extends": "./configs/base", "files": [ "main.ts", "supplemental.ts" ] } 

tsconfig.nostrictnull.json

{
  "extends": "./tsconfig", "compilerOptions": { "strictNullChecks": false } } 

compileOnSave

在最頂層設置compileOnSave標記,可以讓IDE在保存文件的時候根據tsconfig.json重新生成文件。

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

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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM