今年的 JSConf 大會上,受到 gridcontrol 作者現場開源項目的感染,我們也在現場宣布開源這套基於 Vue 2 開發的組件庫 —— Element。上場前五分鐘才建的空倉庫,到晚上我們真正推代碼上去已經收(pian)到了 100 多 star,而且僅僅三天時間就獲得了 1k star。這個項目其實早在 Vue 2 進入 beta 時就開始開發了,一直到八月底才接近尾聲。初期也遇到一些棘手的問題,很慶幸都找到了解決方案。在這裡整理一些解決方案分享給大家。
如何管理多個獨立的組件項目 -- lerna
最初制定的目標是有一個主項目管理所有的組件弄成一個包,然後每一個組件都是單獨一個包。這樣用戶可以安裝所有組件也可以只安裝自己需要的組件。於是我們最直接的做法就是一個組件建一個項目,到後面組件越來越多管理起來也越加複雜,每一次升級主倉庫就要更新一堆依賴組件的版本號。而且開發起來也不方便。
後來看到 babel 的倉庫的目錄結構很是奇特。一個 packages 文件夾下有所有的 babel 官方插件,直到發現他們用了一個叫 lerna 的工具。可以讓你在主項目下管理多個子項目,從而解決了多個包互相依賴,且發布時需要手動維護多個包的問題。
所以我們重構了目錄結構,所有插件單獨一個項目放在 packages 目錄下,可單獨打包發布;同時最外面的 src 目錄下的入口文件引入所有組件,打包發布的主項目就是包含了所有的組件。從而就解決了多個子項目管理的問題。
element/ package.json packages/ component-a/ package.json component-b/ package.json
如何解決定製多套主題的問題
組件庫一般都會自帶一套主題,也可能會有多套主題可供選擇,當然也要滿足用戶自定義的需求。所以 Vue 推薦的定義 scope 的樣式就不可行了,同時也不能把樣式寫在組件裡。那麼如何寫樣式同時單獨發布的組件如何引用樣式文件也是我們要解決的問題。
為了方便用戶覆蓋樣式,我們採用 BEM 風格來寫 CSS,這樣的好處是類名基本都是一級,少數才會有嵌套情況,這樣很容易的就可以直接覆蓋掉原有樣式。我們使用了自家開發的 postcss-salad PostCSS 插件來寫樣式。集成了多個實用的 PostCSS 插件同時也支持 BEM 風格。
並且樣式文件目錄也作為單獨一個子項目發布,這樣引入整個包可以包含樣式文件,單獨安裝的組件可以通過安裝主題包的方式引入樣式文件。
這麼做的好處是方便以後擴展其他主題,或者開發者可以自己定義一套其他 CSS 預處理的版本例如 Less 或 Scss。
文檔是如何工作的 -- vue-markdown-loader
當初寫 Mint UI 時就遇到了要用 Vue 寫文檔的問題:如何才能在寫 Markdown 時也能寫 Vue 組件的 Demo。雖然後來並沒有在 Mint UI 的文檔裡寫 Demo。最開始在 Element 的內部版本裡,找遍了各種 Vue 的 Markdown 相關插件,要麼是在 template 裡定義 Markdown 格式,要麼就是有一個 Markdown 的組件。都不能做到純粹的寫 Markdown 文件,並且還能寫 Demo。
後來想到或許可以嘗試把 Markdown 文件轉成 Vue 組件。畢竟可以在 Markdown 裡寫 HTML,那麼完全可以作為 Vue 的模板。後來就有了 vue-markdown-loader,一個把 Markdown 轉成 Vue 組件的 webpack loader,搭配 vue-router 就能搭建一個可以在 Markdown 裡寫 Vue 代碼的文檔網站。
如何同時打包多個組件 -- cooking
由於前面的設定,最終需要每個組件都單獨打包一份並發布。同時每一個組件下面都會有一個對應的配置文件,傳統的用 webpack 打包雖然支持傳入數組,但是並不能傳入多個文件。但是我們有 cooking,一個基於 webpack 但是配置更簡單同時使用上也更容易的工具。打包時只需要同時傳入多個配置文件,利用 webpack 接受數組配置項的特性,就能同時進行打包。
有了這些工具,讓 Element 的開發工作變得更容易且更高效。現在 Element 已經正式開源,並且我們已經放出了文檔,同時還放出了設計資源,歡迎各位 Vue 開發者來嘗試,也歡迎來做貢獻。
相關項目連結:
https://github.com/ElemeFE/element https://github.com/lerna/lerna https://github.com/ElemeFE/postcss-salad https://github.com/ElemeFE/mint-ui https://github.com/QingWei-Li/vue-markdown-loader https://github.com/ElemeFE/cooking
點讚 0