引言

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

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

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

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

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

3 搭建 monorepo 項(xiàng)目

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

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

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

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

3.1 創(chuàng)建項(xiàng)目

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

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

• 初始化 package.json

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

pnpm init

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

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

• git 初始化：

git init

• 創(chuàng)建目錄

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

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)建了四個(gè)目錄，需要告訴 pnpm 有哪些包，pnpm 提供了配置文件來(lái)配置 monorepo。

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

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

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

• 在 package.json 中指定 workspace：

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

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

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

最新評(píng)論