這篇文章主要介紹了詳解使用 Node.js 開(kāi)發(fā)簡(jiǎn)單的腳手架工具狼速，小編覺(jué)得挺不錯(cuò)的骂倘，現(xiàn)在分享給大家变姨，也給大家做個(gè)參考盖矫。一起跟隨小編過(guò)來(lái)看看吧
前言
像我們熟悉的 vue-cli，react-native-cli 等腳手架务蝠，只需要輸入簡(jiǎn)單的命令 vue init webpack project拍谐，即可快速幫我們生成一個(gè)初始項(xiàng)目。在實(shí)際工作中馏段，我們可以定制一個(gè)屬于自己的腳手架轩拨，來(lái)提高自己的工作效率。
為什么需要需要腳手架院喜？
- 減少重復(fù)性的工作气嫁，不再需要復(fù)制其他項(xiàng)目再刪除無(wú)關(guān)代碼，或者從零創(chuàng)建一個(gè)項(xiàng)目和文件够坐。
- 根據(jù)交互動(dòng)態(tài)生成項(xiàng)目結(jié)構(gòu)和配置文件等寸宵。
- 多人協(xié)作更為方便，不需要把文件傳來(lái)傳去元咙。
思路
要開(kāi)發(fā)腳手架梯影，首先要理清思路，腳手架是如何工作的庶香？我們可以借鑒 vue-cli 的基本思路甲棍。vue-cli 是將項(xiàng)目模板放在 git 上，運(yùn)行的時(shí)候再根據(jù)用戶交互下載不同的模板赶掖，經(jīng)過(guò)模板引擎渲染出來(lái)感猛，生成項(xiàng)目七扰。這樣將模板和腳手架分離，就可以各自維護(hù)陪白，即使模板有變動(dòng)颈走，只需要上傳最新的模板即可，而不需要用戶去更新腳手架就可以生成最新的項(xiàng)目咱士。那么就可以按照這個(gè)思路來(lái)進(jìn)行開(kāi)發(fā)了立由。
第三方庫(kù)
首先來(lái)看看會(huì)用到哪些庫(kù)。
commander.js序厉，可以自動(dòng)的解析命令和參數(shù)锐膜，用于處理用戶輸入的命令。
download-git-repo弛房，下載并提取 git 倉(cāng)庫(kù)道盏，用于下載項(xiàng)目模板。
Inquirer.js文捶，通用的命令行用戶界面集合荷逞，用于和用戶進(jìn)行交互。
handlebars.js拄轻，模板引擎，將用戶提交的信息動(dòng)態(tài)填充到文件中伟葫。
ora恨搓，下載過(guò)程久的話，可以用于顯示下載中的動(dòng)畫(huà)效果筏养。
chalk斧抱，可以給終端的字體加上顏色。
log-symbols渐溶，可以在終端上顯示出 √ 或 × 等的圖標(biāo)辉浦。
初始化項(xiàng)目
首先創(chuàng)建一個(gè)空項(xiàng)目，暫時(shí)命名為 okii-cli茎辐，然后新建一個(gè) index.js 文件宪郊，再執(zhí)行 npm init 生成一個(gè) package.json 文件。最后安裝上面需要用到的依賴拖陆。
代碼如下:
npm install commander download-git-repo inquirer handlebars ora chalk log-symbols -S
處理命令行
node.js 內(nèi)置了對(duì)命令行操作的支持弛槐，在 package.json 中的 bin 字段可以定義命令名和關(guān)聯(lián)的執(zhí)行文件。所以現(xiàn)在
package.json 中加上 bin 的內(nèi)容：
{
"name": "okii-cli",
"version": "1.0.0",
"description": "基于node的腳手架工具",
"bin": {
"okii": "index.js"
},
</pre>
然后在 index.js 中來(lái)定義 init 命令：
/usr/bin/env node
const program = require('commander');
program.version('1.0.0', '-v, --version')
.command('init <name>')
.action((name) => {
console.log(name);
});
program.parse(process.argv);
</pre>
調(diào)用 version('1.0.0', '-v, --version') 會(huì)將 -v 和 --version 添加到命令中依啰，可以通過(guò)這些選項(xiàng)打印出版本號(hào)乎串。
調(diào)用 command('init <name>') 定義 init 命令，name 則是必傳的參數(shù)速警，為項(xiàng)目名叹誉。
action() 則是執(zhí)行 init 命令會(huì)發(fā)生的行為鸯两，要生成項(xiàng)目的過(guò)程就是在這里面執(zhí)行的，這里暫時(shí)只打印出 name长豁。
其實(shí)到這里钧唐，已經(jīng)可以執(zhí)行 init 命令了。我們來(lái)測(cè)試一下蕉斜，在 okii-cli 的同級(jí)目錄下執(zhí)行：
node ./okii-cli/index.js init HelloWorld
可以看到命令行工具也打印出了 HelloWorld逾柿，那么很清楚， action((name) => {}) 這里的參數(shù) name宅此，就是我們執(zhí)行 init 命令時(shí)輸入的項(xiàng)目名稱机错。
命令已經(jīng)完成，接下來(lái)就要下載模板生成項(xiàng)目結(jié)構(gòu)了父腕。
下載模板
download-git-repo 支持從 Github弱匪、Gitlab 和 Bitbucket 下載倉(cāng)庫(kù)，各自的具體用法可以參考官方文檔璧亮。
由于是公司項(xiàng)目萧诫，所以把模板倉(cāng)庫(kù)放在了 Gitlab 上，那么在 action() 中進(jìn)行操作下載模板：
/usr/bin/env node
const program = require('commander');
const download = require('download-git-repo');
program.version('1.0.0', '-v, --version')
.command('init <name>')
.action((name) => {
download('http://xxxxxx:9999:HTML5/H5Template#master', name, {clone: true}, (err) => {
console.log(err ? 'Error' : 'Success')
})
});
program.parse(process.argv);
</pre>
download() 第一個(gè)參數(shù)就是倉(cāng)庫(kù)地址枝嘶，但是有一點(diǎn)點(diǎn)不一樣帘饶。實(shí)際的倉(cāng)庫(kù)地址是 http://xxxxxx:9999/HTML5/H5Template#master ，可以看到端口號(hào)后面的 '/' 在參數(shù)中要寫(xiě)成 ':'群扶，#master 代表的就是分支名及刻，不同的模板可以放在不同的分支中，更改分支便可以實(shí)現(xiàn)下載不同的模板文件了竞阐。第二個(gè)參數(shù)是路徑缴饭，上面我們直接在當(dāng)前路徑下創(chuàng)建一個(gè) name 的文件夾存放模板，也可以使用二級(jí)目錄比如 test/${name}
命令行交互
命令行交互功能可以在用戶執(zhí)行 init 命令后骆莹，向用戶提出問(wèn)題颗搂，接收用戶的輸入并作出相應(yīng)的處理。這里使用 inquirer.js 來(lái)實(shí)現(xiàn)幕垦。
const inquirer = require('inquirer');
inquirer.prompt([
{
type: 'input',
name: 'author',
message: '請(qǐng)輸入作者名稱'
}
]).then((answers) => {
console.log(answers.author);
})
</pre>
通過(guò)這里例子可以看出丢氢，問(wèn)題就放在 prompt() 中，問(wèn)題的類(lèi)型為 input 就是輸入類(lèi)型先改，name 就是作為答案對(duì)象中的 key卖丸，message 就是問(wèn)題了，用戶輸入的答案就在 answers 中盏道，使用起來(lái)就是這么簡(jiǎn)單稍浆。更多的參數(shù)設(shè)置可以參考官方文檔。
通過(guò)命令行交互，獲得用戶的輸入衅枫，從而可以把答案渲染到模板中嫁艇。
渲染模板
這里用 handlebars 的語(yǔ)法對(duì) HTML5/H5Template 倉(cāng)庫(kù)的模板中的 package.json 文件做一些修改
{
"name": "{{name}}",
"version": "1.0.0",
"description": "{{description}}",
"scripts": {
"test": "echo "Error: no test specified" && exit 1"
},
"author": "{{author}}",
"license": "ISC"
}
</pre>
并在下載模板完成之后將用戶輸入的答案渲染到 package.json 中
program.version('1.0.0', '-v, --version')
.command('init <name>')
.action((name) => {
inquirer.prompt([
{
name: 'description',
message: '請(qǐng)輸入項(xiàng)目描述'
},
{
name: 'author',
message: '請(qǐng)輸入作者名稱'
}
]).then((answers) => {
download('xxxxx#master',name,{clone: true},(err) => {
const meta = {
name,
description: answers.description,
author: answers.author
}
const fileName = `${name}/package.json`;
const content = fs.readFileSync(fileName).toString();
const result = handlebars.compile(content)(meta);
fs.writeFileSync(fileName, result);
})
})
});
</pre>
這里使用了 node.js 的文件模塊 fs，將 handlebars 渲染完后的模板重新寫(xiě)入到文件中弦撩。
視覺(jué)美化
在用戶輸入答案之后步咪，開(kāi)始下載模板，這時(shí)候使用 ora 來(lái)提示用戶正在下載中益楼。
const ora = require('ora');
// 開(kāi)始下載
const spinner = ora('正在下載模板...');
spinner.start();
// 下載失敗調(diào)用
spinner.fail();
// 下載成功調(diào)用
spinner.succeed();
</pre>
然后通過(guò) chalk 來(lái)為打印信息加上樣式猾漫，比如成功信息為綠色，失敗信息為紅色感凤，這樣子會(huì)讓用戶更加容易分辨悯周，同時(shí)也讓終端的顯示更加的好看。
const chalk = require('chalk');
console.log(chalk.green('項(xiàng)目創(chuàng)建成功'));
console.log(chalk.red('項(xiàng)目創(chuàng)建失敗'));
</pre>
除了給打印信息加上顏色之外陪竿，還可以使用 log-symbols 在信息前面加上 √ 或 × 等的圖標(biāo)
const chalk = require('chalk');
const symbols = require('log-symbols');
console.log(symbols.success, chalk.green('項(xiàng)目創(chuàng)建成功'));
console.log(symbols.error, chalk.red('項(xiàng)目創(chuàng)建失敗'));
</pre>
完整示例
#!/usr/bin/env node
const fs = require('fs');
const program = require('commander');
const download = require('download-git-repo');
const handlebars = require('handlebars');
const inquirer = require('inquirer');
const ora = require('ora');
const chalk = require('chalk');
const symbols = require('log-symbols');
program.version('1.0.0', '-v, --version')
.command('init <name>')
.action((name) => {
if(!fs.existsSync(name)){
inquirer.prompt([
{
name: 'description',
message: '請(qǐng)輸入項(xiàng)目描述'
},
{
name: 'author',
message: '請(qǐng)輸入作者名稱'
}
]).then((answers) => {
const spinner = ora('正在下載模板...');
spinner.start();
download('http://xxxxxx:9999:HTML5/H5Template#master', name, {clone: true}, (err) => {
if(err){
spinner.fail();
console.log(symbols.error, chalk.red(err));
}else{
spinner.succeed();
const fileName = `${name}/package.json`;
const meta = {
name,
description: answers.description,
author: answers.author
}
if(fs.existsSync(fileName)){
const content = fs.readFileSync(fileName).toString();
const result = handlebars.compile(content)(meta);
fs.writeFileSync(fileName, result);
}
console.log(symbols.success, chalk.green('項(xiàng)目初始化完成'));
}
})
})
}else{
</pre>
// 錯(cuò)誤提示項(xiàng)目已存在禽翼，避免覆蓋原有項(xiàng)目
console.log(symbols.error, chalk.red('項(xiàng)目已存在'));
}
})
program.parse(process.argv);
</pre>
效果如下：
完成之后，就可以把腳手架發(fā)布到 npm 上面族跛，通過(guò) -g 進(jìn)行全局安裝闰挡，就可以在自己本機(jī)上執(zhí)行 okii init [name] 來(lái)初始化項(xiàng)目，這樣便完成了一個(gè)簡(jiǎn)單的腳手架工具了礁哄。
以上就是本文的全部?jī)?nèi)容长酗，希望對(duì)大家的學(xué)習(xí)有所幫助，
`
