創(chuàng)建個人腳手架cli的步驟全記錄

參考文檔:https://www.jb51.net/article/159892.htm

1. 首先需要一個npm的賬號,這里不建議用個人賬號冗澈,注冊一個團(tuán)隊賬號

腳手架取名 much-cli:寓意許多腳手架群叶,希望前端和后端都能采用這個腳手架進(jìn)行架構(gòu)钻趋,實現(xiàn)單點維護(hù)邻寿,多點使用,同步升級等需求绽快。

2. 創(chuàng)建一個目錄 much-cli 在里面用npm進(jìn)行初始化
npm init

如果不知道如何設(shè)定直接敲回車

這里需要點前置知識碱屁,寫好腳手架會有一些必要的依賴需要了解

  • commander

這是用來編寫指令和處理命令行的,具體用法參考如下

const program = require("commander");
// 定義指令
program
 .version('0.0.1')
 .command('init', 'Generate a new project from a template')
 .action(() => {
   // 回調(diào)函數(shù)
 })
// 解析命令行參數(shù)
program.parse(process.argv);
  • inquirer

這是個強(qiáng)大的交互式命令行工具客年,具體用法參考如下

const inquirer = require('inquirer');
inquirer
 .prompt([
   // 一些交互式的問題
 ])
 .then(answers => {
   // 回調(diào)函數(shù)霞幅,answers 就是用戶輸入的內(nèi)容,是個對象
 });

想象一下我們用 vue init webpack project-name 之后是不是會有幾個交互問題量瓜,問你文件名啊司恳、作者啊、描述啊绍傲、要不要用 eslint 啊等等之類的扔傅,就是用這個來寫的。

  • chalk

這是用來修改控制臺輸出內(nèi)容樣式的烫饼,比如顏色啊铅鲤,具體用法如下:

const chalk = require('chalk');
console.log(chalk.green('success'));
console.log(chalk.red('error'));
  • ora

這是一個好看的加載,就是你下載的時候會有個轉(zhuǎn)圈圈的那種效果枫弟,用法如下:

const ora = require('ora')
let spinner = ora('downloading template ...')
spinner.start()
  • download-git-repo

看名字很明顯了邢享,這是用來下載遠(yuǎn)程模板的,支持 GitHub淡诗、 GitLab 和 Bitbucket 等骇塘,用法如下:

const download = require('download-git-repo')
download(repository, destination, options, callback)

其中 repository 是遠(yuǎn)程倉庫地址;destination 是存放下載的文件路徑韩容,也可以直接寫文件名款违,默認(rèn)就是當(dāng)前目錄;options 是一些選項群凶,比如 { clone:boolean } 表示用 http download 還是 git clone 的形式下載插爹。

3. 安裝依賴

有了以上知識之后就能先安裝一些依賴

npm install commander inquirer chalk ora download-git-repo

會自動安裝node依賴,并自動把版本寫入package.json里面

4. 開始編寫腳手架

新建一個 bin 文件夾请梢,并在 bin 目錄下新建一個無后綴名的 much 文件赠尾,并寫上:

//much文件
#!/usr/bin/env node
console.log('hello much');

這個文件就是我們整個腳手架的入口文件,我們用 node ./bin/xr 運行一下毅弧,就能在控制臺打印出 hello much

% node ./bin/much 
hello much
4.1 bin文件夾初始化

目前文件夾內(nèi)只有一個入口文件 much 气嫁,我們來編寫它,讓它實現(xiàn)簡單的命令功能

#!/usr/bin/env node

// console.log('hello much')
const Program = require('commander');
const _package = require('../package.json')

// 定義名字
// 定義版本
// 定義用法
// 定義幾個命令
Program
  .name(_package.name)
  .version(_package.version)
  .usage('<command> [options]')
  .command('add', '添加一個新模板')
  .command('delete', '刪除一個新模板')
  .command('list', '列出所有模板')
  .command('init', '從模板初始化一個新項目')

// 解析命令行參數(shù)
Program.parse(process.argv)

這個文件的作用就是用來定義指令够坐,現(xiàn)在我們用 node ./bin/much 來看下效果

% node ./bin/much
Usage: much-cli <command> [options]

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  add             添加一個新模板
  delete          刪除一個新模板
  list            列出所有模板
  init            從模板初始化一個新項目
  help [command]  display help for command

當(dāng)然如果覺得 node ./bin/much 這個命令太麻煩的話寸宵,可以在package.json中添加以下內(nèi)容

// bin 用來指定每個命令所對應(yīng)的可執(zhí)行文件的位置
"bin": {
  "much-cli": "/bin/much"
}
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末崖面,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子梯影,更是在濱河造成了極大的恐慌巫员,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,509評論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件甲棍,死亡現(xiàn)場離奇詭異疏遏,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)救军,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,806評論 3 394
  • 文/潘曉璐 我一進(jìn)店門财异,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人唱遭,你說我怎么就攤上這事戳寸。” “怎么了拷泽?”我有些...
    開封第一講書人閱讀 163,875評論 0 354
  • 文/不壞的土叔 我叫張陵疫鹊,是天一觀的道長。 經(jīng)常有香客問我司致,道長拆吆,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,441評論 1 293
  • 正文 為了忘掉前任脂矫,我火速辦了婚禮枣耀,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘庭再。我一直安慰自己捞奕,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,488評論 6 392
  • 文/花漫 我一把揭開白布拄轻。 她就那樣靜靜地躺著颅围,像睡著了一般。 火紅的嫁衣襯著肌膚如雪恨搓。 梳的紋絲不亂的頭發(fā)上院促,一...
    開封第一講書人閱讀 51,365評論 1 302
  • 那天,我揣著相機(jī)與錄音斧抱,去河邊找鬼常拓。 笑死,一個胖子當(dāng)著我的面吹牛夺姑,可吹牛的內(nèi)容都是我干的墩邀。 我是一名探鬼主播,決...
    沈念sama閱讀 40,190評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼盏浙,長吁一口氣:“原來是場噩夢啊……” “哼眉睹!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起废膘,我...
    開封第一講書人閱讀 39,062評論 0 276
  • 序言:老撾萬榮一對情侶失蹤竹海,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后丐黄,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體斋配,經(jīng)...
    沈念sama閱讀 45,500評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,706評論 3 335
  • 正文 我和宋清朗相戀三年灌闺,在試婚紗的時候發(fā)現(xiàn)自己被綠了艰争。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,834評論 1 347
  • 序言:一個原本活蹦亂跳的男人離奇死亡桂对,死狀恐怖甩卓,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情蕉斜,我是刑警寧澤逾柿,帶...
    沈念sama閱讀 35,559評論 5 345
  • 正文 年R本政府宣布,位于F島的核電站宅此,受9級特大地震影響机错,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜父腕,卻給世界環(huán)境...
    茶點故事閱讀 41,167評論 3 328
  • 文/蒙蒙 一弱匪、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧璧亮,春花似錦痢法、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,779評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至躬络,卻和暖如春尖奔,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背穷当。 一陣腳步聲響...
    開封第一講書人閱讀 32,912評論 1 269
  • 我被黑心中介騙來泰國打工提茁, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人馁菜。 一個月前我還...
    沈念sama閱讀 47,958評論 2 370
  • 正文 我出身青樓茴扁,卻偏偏與公主長得像,于是被迫代替她去往敵國和親汪疮。 傳聞我的和親對象是個殘疾皇子峭火,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,779評論 2 354

推薦閱讀更多精彩內(nèi)容