一統江湖的大前端(6)commander.js + inquirer.js——懶,才是第一生產力
《一統江湖的大前端》系列是自己的前端學習筆記,旨在介紹javascript在非網頁開發領域的應用案例和發現各類好玩的js庫,不定期更新。如果你對前端的理解還是寫寫頁面綁綁事件,那你真的是有點OUT了,前端能做的事情已經太多了,
手機app開發
,桌面應用開發
,用於神經網路人工智慧的庫
,頁面遊戲
,資料視覺化
, 甚至嵌入式開發
,什麼火就搞什麼,活脫脫一個蹭熱點小能手。如果你也覺得前端的日常開發有些枯燥,不妨一起來看看前端的另一番模樣。
一.[懶]——才是第一生產力
你沒有看錯,懶絕壁是第一生產力,技術的進步,很多時候都是因為一些非常聰明的人難以忍受一些(在他們眼裡)枯燥重複且低效的東西,從而發明出的東西,無論這些新發明在經歷了迭代和打磨之後看起來多麼牛逼耀眼,但其本質基本都可以歸納為:
是聰明的懶人搞出的可以讓自己更省事的東西。
- jQuery的流行,是因為開發者懶得為DOM編寫跨瀏覽器相容性程式碼
- Angular.js的流行, 是因為開發者連DOM都懶得操作
- Bootstrap的流行, 是因為開發者懶得編寫自適應樣式
- Webpack的流行, 是因為開發者懶得做一系列上線前的準備工作 ......
有的人越懶越牛逼,有的人越懶越逗逼,看來懶也是個技術活,懶出高度,懶出藝術,那才是真的高階懶。
二.從GUI到CLI
GUI
(Grapic User Interface,即圖形化使用者介面)和CLI
(Command Line Interface,即命令列互動介面)都有其擁護者。 大家都懶,只是對懶的認知不同,用GUI
的人懶得去記命令,用CLI
的人懶得去挪滑鼠。
很多前端童鞋都通過視覺化工具小烏龜
來管理git
程式碼倉庫,視覺化工具的好處在於可以讓初學者可以更直觀更容易地去管理程式碼。
但是筆者發現很多熟練的開發者都更喜歡使用命令列工具(以下簡稱Cli工具),不僅因為Cli工具可以滿足裝X需求,更是因為它可以幫你省掉很多繁瑣的移動滑鼠和點選的動作。
有時候你並不需要去記憶很多指令和引數(當然用的次數多了,你不想記也記住了),幾乎所有的命令列工具只要簡單滴使用-h
或--help
引數就可以打印出幫助檔案,你完全可以邊學邊用,逐步熟悉。
很多熟悉Vue
的同學都使用過vue-cli
命令列工具來初始化一個Vue專案,如下圖所示,通過嚮導式問答收集關鍵引數資訊,然後自動生成相應的工程檔案,比你自己各種新建檔案和新建資料夾效率高多了。
接下來,請跟隨筆者一起,看看一個前端開發人員如何從零開始打造一款屬於自己的cli
工具吧~
三.相關知識儲備
1.前提條件 你需要一些Node.js的API知識和一些基本的命令列使用經驗。詳細的文件可以訪問NodeJs官方API獲取更多資訊。
2.readline
readline
工具包用於逐行處理資訊,常用的API包括:
- createInterface 用於建立介面例項,成功呼叫後返回一個介面例項,呼叫後使用方法如下:
var rl = readline.createInterface({
input: process.stdin,
output: process.stdout
});
- rl.question(query, callback) 例項方法,提供一個問答式單行互動方法,向用戶展示提示資訊,然後接受並處理使用者輸入,呼叫方法如下:
rl.question('你學會怎麼用了嗎?',function(input){
console.log('你輸入了:',input);
})
- rl.write(info)
例項方法,向建立rl介面例項時連線的output輸出流輸出資訊,通常使用主程序輸出流
process.stdout
,呼叫方法如下:
rl.write('我是這樣用的');
做個Demo輕鬆一下(demo的原始碼請在附件拿):
3.child_process child_process包提供了利用子程序執行命令或呼叫檔案的能力,常用的API包括:
- child_process.spawn() 實際執行方法,其他方法均為基於此方法的封裝,使用方式如下:
const { spawn } = require('child_process');
const ls = spawn('ls', ['-lh', '/usr']);
ls.stdout.on('data', (data) => {
console.log(`stdout: ${data}`);
});
ls.stderr.on('data', (data) => {
console.log(`stderr: ${data}`);
});
ls.on('close', (code) => {
console.log(`child process exited with code ${code}`);
});
- child_process.exec(), child_process.execFile()及同名的同步方法
均是對
spawn
方法一定程度上的封裝,使用更方便。
再來個Demo輕鬆一下,通過在windows命令列工具中執行js檔案,執行了dir
命令(demo的原始碼請在附件拿):
ps:亂碼的問題涉及到子程序和主程序通訊時的資訊的編碼和解碼問題,遇到實際問題的童鞋可以瞭解一下iconv-lite
這個外掛.
四.guide風格命令列開發工具——inquirer.js
github地址為:Inquirer.js地址
guide風格的命令列,指提問-回答模式的命令列,inquirer.js
支援常見的input輸入
,單選
,多選
,是/否
等常見提問型別,並暴露了增加自定義型別的介面,參考官方文件很容易使用。
API使用舉例:
const questions = [];
inquirer
.prompt(
/* Pass your questions in here */
[{
type: 'confirm',
name: 'toBeDelivered',
message: 'Is this for delivery?',
default: false
}]
)
.then(answers => {
// Use user feedback for... whatever!!
});
來看看官方提供的一個Pizza訂購工具pizza.js
的效果(是不是有vue-cli的既視感~~~):
五.git風格命令列開發工具——commander.js
github地址為:Commander.js地址 git風格命令列,是指通過主指令+子指令+引數的模式執行命令實現功能,和guide風格命令列沒有本質區別,只是使用習慣的偏好。 API使用舉例:
program
.version('0.0.1')
.description('An application for pizzas ordering')
.option('-p, --peppers', 'Add peppers')
.option('-P, --pineapple', 'Add pineapple')
.option('-b, --bbq', 'Add bbq sauce')
.option('-c, --cheese <type>', 'Add the specified type of cheese [marble]')
.option('-C, --no-cheese', 'You do not want any cheese')
.parse(process.argv);
來看看官方提供的這個Pizza訂購工具pizza.js
的效果(老外是有多喜歡吃Pizza!!!):
六.不同風格的實現思路
1.基本架構
- web版本
- 前端使用任意框架製作,點選某功能按鈕時,向後端傳送帶參請求
- 後端為node伺服器,監聽指定埠,接收到客戶端請求後,呼叫具體功能
- 根據後端執行情況資訊在前端展示的實時性要求,選擇長連線或普通連線
- 後端使用
child_process
或相關類庫實現命令並將資訊傳輸至前端
- Guide風格命令列
- 直接使用
inquirer.js
庫編寫問題組或分支問題樹 inquirer.js
最終將使用者輸入繫結在一個物件上- 使用
inquirer.js
收集到的引數 - 帶引數執行命令或指令碼
- 直接使用
- git風格命令列
- 直接使用
commander.js
庫的API編寫支援的指令 commander.js
會從註冊的命令及子命令中尋找匹配- 使用
commander.js
收集到的引數執行對應的命令或指令碼
- 直接使用
2.其他問題
- 相容性
- 使用多種指令碼格式
為了相容不同執行環境,可以為實際需要執行的命令準備
.bat
和.sh
兩套指令碼,在node.js程式碼中根據process.platform
查詢當前系統環境並呼叫對應格式的指令碼 - 使用相容性外掛庫
例如《一統江湖的大前端(4)——Shell.js》中提及的
shell.js
庫,可將自動化指令碼重構為js版本程式碼,實現跨平臺執行。
- 使用多種指令碼格式
為了相容不同執行環境,可以為實際需要執行的命令準備
- 全域性執行命令
- 開發版本
開發版本的程式,可以在程式碼根目錄中使用
npm link
將其註冊為全域性安裝,當開發完畢正式釋出後,使用npm unlink
去除連線即可。 - 釋出版本
當node包開發完成並使用
publish
命令正式釋出以後,即可通過npm install -g XXX
或yarn global add XXX
直接從npm上下載並全域性安裝,然後即可全域性使用。
- 開發版本
開發版本的程式,可以在程式碼根目錄中使用
七.要什麼demo?直接搞實戰!
接下來我們在Windows環境下實現一個自動化指令碼,實現的功能主要包括:
- 1.刪除舊目錄
- 2.新建目錄
- 3.從遠端git倉庫指定分支下載程式碼
- 4.在本地建立新分支並
auto_download.js原始碼:
var child_process = require('child_process');
function execTask(issueNumber, openLocalhost) {
//示例中的自定義配置資訊從configJson物件中獲取
var originDir = configJson['專案資訊']['遠端倉庫地址'];
var originBranch = configJson['feature分支']['遠端分支名稱'];
var destDir = configJson['專案資訊']['本地倉庫地址'];
var projectName = configJson['專案資訊']['專案名稱'] + '_issue';
var devBranch = configJson['本地開發']['預設分支字首'] + issueNumber;
//執行下載指令碼
var issue_process = child_process.spawn('download_dev_branch.bat',
[destDir, projectName, originDir, originBranch, devBranch],
{
stdio : 'inherit'
});
//監聽標準輸出
issue_process.stdout
.on('exit', function (number) {
console.log(number);
console.log('感謝您使用Dash-Toolbox!')
});
}
execTask(12315, true);
自動化指令碼download_dev_branch.bat
原始碼:
@echo off
rem 當前指令碼用於將遠端倉庫的開發分支程式碼下載至指定的本地目錄並生成開發分支
rem %1 - 本地倉庫資料夾
rem %2 - 本地指定分支資料夾名
rem %3 - 遠端倉庫地址
rem %4 - 遠端開發分支名
rem %5 - 包含issue程式碼的本地分支
@echo on
cd %1
rmdir /s/q %2
mkdir %2 && cd %2
git init
git remote add origin %3
git fetch origin %4 :%5 --progress --no-tags
git checkout %5
exit(0)
使用方法:
在檔案目錄下開啟命令列cmd.exe
,輸入node auto_download
即可看到在對應的目錄下載了程式碼:
自動化指令碼的部分也可以採用
node
的File API
來實現。
八.後記
在學習了以上知識後,筆者決定開發一款命令列工具——Dash-Toolbox
。
其目的主要是:
在保密性要求較高所以不通外網的環境下,將常用的文件資源集中化,將常規的動作自動化。
在全域性環境下命令列中輸入dash
即可啟動Guide模式,輸入dash -h
類似命令即可支援Git模式,並已經制作了Web模式的首頁。來先睹為快感受一下:
其實是受夠了一次次花20秒鐘改程式碼,然後花20分鐘提交程式碼和釋出的過程,儘管程式碼提交後的流程已經打通了jenkins的自動化流程,但程式碼提交前的本地工作仍然是手動的,我真的只是懶而已。