從0搭建Vue3元件庫(五): 如何使用Vite打包元件庫

web前端進階發表於2023-03-07
Vue元件Vite

本篇文章將介紹如何使用 vite 打包我們的元件庫,同時告訴大家如何使用外掛讓打包後的檔案自動生成宣告檔案(*.d.ts)

打包配置

vite 專門提供了庫模式的打包方式,配置其實非常簡單,首先全域性安裝 vite 以及@vitejs/plugin-vue

pnpm add vite @vitejs/plugin-vue -D -w

在 components 檔案下新建vite.config.ts配置檔案

import { defineConfig } from "vite";
import vue from "@vitejs/plugin-vue";
export default defineConfig({
  build: {
    //打包後檔案目錄
    outDir: "es",
    //壓縮
    minify: false,
    rollupOptions: {
      //忽略打包vue檔案
      external: ["vue"],
      //input: ["index.ts"],
      output: {
        globals: {
          vue: "Vue",
        },
        dir: "dist",
      },
    },
    lib: {
      entry: "./index.ts",
      name: "easyest",
      fileName: "easyest",
      formats: ["es", "umd", "cjs"],
    },
  },
  plugins: [vue()],
});

然後在 components/package.json 新增打包命令scripts

 "scripts": {
    "build": "vite build"
  },

執行pnpm run build

image.png

同時生成了打包後的 dist 檔案

image.png

但是這種打包方式最終會將整個元件庫打包到一個檔案中,並且樣式檔案也不能按需載入,所以我們需要修改一下配置讓打包後的結構和我們開發的結構一致,如下配置我們將打包後的檔案放入 easyest 目錄下,因為後續釋出元件庫的名字就是 easyest，當然這個命名大家可以隨意

import { defineConfig } from "vite";
import vue from "@vitejs/plugin-vue";
export default defineConfig({
  build: {
    //打包檔案目錄
    outDir: "es",
    //壓縮
    //minify: false,
    rollupOptions: {
      //忽略打包vue檔案
      external: ["vue"],
      input: ["index.ts"],
      output: [
        {
          //打包格式
          format: "es",
          //打包後檔名
          entryFileNames: "[name].mjs",
          //讓打包目錄和我們目錄對應
          preserveModules: true,
          exports: "named",
          //配置打包根目錄
          dir: "../easyest/es",
        },
        {
          //打包格式
          format: "cjs",
          //打包後檔名
          entryFileNames: "[name].js",
          //讓打包目錄和我們目錄對應
          preserveModules: true,
          exports: "named",
          //配置打包根目錄
          dir: "../easyest/lib",
        },
      ],
    },
    lib: {
      entry: "./index.ts",
    },
  },
  plugins: [vue()],
});

執行pnpm run build,此時生成打包後的檔案目錄如下

image.png

但是此時的所有樣式檔案還是會統一打包到 style.css 中,還是不能進行樣式的按需載入,所以接下來我們將讓 vite 不打包樣式檔案,樣式檔案後續單獨進行打包。

宣告檔案

到這裡其實打包的元件庫只能給 js 專案使用,在 ts 專案下執行會出現一些錯誤，而且使用的時候還會失去程式碼提示功能，這樣的話我們就失去了用 ts 開發元件庫的意義了。所以我們需要在打包的庫里加入宣告檔案(.d.ts)。

安裝vite-plugin-dts,注意版本最好一致

pnpm add vite-plugin-dts@1.4.1 -D -w

在vite.config.ts引入,注意這裡同時新增了元件命名外掛DefineOptions(上篇文章提到過,注意這個要寫在dts後面,原始碼中可能有誤)

import { defineConfig } from "vite";
import vue from "@vitejs/plugin-vue";
import dts from "vite-plugin-dts";
import DefineOptions from "unplugin-vue-define-options/vite";
export default defineConfig({
  plugins: [
    vue(),
    dts({
      entryRoot: "./src",
      outputDir: ["../easyest/es/src", "../easyest/lib/src"],
      //指定使用的tsconfig.json為我們整個專案根目錄下,如果不配置,你也可以在components下新建tsconfig.json
      tsConfigFilePath: "../../tsconfig.json",
    }),
    DefineOptions(),
 
  ],
});

再次打包就會發現打包後檔案中出現了我們需要的宣告檔案

image.png

其實現在大部分前端構建腳手架都支援 esmodule 了,而 esmodule 本身就支援按需載入,所以說元件庫打包後的 es 格式它本身自帶 treeShaking,而不需要額外配置按需引入。後面我們要做的則是讓樣式檔案也支援按需引入，敬請期待。

本篇文章程式碼地址 如何使用Vite打包元件庫,hxd們star一下

相關文章