這篇文章主要介紹了詳解使用 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 檔案。最後安裝上面需要用到的依賴。

程式碼如下:

npm install commander download-git-repo inquirer handlebars ora chalk log-symbols -S

處理命令列

node.js 內建了對命令列操作的支援，在 package.json 中的 bin 欄位可以定義命令名和關聯的執行檔案。所以現在

package.json 中加上 bin 的內容：

{
 "name": "okii-cli",
 "version": "1.0.0",
 "description": "基於node的腳手架工具",
 "bin": {
 "okii": "index.js"
 },
</pre>
然後在 index.js 中來定義 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>

呼叫 version(‘1.0.0’, ‘-v, --version’) 會將 -v 和 --version 新增到命令中，可以通過這些選項打印出版本號。

呼叫 command('init ') 定義 init 命令，name 則是必傳的引數，為專案名。

action() 則是執行 init 命令會發生的行為，要生成專案的過程就是在這裡面執行的，這裡暫時只打印出 name。

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

node ./okii-cli/index.js init HelloWorld

可以看到命令列工具也打印出了 HelloWorld，那麼很清楚， action((name) => {}) 這裡的引數 name，就是我們執行 init 命令時輸入的專案名稱。

命令已經完成，接下來就要下載模板生成專案結構了。

下載模板

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

由於是公司專案，所以把模板倉庫放在了 Gitlab 上，那麼在 action() 中進行操作下載模板：

/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() 第一個引數就是倉庫地址，但是有一點點不一樣。實際的倉庫地址是 http://xxxxxx:9999/HTML5/H5Template#master ，可以看到埠號後面的 ‘/’ 在引數中要寫成 ‘:’，#master 代表的就是分支名，不同的模板可以放在不同的分支中，更改分支便可以實現下載不同的模板檔案了。第二個引數是路徑，上面我們直接在當前路徑下建立一個 name 的資料夾存放模板，也可以使用二級目錄比如 test/${name}

命令列互動

命令列互動功能可以在使用者執行 init 命令後，向用戶提出問題，接收使用者的輸入並作出相應的處理。這裡使用 inquirer.js 來實現。

const inquirer = require('inquirer');
inquirer.prompt([
 {
 type: 'input',
 name: 'author',
 message: '請輸入作者名稱'
 }
]).then((answers) => {
 console.log(answers.author);
})
</pre>

通過這裡例子可以看出，問題就放在 prompt() 中，問題的型別為 input 就是輸入型別，name 就是作為答案物件中的 key，message 就是問題了，使用者輸入的答案就在 answers 中，使用起來就是這麼簡單。更多的引數設定可以參考官方文件。

通過命令列互動，獲得使用者的輸入，從而可以把答案渲染到模板中。

渲染模板

這裡用 handlebars 的語法對 HTML5/H5Template 倉庫的模板中的 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: '請輸入專案描述'
 },
 {
 name: 'author',
 message: '請輸入作者名稱'
 }
 ]).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 渲染完後的模板重新寫入到檔案中。

視覺美化

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

const ora = require('ora');
// 開始下載
const spinner = ora('正在下載模板...');
spinner.start();

// 下載失敗呼叫
spinner.fail();

// 下載成功呼叫
spinner.succeed();
</pre>

然後通過 chalk 來為列印資訊加上樣式，比如成功資訊為綠色，失敗資訊為紅色，這樣子會讓使用者更加容易分辨，同時也讓終端的顯示更加的好看。

const chalk = require('chalk');
console.log(chalk.green('專案建立成功'));
console.log(chalk.red('專案建立失敗'));
</pre>
除了給列印資訊加上顏色之外，還可以使用 log-symbols 在資訊前面加上 √ 或 × 等的圖示

const chalk = require('chalk');
const symbols = require('log-symbols');
console.log(symbols.success, chalk.green('專案建立成功'));
console.log(symbols.error, chalk.red('專案建立失敗'));
</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: '請輸入專案描述'
 },
 {
 name: 'author',
 message: '請輸入作者名稱'
 }
 ]).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('專案初始化完成'));
 }
 })
 })
 }else{
</pre>

// 錯誤提示專案已存在，避免覆蓋原有專案

     console.log(symbols.error, chalk.red('專案已存在'));
     }
     })
    program.parse(process.argv);
    </pre>

效果如下：

完成之後，就可以把腳手架釋出到 npm 上面，通過 -g 進行全域性安裝，就可以在自己本機上執行 okii init [name] 來初始化專案，這樣便完成了一個簡單的腳手架工具了。

以上就是本文的全部內容，希望對大家的學習有所幫助，