Vite4+Typescript+Vue3+Pinia 從零搭建(2) - ts配置

項目代碼同步至碼雲 weiz-vue3-template
關於tsconfig的配置欄位可查看其他文檔，如 typeScript tsconfig配置詳解

tsconfig.json

文件修改如下:

{
  "compilerOptions": {
    "target": "ESNext", // 將代碼編譯為最新版本的 JS
    "useDefineForClassFields": true,
    "module": "ESNext", // 使用 ES Module 格式打包編譯後的文件
    "lib": ["ESNext", "DOM", "DOM.Iterable"], // 引入 ES 最新特性和 DOM 介面的類型定義
    "skipLibCheck": true, // 跳過對 .d.ts 文件的類型檢查
    "esModuleInterop": true, // 允許使用 import 引入使用 export = 導出的內容
    "sourceMap": true, // 用來指定編譯時是否生成.map文件
    "allowJs": false, // 是否允許使用js
    "baseUrl": ".", // 查詢的基礎路徑
    "paths": { // 路徑映射,配合別名使用
      "@/*": ["src/*"],
      "@build/*": ["build/*"],
      "#/*": ["types/*"]
    },

    /* Bundler mode */
    "moduleResolution": "node", // 使用 Node/bundler 的模塊解析策略
    "allowImportingTsExtensions": true,
    "resolveJsonModule": true, // 允許引入 JSON 文件
    "isolatedModules": true, // 要求所有文件都是 ES Module 模塊。
    "noEmit": true, // 不輸出文件,即編譯後不會生成任何js文件
    "jsx": "preserve", // 保留原始的 JSX 代碼，不進行編譯

    /* Linting */
    "strict": true, // 開啟所有嚴格的類型檢查
    "noUnusedLocals": true, // 報告未使用的局部變數的錯誤
    "noUnusedParameters": true, // 報告函數中未使用參數的錯誤
    "noFallthroughCasesInSwitch": true // 確保switch語句中的任何非空情況都包含
  },
  "include": [ // 需要檢測的文件
    "src/**/*.ts",
    "src/**/*.d.ts",
    "src/**/*.tsx",
    "src/**/*.vue",
    "mock/*.ts",
    "types/*.d.ts",
    "vite.config.ts"
  ], 
  "exclude": [ // 不需要檢測的文件
    "dist",
    "**/*.js",
    "node_modules"
  ],
  "references": [{ "path": "./tsconfig.node.json" }] // 為文件進行不同配置
}

tsconfig.node.json

修改文件如下：

{
  "compilerOptions": {
    "composite": true, // 對於引用項目必須設置該屬性
    "skipLibCheck": true, // 跳過對 .d.ts 文件的類型檢查
    "module": "ESNext", // 使用 ES Module 格式打包編譯後的文件
    "moduleResolution": "Node", // 使用 Node/bundler 的模塊解析策略
    "allowSyntheticDefaultImports": true // 允許使用 import 導入使用 export = 導出的預設內容 
  },
  "include": ["vite.config.ts"]
}

類型定義

新建文件夾 types，用來存放類型定義。比如新建 index.d.ts：

type TargetContext = "_self" | "_blank";
type EmitType = (event: string, ...args: any[]) => void;
type AnyFunction<T> = (...args: any[]) => T;
type PropType<T> = VuePropType<T>;
type Writable<T> = {
  -readonly [P in keyof T]: T[P];
};
type Nullable<T> = T | null;
type NonNullable<T> = T extends null | undefined ? never : T;

interface Fn<T = any, R = T> {
  (...arg: T[]): R;
}
interface PromiseFn<T = any, R = T> {
  (...arg: T[]): Promise<R>;
}

後續也可以新增其他文件，比如 global.d.ts 存放全局定義，router.d.ts 存放路由定義等

類型檢查命令

修改 package.json，新增以下命令：

"scripts": {
  "type-check": "vue-tsc --noEmit"
},

保存後，運行 npm run type-check，即可項目中是否有類型錯誤

文章作者：唯之為之

文章出處：https://www.cnblogs.com/weizwz/p/17822608.html

版權聲明：本博客所有文章除特別聲明外，均採用 「署名-非商業性使用-相同方式共用 4.0 國際」 許可協議，轉載請註明出處！

內容粗淺，如有錯誤，歡迎大佬批評指正