引言

基于 vite3 vue3 的組件庫基礎(chǔ)工程 vue3-component-library-archetype 和用于快速創(chuàng)建該工程的工具 yyg-cli，但在中大型的企業(yè)級項目中，通常會自主搭建這些腳手架或加速器。優(yōu)雅哥希望每位前端伙伴能知其所以然，故接下來的文章將進(jìn)入 Vue3 企業(yè)級優(yōu)雅實(shí)戰(zhàn) 系列，整個系列將包括五大部分：

首先會分享如何從 0 開始搭建一套組件庫基礎(chǔ)工程，即如何從 0 實(shí)現(xiàn) vue3-component-library-archetype。

1 組件庫工程應(yīng)該具備的功能

在參考 Element Plus、Ant Design、Van UI 等 Vue3 開源 UI 項目后，優(yōu)雅哥認(rèn)為一套企業(yè)組件庫工程需要具備如下功能：

• 組件庫的開發(fā)：這是最基礎(chǔ)的，組件庫工程必須要支持組件庫的開發(fā)，在工程中開發(fā)各種組件；
• 組件庫的構(gòu)建：組件庫開發(fā)完成后，不可能讓所有使用該組件庫的項目都使用源碼的方式引入到各個項目中，而是要將其構(gòu)建打包后發(fā)布到私 服或 npm 上，各個項目通過依賴的方式引入使用。在這個過程中，就涉及類型定義的提取、不同模塊化規(guī)范的打包等；
• 組件庫的發(fā)布：上面提到組件庫構(gòu)建打包后需要發(fā)布到私 服或 npm，那難道在組件庫開發(fā)階段就頻繁的發(fā)布到私 服上嗎？這樣做也沒問題。不過優(yōu)雅哥的建議是在本地啟動一個迷你私 服，當(dāng)組件庫開發(fā)到一個階段（如 beta版本）可以提供給其他項目使用時，便可以按照常規(guī)流程發(fā)布到公司的私 服或 npm 上。
• 組件庫文檔的編寫和發(fā)布：通常會采用 MarkDown 來編寫組件庫的操作手冊、每個組件的 API（props 組件的輸入屬性、events 組件提供的事件、methods 組件暴露的方法、slots 組件支持的插槽）、組件的使用說明、Demo 展示、Demo 對應(yīng)的代碼等。組件庫文檔中的 Demo 不僅給使用者參考，還可以使用它來調(diào)試組件。在文檔編寫完成后，需要將文檔構(gòu)建打包發(fā)布到 HTTP 服務(wù)上，供開發(fā)同事查看。
• 組件庫開發(fā)工具 cli：每次新創(chuàng)建一個組件，都需要創(chuàng)建一套組件目錄文件結(jié)構(gòu)、注冊該組件、在文檔中添加該組件文檔、Demo等操作，整個過程繁瑣且沒價值，而組件庫可能會有幾十個組件，所以很有必要開發(fā)一個 cli 用于快速創(chuàng)建組件，同時實(shí)現(xiàn)創(chuàng)建組件的規(guī)范化。
• 組件庫 example 的開發(fā)和發(fā)布：這個是非必須的，在組件庫中添加這個部分是基于兩個方面考慮，其一是可以開發(fā)一個演示站點(diǎn)，用來展示組件庫在項目中的實(shí)現(xiàn)效果；其二是在我的實(shí)踐中，組件的開發(fā)通常由業(yè)務(wù)開發(fā)驅(qū)動，在開發(fā) example 的過程中逐步完善組件庫中的組件，當(dāng)組件實(shí)現(xiàn)到一定的程度后，便可以將 example 抽取到獨(dú)立的工程中。

2 環(huán)境準(zhǔn)備

• Node JS 和 npm 版本：

node -v
npm -v

各位使用的版本最新大于等于我的版本。我本地的版本如下：

node：8.10.0
npm：7.14.0

• 安裝或更新 pnpm：

npm install -g pnpm

安裝后查看版本：

pnpm -v

我本地 pnpm 版本號為 7.14.2。

3 搭建 monorepo 項目

monorepo 單一代碼庫，是一種代碼庫的組織方式，與之對應(yīng)的是 multirepos 多代碼庫。multirepos 通常是將不同的模塊（packages）放在不同的代碼倉庫中，而 monorepo 是一個代碼倉庫中存放多個 packages。

在咱組件庫基礎(chǔ)工程項目中，包含了很多個包：多個組件的包、文檔對應(yīng)的包、cli 包、example 包，如果都在不同的代碼倉庫中維護(hù)，那則需要對應(yīng)多個倉庫，開發(fā)過程中需要在多個倉庫間切換。此外，不同的倉庫間的代碼相互引用也比較麻煩。所以在組件庫基礎(chǔ)工程采用 monorepo 的方式來組織多個包。

實(shí)現(xiàn) monorepo 有很多方式，Lerna、Yarn Workspace、pnpm Workspace 等，這里我選擇 pnpm，使用 pnpm 后你會感覺到它的很多好處：速度、磁盤空間等。

關(guān)于 pnpm、monorepo 的理論知識，大家自己上網(wǎng)查詢，優(yōu)雅哥就不寫那些無關(guān)痛癢的廢話來湊數(shù)了。

3.1 創(chuàng)建項目

• 創(chuàng)建項目根目錄

創(chuàng)建一個目錄，作為組件庫工程的根目錄，目錄名就使用你定義的組件庫的名稱，我命名為 yyg-demo-ui。用 IDE 打開該目錄。

• 初始化 package.json

在命令行中進(jìn)入該目錄，使用 pnpm 初始化 package.json：

pnpm init

執(zhí)行完該命令后，會在項目根目錄下自動生成 package.json 文件。在 package.json 文件中指定 type 屬性為 module：

{
	...
  "type": "module",
  ...
}

• git 初始化：

git init

• 創(chuàng)建目錄

在項目根目錄下分別創(chuàng)建 cli、docs、example、packages 四個目錄，分別存放命令行工具、組件庫文檔、example、組件庫四大模塊，并在 packages 目錄下創(chuàng)建 foo 和 yyg-demo-ui （yyg-admin-ui 需修改為你的組件庫名）兩個目錄。

mkdir -p cli docs example packages/foo packages/yyg-demo-ui

目錄結(jié)構(gòu)如下：

yyg-demo-ui/
|- cli/
|- docs/
|- example/
|- packages/
		|- foo/
		|- yyg-demo-ui/

3.2 配置 workspace

前面創(chuàng)建了四個目錄，需要告訴 pnpm 有哪些包，pnpm 提供了配置文件來配置 monorepo。

• 在項目根目錄下創(chuàng)建配置文件 pnpm-workspace.yaml：

packages:
  - packages/*
  - cli
  - docs
  - example
  # exclude packages that are inside test directories
  - '!**/test/**'

上面的配置指定了 cli、docs、example 本身是 package，packages 目錄下的子目錄也是 package。同時排除了所有的 test 目錄。

• 在 package.json 中指定 workspace：

{
	...
  "workspaces": [
    "packages/*",
    "cli",
    "docs",
    "example"
  ]
}

到這一步就完成 pnpm + monorepo 的搭建了，項目根目錄稱為 workspace-root，下一步將初始化 workspace-root。

以上就是Vue3 企業(yè)級組件庫框架搭建 pnpm monorepo實(shí)戰(zhàn)示例的詳細(xì)內(nèi)容，更多關(guān)于Vue3 組件庫搭建pnpm monorepo的資料請關(guān)注腳本之家其它相關(guān)文章！

最新評論