arco design按需匯入報錯排查思路與解決方案解析

2023-03-09 06:04:51

正文

記錄一檔使用arco-design按需載入的問題，來幫助更多的開發者避免。當前專案我使用的 @arco-design/web-vue 與 vite-plugin-style-import 版本是：

 "@arco-design/web-vue": "^2.43.2",
 "vite-plugin-style-import": "^2.0.0"

問題描述

首先根據 arco-design 官方的範例，我使用 vite-plugin-style-import 外掛來自動載入元件樣式，程式碼如下：

import { defineConfig } from "vite";
import vue from "@vitejs/plugin-vue";
import { createStyleImportPlugin } from "vite-plugin-style-import";
export default defineConfig({
  server:{
    host:"0.0.0.0",
  },
  plugins: [
    vue(),
    createStyleImportPlugin({
      libs: [
        {
          libraryName: "@arco-design/web-vue",
          esModule: true,
          resolveStyle: (name) => {
            // less
            return `@arco-design/web-vue/es/${name}/style/index.js`;
          },
        },
      ],
    }),
  ],
});

正常使用 Inpuit Button 元件的時候是沒有問題的可以正常渲染，但是當我使用組 InputSearch InputPassword ImagePreview FormItem... 等類似於一些駝峰命名的元件（注意：不包含所有駝峰名的元件），在vite專案中會報一個樣式引入的錯誤如下：

Failed to resolve import "/mnt/d/projectSpace/self-test/node_modules/@arco-design/web-vue/es/form-item/style/index.js" from "src/App.vue". Does the file exist?

排查問題

可以看到我們在 vite.config.js 組態檔中 resolveStyle 方法中返回了一個樣式檔案的路徑，可以列印出來看一下這個 name 是什麼。

   createStyleImportPlugin({
      libs: [
        {
          libraryName: "@arco-design/web-vue",
          esModule: true,
          resolveStyle: (name) => {
            console.log("resolveStyle===>",name)
            // less
            return `@arco-design/web-vue/es/${name}/style/index.js`;
          },
        },
      ],
    }),

這麼一看也沒有什麼問題，我使用元件的名字就是 FormItem 存取的也是 form-item，那再去 @arco-design 包裡面查詢一下對應的路徑是否有檔案

路徑 @arco-design/web-vue/es/form-item/style/index.js

匪夷所思的一幕看到了在 /@arco-design/web-vue/es 目錄下並沒有 form-item 資料夾，還有前面我們遇到所有的報錯的元件如 InputSearch InputPassword ImagePreview FormItem 也都是沒有對應的資料夾，所以才導致他找不到這個元件的樣式檔案，但是通過上圖可以看到我們匯入的 FormItem 元件是從 form 資料夾中匯出的，所以我們只需要 @arco-design/web-vue/es/form-item/style/index.js 改成 @arco-design/web-vue/es/form/style/index.js 匯出就好了。

解決問題

問題原因找到了那處理起來就方便了，我們可以寫一個方法來修改這個元件的名稱獲取對應的路徑。

處理思路

拿到 resolveStyle() 回撥中的 name 通過他生成一個路徑
使用 existsSync 判斷對應的路徑檔案是否存在，他返回一個 boolean，存在返回 true 反之 false
檔案路徑如果不存在就把原路徑 - 結尾的名稱去除，如原路徑是 input-search 轉成 input，如果有三級依此類推，一步一步的去找。
最終返回正確的路徑，如果沒有就直接返回 "" 字串

最終程式碼如下：

import { existsSync } from "node:fs";
import { join } from "node:path";
import { defineConfig } from "vite";
import vue from "@vitejs/plugin-vue";
import { createStyleImportPlugin } from "vite-plugin-style-import";
// 獲取arco樣式路徑
function getArcoStylePath(name) {
  const names = name.split("-");
  const path = `@arco-design/web-vue/es/${name}/style/index.js`;
  if (existsSync(join(__dirname, "./node_modules/" + path))) {
    return path;
  } else {
    names.pop()
    return getArcoStylePath(names.join("-")) || ""
  }
}
export default defineConfig({
  server: {
    host: "0.0.0.0",
  },
  plugins: [
    vue(),
    createStyleImportPlugin({
      libs: [
        {
          libraryName: "@arco-design/web-vue",
          esModule: true,
          resolveStyle: (name) => {
            // less
            return getArcoStylePath(name);;
          },
        },
      ],
    }),
  ],
});

總結

resolveStyle() 回撥中的 name 返回的是當前元件名稱的 name 而且類似 Input InputSearch 這樣的元件 arco 是把他們歸類到 input 資料夾下，同理他們的樣式檔案肯定統一在 input資料夾下，所以我們通過 @arco-design/web-vue/es/input-search/style/index.js 路徑是找不到的，由此一來找到規則後就通過路徑裁剪的形式一步一步的尋找檔案，最終解決此類拋錯。

以上就是arco design按需匯入報錯排查思路與解決方案解析的詳細內容，更多關於arco design按需匯入報錯的資料請關注it145.com其它相關文章！

arco design按需匯入報錯排查思路與解決方案解析

目錄

正文

問題描述

排查問題

解決問題

處理思路

總結

熱門文章