使用 Node.js 開發簡單的腳手架工具

像我們熟悉的 vue-cli,react-native-cli 等腳手架,只需要輸入簡單的命令 vue init webpack project,即可快速幫我們生成一個初始項目。在實際工作中,我們可以定制一個屬于自己的腳手架,來提高自己的工作效率。

為什么需要需要腳手架?

????●????減少重復性的工作,不再需要復制其他項目再刪除無關代碼,或者從零創建一個項目和文件。

????●????根據交互動態生成項目結構和配置文件等。

????●????多人協作更為方便,不需要把文件傳來傳去。

思路

要開發腳手架,首先要理清思路,腳手架是如何工作的?我們可以借鑒 vue-cli 的基本思路。vue-cli 是將項目模板放在 git 上,運行的時候再根據用戶交互下載不同的模板,經過模板引擎渲染出來,生成項目。這樣將模板和腳手架分離,就可以各自維護,即使模板有變動,只需要上傳最新的模板即可,而不需要用戶去更新腳手架就可以生成最新的項目。那么就可以按照這個思路來進行開發了。

第三方庫

首先來看看會用到哪些庫。

????●????commander.js,可以自動的解析命令和參數,用于處理用戶輸入的命令。

????●????download-git-repo,下載并提取 git 倉庫,用于下載項目模板。

????●????Inquirer.js,通用的命令行用戶界面集合,用于和用戶進行交互。

????●????handlebars.js,模板引擎,將用戶提交的信息動態填充到文件中。

????●????ora,下載過程久的話,可以用于顯示下載中的動畫效果。

????●????chalk,可以給終端的字體加上顏色。

????●????log-symbols,可以在終端上顯示出 √ 或 × 等的圖標。

初始化項目

首先創建一個空項目,暫時命名為 okii-cli,然后新建一個 index.js 文件,再執行 npm init 生成一個 package.json 文件。最后安裝上面需要用到的依賴。

初始化項目

處理命令行

node.js 內置了對命令行操作的支持,在 package.json 中的 bin 字段可以定義命令名和關聯的執行文件。所以現在 package.json 中加上 bin 的內容:

處理命令行

然后在 index.js 中來定義 init 命令:

處理命令行

調用 version('1.0.0', '-v, --version') 會將 -v 和 –version 添加到命令中,可以通過這些選項打印出版本號。

調用 command('init ') 定義 init 命令,name 則是必傳的參數,為項目名。

action() 則是執行 init 命令會發生的行為,要生成項目的過程就是在這里面執行的,這里暫時只打印出 name。

其實到這里,已經可以執行 init 命令了。我們來測試一下,在 okii-cli 的同級目錄下執行:

處理命令行

可以看到命令行工具也打印出了 HelloWorld,那么很清楚, action((name) => {}) 這里的參數 name,就是我們執行 init 命令時輸入的項目名稱。

命令已經完成,接下來就要下載模板生成項目結構了。

下載模板

download-git-repo 支持從 Github、Gitlab 和 Bitbucket 下載倉庫,各自的具體用法可以參考官方文檔。

由于是公司項目,所以把模板倉庫放在了 Gitlab 上,那么在 action() 中進行操作下載模板:

下載模板

download() 第一個參數就是倉庫地址,但是有一點點不一樣。實際的倉庫地址是 http://xxxxxx:9999/HTML5/H5Template#master ,可以看到端口號后面的 ‘/‘ 在參數中要寫成 ‘:’,#master 代表的就是分支名,不同的模板可以放在不同的分支中,更改分支便可以實現下載不同的模板文件了。第二個參數是路徑,上面我們直接在當前路徑下創建一個 name 的文件夾存放模板,也可以使用二級目錄比如 test/${name}

命令行交互

命令行交互功能可以在用戶執行 init 命令后,向用戶提出問題,接收用戶的輸入并作出相應的處理。這里使用 inquirer.js 來實現。


命令行交互

通過這里例子可以看出,問題就放在 prompt() 中,問題的類型為 input 就是輸入類型,name 就是作為答案對象中的 key,message 就是問題了,用戶輸入的答案就在 answers 中,使用起來就是這么簡單。更多的參數設置可以參考官方文檔。

通過命令行交互,獲得用戶的輸入,從而可以把答案渲染到模板中。

渲染模板

這里用 handlebars 的語法對 HTML5/H5Template 倉庫的模板中的 package.json 文件做一些修改


渲染模板

并在下載模板完成之后將用戶輸入的答案渲染到 package.json 中


渲染模板

這里使用了 node.js 的文件模塊 fs,將 handlebars 渲染完后的模板重新寫入到文件中。

視覺美化

在用戶輸入答案之后,開始下載模板,這時候使用 ora 來提示用戶正在下載中。

視覺美化

然后通過 chalk 來為打印信息加上樣式,比如成功信息為綠色,失敗信息為紅色,這樣子會讓用戶更加容易分辨,同時也讓終端的顯示更加的好看。

視覺美化

除了給打印信息加上顏色之外,還可以使用 log-symbols 在信息前面加上 √ 或 × 等的圖標

視覺美化

完整示例

完整實例

效果如下:


效果

完成之后,就可以把腳手架發布到 npm 上面,通過 -g 進行全局安裝,就可以在自己本機上執行 okii init [name] 來初始化項目,這樣便完成了一個簡單的腳手架工具了。

?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,663評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,125評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,506評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,614評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,402評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,934評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,021評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,168評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,690評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,596評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,784評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,288評論 5 357
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,027評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,404評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,662評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,398評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,743評論 2 370

推薦閱讀更多精彩內容