Vue3從0搭建Vite打包組件庫使用詳解

更新時間：2023年02月17日 15:00:28 作者：東方小月

這篇文章主要為大家介紹了Vue3從0搭建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"
  },

執(zhí)行pnpm run build

p>同時生成了打包后的 dist 文件

但是這種打包方式最終會將整個組件庫打包到一個文件中,并且樣式文件也不能按需加載,所以我們需要修改一下配置讓打包后的結構和我們開發(fā)的結構一致,如下配置我們將打包后的文件放入 easyest 目錄下,因為后續(xù)發(fā)布組件庫的名字就是 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()],
});

執(zhí)行pnpm run build,此時生成打包后的文件目錄如下

但是此時的所有樣式文件還是會統(tǒng)一打包到 style.css 中,還是不能進行樣式的按需加載,所以接下來我們將讓 vite 不打包樣式文件,樣式文件后續(xù)單獨進行打包。

聲明文件

到這里其實打包的組件庫只能給 js 項目使用,在 ts 項目下運行會出現一些錯誤，而且使用的時候還會失去代碼提示功能，這樣的話我們就失去了用 ts 開發(fā)組件庫的意義了。所以我們需要在打包的庫里加入聲明文件(.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(),
  ],
});

再次打包就會發(fā)現打包后文件中出現了我們需要的聲明文件