無論是 vue2 全家桶還是 vue3 + vite + TypeScript，元件庫的使用幾乎大家都會，但自己開發一個獨立元件庫就不是每個人都掌握的，因為搭建元件庫的基礎開發環境，就會讓很多同學望而卻步。一個元件庫應該至少要包括三個方面：
- 元件庫的開發和打包；
- 元件庫文檔的開發和打包；
- 指令行工具 cli 快速建立新元件。
這幾天 程式員優雅哥 搭建了一個元件庫的基礎腳手架：
vue3-component-library-archetype
在這個腳手架的基礎上，大家可以使用内置的 cli 快速建立新元件，按照套路開發元件及文檔即可。腳手架很大程度上簡化了環境的搭建、打包的配置、類型定義的抽取等工具，開箱即用，大家可以将注意力集中到元件本身的開發上。
腳手架采用 monorepo 風格，使用 pnpm 作為包管理工具。
1 元件庫腳手架内容
- 元件庫開發、打包、釋出
- 元件庫文檔編寫、打包、一套代碼編寫和示範 Demo
- 快速建立元件指令行 cli
- 元件庫搭建的 example 示範
2 元件庫腳手架技術棧
- Vite 3
- Vue 3
- TypeScript
- Vitepress 1.0
- ESLint
3 使用說明
3.1 克隆代碼到本地
git clone [email protected]:HeroCloudy/vue3-component-library-archetype.git 3.2 安裝依賴
如果您沒有安裝 pnpm，需要先按照 pnpm
npm install -g pnpm 安裝依賴：
pnpm i 3.3 本地開發
在 example 中開發元件，使用指令：
pnpm run dev:dev 通路位址為 http://localhost:3000/
在元件庫文檔中開發元件，使用指令：
pnpm run docs:dev 通路位址為 http://localhost:3100/
元件庫文檔界面如下：
3.4 建立新元件
pnpm run gen:component 按照提示輸入元件名稱、元件中文名稱、元件類型（.tsx 或 .vue）。
執行指令建立完元件後，會自動在元件庫中注冊該元件，同時自動生成文檔模闆及文檔中的 demo，無需任何手動配置。
3.5 建構文檔
pnpm run build:docs 打包建構後的檔案位于 docs/.vitepress/dist 目錄
3.6 建構 example
pnpm run build:dev 打包建構後的檔案位于 dist 目錄
3.7 釋出元件庫
元件庫打包：
pnpm run build:lib 在釋出 npm 前可以在本地私服進行測試。 啟動本地私服：
pnpm run start:verdaccio 啟動成功後在浏覽器中通路 http://localhost:4873/
如果初次使用，需要建立使用者。
釋出元件庫到本地私服中：
pnpm run pub:local 4 元件庫指令說明
元件庫的指令入口均在根目錄的 package.json 中的 scripts 中。由于采用了 monorepo 的方式，大多指令的實作都在各自的子產品中。
所有指令如下：
- dev:dev
- dev:uat
- dev:prod
- build:dev
- build:uat
- build:prod
- preview:example
- build:lib
- docs:dev
- docs:build
- docs:preview
- gen:component
- start:verdaccio
- pub:local pnpm run dev:dev
本地開發 example，使用 dev 環境配置，通路位址為 http://localhost:3000/
pnpm run dev:uat
本地開發 example，使用 uat 環境配置，通路位址為 http://localhost:3000/
pnpm run dev:prod
本地開發 example，使用 prod 環境配置，通路位址為 http://localhost:3000/
pnpm run build:dev
打包 dev 環境 example，打包生成的檔案位于項目根目錄的 dist 目錄
pnpm run build:uat
打包 uat 環境 example，打包生成的檔案位于項目根目錄的 dist 目錄
pnpm run build:prod
打包 prod 環境 example，打包生成的檔案位于項目根目錄的 dist 目錄
pnpm run preview:example
預覽打包後的 example，通路位址為：http://localhost:4173/
pnpm run build:lib
打包元件庫，打包生成的檔案位于項目根目錄的 lib 目錄
pnpm run docs:dev
本地開發元件庫文檔，通路位址為：http://localhost:3100/
pnpm run docs:build
元件庫文檔打包，打包生成的檔案位于項目根目錄下的 docs/.vitepress/dist 目錄
pnpm run docs:preview
預覽打包後的元件庫文檔，通路位址為：http://localhost:4173/
pnpm run gen:component
快速建立新元件。依次輸入元件名、元件描述（中文名稱）、元件類型（tsx \ vue）即可自動生成元件并完成配置。
使用該指令可避免元件開發人員分散精力到各種配置、基礎目錄和檔案的建立中，可以讓其聚焦于元件本身的開發。
pnpm run start:verdaccio
啟動 verdaccio。 本地開發時，使用 verdaccio 作為測試使用的本地 npm 私服。 使用該指令啟動 verdaccio 私服，啟動成功後在浏覽器中通路 http://localhost:4873/
如果初次使用，需要建立使用者，可以搜尋 verdaccio，檢視其具體使用。
pnpm run pub:local
釋出元件庫到本地私服。
If you have any questions, please contact me
後面的專題将分享這個腳手架的實作過程，和大家一步步實作這個腳手架，并基于該腳手架實作 JSON Schema 表單、清單等元件，并在 example 中開發通用背景管理系統。
感謝你閱讀本文，如果本文給了你一點點幫助或者啟發，還請三連支援一下，點贊、關注、收藏，作者會持續與大家分享更多幹貨