Vue3 企業級優雅實戰 - 組件庫框架 - 1 搭建 pnpm monorepo

来源:https://www.cnblogs.com/youyacoder/archive/2022/11/07/16865819.html
-Advertisement-
Play Games

前兩篇文章分享了基於 vite3 vue3 的組件庫基礎工程 *vue3-component-library-archetype* 和用於快速創建該工程的工具 *yyg-cli*,但在中大型的企業級項目中,通常會自主搭建這些腳手架或加速器。優雅哥希望每位前端伙伴能知其所以然,故接下來的文章將進入 *... ...


前兩篇文章分享了基於 vite3 vue3 的組件庫基礎工程 vue3-component-library-archetype 和用於快速創建該工程的工具 yyg-cli,但在中大型的企業級項目中,通常會自主搭建這些腳手架或加速器。優雅哥希望每位前端伙伴能知其所以然,故接下來的文章將進入 Vue3 企業級優雅實戰 系列,整個系列將包括五大部分:

image-20221103232852183

首先會分享如何從 0 開始搭建一套組件庫基礎工程,即如何從 0 實現 vue3-component-library-archetype

1 組件庫工程應該具備的功能

在參考 Element PlusAnt DesignVan UIVue3 開源 UI 項目後,優雅哥認為一套企業組件庫工程需要具備如下功能:

  1. 組件庫的開發:這是最基礎的,組件庫工程必須要支持組件庫的開發,在工程中開發各種組件;
  2. 組件庫的構建:組件庫開發完成後,不可能讓所有使用該組件庫的項目都使用源碼的方式引入到各個項目中,而是要將其構建打包後發佈到私服或 npm 上,各個項目通過依賴的方式引入使用。在這個過程中,就涉及類型定義的提取、不同模塊化規範的打包等;
  3. 組件庫的發佈:上面提到組件庫構建打包後需要發佈到私服或 npm,那難道在組件庫開發階段就頻繁的發佈到私服上嗎?這樣做也沒問題。不過優雅哥的建議是在本地啟動一個迷你私服,當組件庫開發到一個階段(如 beta版本)可以提供給其他項目使用時,便可以按照常規流程發佈到公司的私服或 npm 上。
  4. 組件庫文檔的編寫和發佈:通常會採用 MarkDown 來編寫組件庫的操作手冊、每個組件的 API(props 組件的輸入屬性、events 組件提供的事件、methods 組件暴露的方法、slots 組件支持的插槽)、組件的使用說明、Demo 展示、Demo 對應的代碼等。組件庫文檔中的 Demo 不僅給使用者參考,還可以使用它來調試組件。在文檔編寫完成後,需要將文檔構建打包發佈到 HTTP 服務上,供開發同事查看。
  5. 組件庫開發工具 cli:每次新創建一個組件,都需要創建一套組件目錄文件結構、註冊該組件、在文檔中添加該組件文檔、Demo等操作,整個過程繁瑣且沒價值,而組件庫可能會有幾十個組件,所以很有必要開發一個 cli 用於快速創建組件,同時實現創建組件的規範化。
  6. 組件庫 example 的開發和發佈:這個是非必須的,在組件庫中添加這個部分是基於兩個方面考慮,其一是可以開發一個演示站點,用來展示組件庫在項目中的實現效果;其二是在我的實踐中,組件的開發通常由業務開發驅動,在開發 example 的過程中逐步完善組件庫中的組件,當組件實現到一定的程度後,便可以將 example 抽取到獨立的工程中。

2 環境準備

  1. Node JS 和 npm 版本:
node -v
npm -v

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

node:8.10.0
npm:7.14.0
  1. 安裝或更新 pnpm
npm install -g pnpm

安裝後查看版本:

pnpm -v

我本地 pnpm 版本號為 7.14.2

3 搭建 monorepo 項目

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

在咱組件庫基礎工程項目中,包含了很多個包:多個組件的包、文檔對應的包、cli 包、example 包,如果都在不同的代碼倉庫中維護,那則需要對應多個倉庫,開發過程中需要在多個倉庫間切換。此外,不同的倉庫間的代碼相互引用也比較麻煩。所以在組件庫基礎工程採用 monorepo 的方式來組織多個包。

實現 monorepo 有很多方式,LernaYarn Workspacepnpm Workspace 等,這裡我選擇 pnpm,使用 pnpm 後你會感覺到它的很多好處:速度、磁碟空間等。

