Vite配置路徑別名的簡單實現方法

更新時間：2023年04月04日 09:51:40 作者：ぃ?Gavin

Vite項目中我們可以手動將src路徑設置**@**路徑別名,可以省下很多引入路徑的冗余路徑,下面這篇文章主要給大家介紹了關于Vite配置路徑別名的簡單實現方法,需要的朋友可以參考下

1. 項目說明

主技術棧：

Vite + Vue3 + TypeScript

項目中版本情況：

"Vite": "3.0.0"
"Vue":	"3.2.37"
"Ts":	"4.6.4"

出現問題：

在配置完Vite后，正常開發(fā)沒問題，但是Ts類型檢查報錯：

找不到模塊"/xxx/xxx/xxx"或其相應的類型聲明

2. 解決方法

首先要配置Vite，根據官方文檔中的給出的類型說明：

Record<string, string> | Array<{ find: string | RegExp, replacement: string }>

由此可知：我們可以配置alias為一個對象，或一個 { find, replacement } 的數組

具體配置：

在根目錄中的 vite.config.ts 中加入如下配置：（以下是我個人項目配置）

import { resolve } from "path"; // 導入 path 模塊，幫助我們解析路徑

export default defineConfig({
  resolve: { // 這里配置需要注意：Vite新版本resolve配置改為對象形式，如下：
    alias: [
      {
        find: '@',
        replacement: resolve(__dirname, "src"),
      },
      {
        find: 'comps',
        replacement: resolve(__dirname, "src/components"),
      },
      {
        find: 'apis',
        replacement: resolve(__dirname, "src/apis"),
      },
      {
        find: 'views',
        replacement: resolve(__dirname, "src/views"),
      },
      {
        find: 'routes',
        replacement: resolve(__dirname, "src/router"),
      },
      {
        find: 'store',
        replacement: resolve(__dirname, "src/store"),
      },
      {
        find: 'utils',
        replacement: resolve(__dirname, "src/utils"),
      },
      {
        find: 'styles',
        replacement: resolve(__dirname, "src/styles"),
      },
      {
        find: 'layout',
        replacement: resolve(__dirname, "src/Layout"),
      },
      {
        find: 'models',
        replacement: resolve(__dirname, "src/models"),
      },
      {
        find: 'hooks',
        replacement: resolve(__dirname, 'src/hooks')
      }
    ],
  }
})

這樣配置完成后，項目中可以正常使用，但是Ts類型檢查會提示錯誤，接著，配置根目錄下的 ts.config.json 文件：（這里還是我個人的配置，分別對應Vite中配置好的別名）

注意：主要配置 baseUrl 和 paths 兩個配置項即可，其他選項是初始化項目自動生成的

{
  "compilerOptions": {
    "target": "ESNext",
    "useDefineForClassFields": true,
    "module": "ESNext",
    "moduleResolution": "Node",
    "strict": true,
    "jsx": "preserve",
    "sourceMap": true,
    "resolveJsonModule": true,
    "isolatedModules": true,
    "esModuleInterop": true,
    "lib": ["ESNext", "DOM"],
    "skipLibCheck": true,
    "baseUrl": "./",
    "paths": {
      "@/*":["src/*"],
      "comps/*": ["src/components/*"],
      "apis/*": ["src/apis/*"],
      "views/*": ["src/views/*"],
      "routes/*": ["src/router/*"],
      "store/*": ["src/store/*"],
      "utils/*": ["src/utils/*"],
      "styles/*": ["src/styles/*"],
      "layout/*": ["src/Layout/*"],
      "models/*": ["src/models/*"],
      "hooks/*": ["src/hooks/*"]
    }
  },
  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"],
  "references": [{ "path": "./tsconfig.node.json" }]
}

配置完成后，Ts類型檢查就不會報錯了。（反應慢的重啟一下VsCode）