構建屬于自己的CLI工具

前言

CLI,全稱是command-line interface,也就是命令行交互接口。無論是在前端還是后端,都可以用于在構建時通過命令快速生成項目或模板等。例如前端的vue-cli(Vue前端開發腳手架),后端的dva-cli(Ant Design后端開發腳手架)

需求

那么如何構建屬于自己的CLI工具呢,在項目開發時可以快速生成自己需要的代碼模板,去除重復工作,并且還可以為其他的開發者提供快速入門的使用呢?我們的具體需求如下:

1,通過執行命令,自動生成項目代碼模板
2,項目代碼模板可以自定義編輯
3,CLI可以通過軟件包形式分發,其他開發者可以簡單使用

思路

CLI其實可以理解成早先時候黑漆漆的C語言控制臺窗口,通過簡單的命令輸入,可以得到指定的輸出,那么為了滿足以上三點需求,使用NodeJS開發CLI是一個很好的選擇:

1,獲得用戶的輸入,并且根據相應的輸入,可以定制編程相應執行邏輯
2,模板代碼有兩種實現思路,一是采用代碼生成,二是分離靜態資源模板
3,使用包管理工具

準備工作

npm install commander --save
npm install git-clone --save
npm install shelljs --save

工具說明

1、commander

commander是目前很成熟的Node命令行交互接口實現工具,使用該工具可以很便捷很快速地實現第一點需求

2、git-clone

git-clone是一個很輕量的Node編寫的git clone封裝,可以很便捷很快速地從github上克隆執行項目模板。也就是說,我們將項目模板靜態存儲在github上,每當執行cli命令時,將其下載,這樣我們就很輕松地得到了項目代碼模板。另外,當需要改變項目模板代碼時,只需要修改github上的項目代碼就可以,cli工具無需修改

3、shelljs

shelljs同樣是一個很輕量的Node編寫的系統命令封裝,可以很便捷很快速地在Node代碼中使用系統命令。在本例中,因為從github上下載的項目代碼會帶有.git文件,需要使用rm命令將其刪除

構建說明

安裝完依賴包之后,我們只需要編寫一個文件的代碼:

#!/usr/bin/env node

const clone = require('git-clone')
const program = require('commander')
const shell = require('shelljs');
const log = require('tracer').colorConsole()


program
    .version('1.0.0')
    .description('xserver中間件應用模板工程的cli')
program
    .command('* <tpl> <project>')
    .action(function(tpl, project) {
        log.info('目前xserver-cli支持以下模板:')
        log.info('使用例子:x-cli x-express myproject')
        if (tpl && project) {
            let pwd = shell.pwd()
            log.info(`正在拉取模板代碼,下載位置:${pwd}/${project}/ ...`)
            clone(`https://github.com/cheneyweb/${tpl}.git`, pwd + `/${project}`, null, function() {
                shell.rm('-rf', pwd + `/${project}/.git`)
                log.info('模板工程建立完成')
            })
        } else {
            log.error('正確命令例子:x-cli x-express myproject')
        }
    })
program.parse(process.argv)

以上就是xserver-cli的源代碼,極為簡單,只有28行

使用說明

npm install xserver-cli -g
x-cli x-express myproject

執行完以上命令后,首先是安裝xserver-cli,然后是以x-express的項目代碼為模板,生成自定義項目myproject路徑位于當前執行命令的目錄下

Paste_Image.png

結語

是不是十分的簡單呢?原來CLI也沒有特別神秘的地方嘛,我們也可以制作屬于
自己的腳手架工具
另外,關于本文章中提到的xserver-cli工具,已經上傳到npm中,目前支持x-expressx-koa兩個項目模板代碼

關于x-expressx-koa,這是我構建的一個以中間件應用為基礎的組件化后端開發框架,分別基于express和koa框架,詳情可以了解如下傳送門:
XServer—全新組件化后端構建

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

推薦閱讀更多精彩內容