關於 pnpm、monorepo 的理論知識,大家自己上網查詢,優雅哥就不寫那些無關痛癢的廢話來湊數了。

3.1 創建項目

  1. 創建項目根目錄

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

  1. 初始化 package.json

在命令行中進入該目錄,使用 pnpm 初始化 package.json

pnpm init

執行完該命令後,會在項目根目錄下自動生成 package.json 文件。在 package.json 文件中指定 type 屬性為 module

{
	...
  "type": "module",
  ...
}
  1. git 初始化:
git init
  1. 創建目錄

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

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

目錄結構如下:

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

3.2 配置 workspace

前面創建了四個目錄,需要告訴 pnpm 有哪些包,pnpm 提供了配置文件來配置 monorepo

  1. 在項目根目錄下創建配置文件 pnpm-workspace.yaml
packages:
  - packages/*
  - cli
  - docs
  - example
  # exclude packages that are inside test directories
  - '!**/test/**'

上面的配置指定了 clidocsexample 本身是 package,packages 目錄下的子目錄也是 package。同時排除了所有的 test 目錄。

  1. package.json 中指定 workspace
{
	...
  "workspaces": [
    "packages/*",
    "cli",
    "docs",
    "example"
  ]
}

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

感謝你閱讀本文,如果本文給了你一點點幫助或者啟發,還請三連支持一下,點贊、關註、收藏,程式員優雅哥會持續與大家分享更多乾貨


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 作者:小牛呼嚕嚕 | https://xiaoniuhululu.com 電腦內功、JAVA底層、面試相關資料等更多精彩文章在公眾號「小牛呼嚕嚕 」 前言 大家好,國慶馬上就要過去了,這不偷偷地進來學習了一波。之前小牛學過一點深度學習的知識,做了幾個項目,發現CPU來訓練就很慢,但是後來用裝有GP ...
  • 今天跟大家分享一些優化神技,當你面試或者工作中你遇到如下問題,那就使出今天學到的絕招,一招定乾坤! 如何用更少的記憶體保存更多的數據? 我們應該從 Redis 是如何保存數據的原理展開,分析鍵值對的存儲結構和原理。 從而繼續延展出每種數據類型底層的數據結構,針對不同場景使用更恰當的數據結構和編碼實現更 ...
  • 在經濟面臨下行壓力、疫情反覆等不確定因素之下,推動數字化轉型就成為了許多企業的“救命稻草”。然而,較高的數字化轉型門檻、不成系統的數據服務,以及缺乏規範的行業標準等都成了企業數字化轉型路上的“絆腳石”。 2015年,袋鼠雲成立並毅然投身於具有巨大想象力的數字經濟發展浪潮,經過7年努力實踐,不斷完善自 ...
  • 摘要:本文介紹了9個GaussDB常用的對象語句,希望對大家有幫助。 本文分享自華為雲社區《GaussDB對象相關語句》,作者:酷哥。 1. 常用函數 pg_database_size() -- 資料庫使用的磁碟空間。 pg_table_size() -- 表使用的磁碟空間。 pg_total_re ...
  • 故障檢測(Failure Detection)是 Group Replication 的一個核心功能模塊,通過它可以及時識別集群中的故障節點,並將故障節點從集群中剔除掉。如果不將故障節點及時剔除的話,一方面會影響集群的性能,另一方面還會阻止集群拓撲的變更。 下麵結合一個具體的案例,分析 Group ...
  • 這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 在AndroidManifest.xml註冊ACTION事件 <activity android:name="com.test.app.MainActivity" android:configChanges="orientation|ke ...
  • 隊列結構 一.認識隊列 受限的線性結構: 我們已經學習了一種受限的線性結構:棧結構. 並且已經知道這種受限的數據結構對於解決某些特定問題,會有特別的 效果. 下麵,我們再來學習另外一個受限的數據結構:隊列. 隊列(Queue),它是一種受限的線性表,先進先出(FIFO First ln First ...
  • 項目調試的困境 程式開發總會遇到各種各樣的問題,為什麼實際結果和預期結果不一致? 這個時候如果能深入程式內部抽絲剝繭去一探究竟再好不過! 而chrome工具是前端開發的殺手鐧,經常聽到的一句話是: 出問題了?F12看看... 前端調試的手法一般就兩種: 服務端(添加調試代碼) 客戶端(開發者工具) ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...