tsconfig.json編譯選項

為了更好的設置tsc編譯所需的參數， 添加tsconfig.json文件。

 

{
    "compileOnSave": false,
    "compilerOptions": {
        "outDir": "./dist/out-tsc",//輸出目錄
        "baseUrl": "src",
        "sourceMap": true,//把 ts 文件編譯成 js 文件的時候，同時生成對應的 map 文件
        "removeComments": true,//編譯 js 的時候，刪除掉注釋
        "declaration": false,
        "moduleResolution": "node",//模塊的解析
        "emitDecoratorMetadata": true,//給源碼里的裝飾器聲明加上設計類型元數據。查看issue #2577了解更多信息。
        "experimentalDecorators": true,//啟用實驗性的ES裝飾器。
        "target": "es5",//編譯目標平台
        //exclude：不包含的編譯目錄
        //noImplicitAny：true/false；為 false 時，如果編譯器無法根據變量的使用來判斷類型時，將用 any 類型代替。為 true 時，進行強類型檢查，會報錯
        "typeRoots": [
        "node_modules/@types"
        ],
        "lib": [//添加需要的解析的語法，否則TS會檢測出錯。
        "es2016",
        "dom"
        ]
      }
}

 

編譯選項查詢表

 

選項	類型	默認值	描述
--allowJs	boolean	false	允許編譯javascript文件。
--allowSyntheticDefaultImports	boolean	module === "system"	允許從沒有設置默認導出的模塊中默認導入。這並不影響代碼的顯示，僅為了類型檢查。
--allowUnreachableCode	boolean	false	不報告執行不到的代碼錯誤。
--allowUnusedLabels	boolean	false	不報告未使用的標簽錯誤。
--alwaysStrict	boolean	false	以嚴格模式解析並為每個源文件生成"use strict"語句
--baseUrl	string		解析非相對模塊名的基准目錄。查看模塊解析文檔了解詳情。
--charset	string	"utf8"	輸入文件的字符集。
--checkJs	boolean	false	在.js文件中報告錯誤。與--allowJs配合使用。
--declaration -d	boolean	false	生成相應的.d.ts文件。
--declarationDir	string		生成聲明文件的輸出路徑。
--diagnostics	boolean	false	顯示診斷信息。
--disableSizeLimit	boolean	false	禁用JavaScript工程體積大小的限制
--emitBOM	boolean	false	在輸出文件的開頭加入BOM頭（UTF-8 Byte Order Mark）。
--emitDecoratorMetadata[1]	boolean	false	給源碼里的裝飾器聲明加上設計類型元數據。查看issue #2577了解更多信息。
--experimentalDecorators[1]	boolean	false	啟用實驗性的ES裝飾器。
--forceConsistentCasingInFileNames	boolean	false	禁止對同一個文件的不一致的引用。
--help -h			打印幫助信息。
--importHelpers	string		從tslib導入輔助工具函數（比如__extends，__rest等）
--inlineSourceMap	boolean	false	生成單個sourcemaps文件，而不是將每sourcemaps生成不同的文件。
--inlineSources	boolean	false	將代碼與sourcemaps生成到一個文件中，要求同時設置了--inlineSourceMap或--sourceMap屬性。
--init			初始化TypeScript項目並創建一個tsconfig.json文件。
--isolatedModules	boolean	false	將每個文件作為單獨的模塊（與“ts.transpileModule”類似）。
--jsx	string	"Preserve"	在.tsx文件里支持JSX："React"或"Preserve"。查看 JSX。
--jsxFactory	string	"React.createElement"	指定生成目標為react JSX時，使用的JSX工廠函數，比如React.createElement或h。
--lib	string[]		編譯過程中需要引入的庫文件的列表。 可能的值為：  ? ES5  ? ES6  ? ES2015  ? ES7  ? ES2016  ? ES2017  ? DOM  ? DOM.Iterable  ? WebWorker  ? ScriptHost  ? ES2015.Core  ? ES2015.Collection  ? ES2015.Generator  ? ES2015.Iterable  ? ES2015.Promise  ? ES2015.Proxy  ? ES2015.Reflect  ? ES2015.Symbol  ? ES2015.Symbol.WellKnown  ? ES2016.Array.Include  ? ES2017.object  ? ES2017.SharedMemory  注意：如果--lib沒有指定一個默認注入的庫。默認注入的庫為： ? 針對於--target ES5：DOM，ES5，ScriptHost ? 針對於--target ES6：DOM，ES6，DOM.Iterable，ScriptHost
--listEmittedFiles	boolean	false	打印出編譯后生成文件的名字。
--listFiles	boolean	false	編譯過程中打印文件名。
--locale	string	(platform specific)	顯示錯誤信息時使用的語言，比如：en-us。
--mapRoot	string		為調試器指定指定sourcemap文件的路徑，而不是使用生成時的路徑。當.map文件是在運行時指定的，並不同於js文件的地址時使用這個標記。指定的路徑會嵌入到sourceMap里告訴調試器到哪里去找它們。
--maxNodeModuleJsDepth	number	0	node_modules依賴的最大搜索深度並加載JavaScript文件。僅適用於--allowJs。
--module -m	string	target === "ES6" ? "ES6" : "commonjs"	指定生成哪個模塊系統代碼："None"，"CommonJS"，"AMD"，"System"，"UMD"，"ES6"或"ES2015"。 ? 只有 "AMD"和"System"能和--outFile一起使用。 ?"ES6"和"ES2015"可使用在目標輸出為"ES5"或更低的情況下。
--moduleResolution	string	module === "AMD" | "System" | "ES6" ? "Classic" : "Node"	決定如何處理模塊。或者是"Node"對於Node.js/io.js，或者是"Classic"（默認）。查看模塊解析了解詳情。
--newLine	string	(platform specific)	當生成文件時指定行結束符："crlf"（windows）或"lf"（unix）。
--noEmit	boolean	false	不生成輸出文件。
--noEmitHelpers	boolean	false	不在輸出文件中生成用戶自定義的幫助函數代碼，如__extends。
--noEmitOnError	boolean	false	報錯時不生成輸出文件。
--noFallthroughCasesInSwitch	boolean	false	報告switch語句的fallthrough錯誤。（即，不允許switch的case語句貫穿）
--noImplicitAny	boolean	false	在表達式和聲明上有隱含的any類型時報錯。
--noImplicitReturns	boolean	false	不是函數的所有返回路徑都有返回值時報錯。
--noImplicitThis	boolean	false	當this表達式的值為any類型的時候，生成一個錯誤。
--noImplicitUseStrict	boolean	false	模塊輸出中不包含"use strict"指令。
--noLib	boolean	false	不包含默認的庫文件（lib.d.ts）。
--noResolve	boolean	false	不把/// <reference``>或模塊導入的文件加到編譯文件列表。
--noStrictGenericChecks	boolean	false	禁用在函數類型里對泛型簽名進行嚴格檢查。
--noUnusedLocals	boolean	false	若有未使用的局部變量則拋錯。
--noUnusedParameters	boolean	false	若有未使用的參數則拋錯。
--out	string		棄用。使用 --outFile 代替。
--outDir	string		重定向輸出目錄。
--outFile	string		將輸出文件合並為一個文件。合並的順序是根據傳入編譯器的文件順序和///<reference``>和import的文件順序決定的。查看輸出文件順序文件了解詳情。
paths[2]	Object		模塊名到基於baseUrl的路徑映射的列表。查看模塊解析文檔了解詳情。
--preserveConstEnums	boolean	false	保留const和enum聲明。查看const enums documentation了解詳情。
--preserveSymlinks	boolean	false	不把符號鏈接解析為其真實路徑；將符號鏈接文件視為真正的文件。
--pretty[1]	boolean	false	給錯誤和消息設置樣式，使用顏色和上下文。
--project -p	string		編譯指定目錄下的項目。這個目錄應該包含一個tsconfig.json文件來管理編譯。查看tsconfig.json文檔了解更多信息。
--reactNamespace	string	"React"	當目標為生成"react" JSX時，指定createElement和__spread的調用對象
--removeComments	boolean	false	刪除所有注釋，除了以/!*開頭的版權信息。
--rootDir	string	(common root directory is computed from the list of input files)	僅用來控制輸出的目錄結構--outDir。
rootDirs[2]	string[]		根（root）文件夾列表，表示運行時組合工程結構的內容。查看模塊解析文檔了解詳情。
--skipDefaultLibCheck	boolean	false	忽略庫的默認聲明文件的類型檢查。
--skipLibCheck	boolean	false	忽略所有的聲明文件（*.d.ts）的類型檢查。
--sourceMap	boolean	false	生成相應的.map文件。
--sourceRoot	string		指定TypeScript源文件的路徑，以便調試器定位。當TypeScript文件的位置是在運行時指定時使用此標記。路徑信息會被加到sourceMap里。
--strict	boolean	false	啟用所有嚴格類型檢查選項。  啟用--strict相當於啟用--noImplicitAny, --noImplicitThis, --alwaysStrict和--strictNullChecks。
--strictNullChecks	boolean	false	在嚴格的null檢查模式下，null和undefined值不包含在任何類型里，只允許用它們自己和any來賦值（有個例外，undefined可以賦值到void）。
--stripInternal[1]	boolean	false	不對具有/** @internal */ JSDoc注解的代碼生成代碼。
--suppressExcessPropertyErrors[1]	boolean	false	阻止對對象字面量的額外屬性檢查。
--suppressImplicitAnyIndexErrors	boolean	false	阻止--noImplicitAny對缺少索引簽名的索引對象報錯。查看issue #1232了解詳情。
--target -t	string	"ES3"	指定ECMAScript目標版本"ES3"（默認），"ES5"，"ES6"/"ES2015"，"ES2016"，"ES2017"或"ESNext"。 注意："ESNext"最新的生成目標列表為ES proposed features
--traceResolution	boolean	false	生成模塊解析日志信息
--types	string[]		要包含的類型聲明文件名列表。查看@types，--typeRoots和--types章節了解詳細信息。
--typeRoots	string[]		要包含的類型聲明文件路徑列表。查看@types，--typeRoots和--types章節了解詳細信息。
--version -v			打印編譯器版本號。
--watch -w			在監視模式下運行編譯器。會監視輸出文件，在它們改變時重新編譯。