Vue開發(fā)配置tsconfig.json文件的實(shí)現(xiàn)

更新時間：2023年08月17日 15:07:51 作者：程序員云帆哥

tsconfig.json文件中指定了用來編譯這個項(xiàng)目的根文件和編譯選項(xiàng),本文就來介紹一下Vue開發(fā)配置tsconfig.json文件的實(shí)現(xiàn),感興趣的可以了解一下

一、簡介

tsconfig.json文件中指定了用來編譯這個項(xiàng)目的根文件和編譯選項(xiàng)。

二、配置

1、示例

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@/*": [
        "src/*"
      ]
    }
  },
  "include": [
    "src/**/*.ts",
    "src/**/*.d.ts",
    "src/**/*.tsx",
    "src/**/*.vue",
    "vite.config.ts"
  ],
  "exclude": ["dist", "**/*.js", "node_modules"]
}

compilerOptions：編譯器選項(xiàng)列表。
include 和 exclude：指定一個文件glob匹配模式列表。

2、編譯器選項(xiàng)列表

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