開發一個 Parcel-vue 腳手架工具
前言
像我們熟悉的 vue-cli，create-react-app 等腳手架，只需要輸入簡單的命令 vue init webpack project，即可快速幫我們生成一個初始專案。在實際工作中，我們可以定製一個屬於自己的腳手架，來提高自己的工作效率。
為什麼需要需要腳手架？
- 減少重複性的工作，不再需要複製其他專案再刪除無關程式碼，或者從零建立一個專案和檔案。
- 根據互動動態生成專案結構和配置檔案等。
- 多人協作更為方便，不需要把檔案傳來傳去。
思路
要開發腳手架，首先要理清思路，腳手架是如何工作的？我們可以借鑑 vue-cli 的基本思路。vue-cli 是將專案模板放在 git 上，執行的時候再根據使用者互動下載不同的模板，經過模板引擎渲染出來，生成專案。這樣將模板和腳手架分離，就可以各自維護，即使模板有變動，只需要上傳最新的模板即可，而不需要使用者去更新腳手架就可以生成最新的專案。那麼就可以按照這個思路來進行開發了。
第三方庫
首先來看看會用到哪些庫。
- commander.js，可以自動的解析命令和引數，用於處理使用者輸入的命令。
- download-git-repo，下載並提取 git 倉庫，用於下載專案模板。
- Inquirer.js，通用的命令列使用者介面集合，用於和使用者進行互動。
- handlebars.js，模板引擎，將使用者提交的資訊動態填充到檔案中。
- ora，下載過程久的話，可以用於顯示下載中的動畫效果。
- chalk，可以給終端的字型加上顏色。
- log-symbols，可以在終端上顯示出 √ 或 × 等的圖示。
初始化專案
首先建立一個空專案，然後新建一個 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": "suporka-parcel-vue", "version": "1.0.0", "description": "a vue cli which use parcel to package object", "bin": { "suporka-parcel-vue": "index.js" }, ... }
然後在 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);呼叫 version('1.0.0', '-v, --version') 會將 -v 和 --version 新增到命令中，可以通過這些選項打印出版本號。呼叫 command('init <name>') 定義 init 命令，name 則是必傳的引數，為專案名。action() 則是執行 init 命令會發生的行為，要生成專案的過程就是在這裡面執行的，這裡暫時只打印出 name。其實到這裡，已經可以執行 init 命令了。我們來測試一下，在同級目錄下執行：
node index.js init HelloWorld可以看到命令列工具也打印出了 HelloWorld，那麼很清楚， action((name) => {}) 這裡的引數 name，就是我們執行 init 命令時輸入的專案名稱。
命令已經完成，接下來就要下載模板生成專案結構了。
下載模板
download-git-repo 支援從 Github、Gitlab 和 Bitbucket 下載倉庫，各自的具體用法可以參考官方文件。
命令列互動
命令列互動功能可以在使用者執行 init 命令後，向用戶提出問題，接收使用者的輸入並作出相應的處理。這裡使用 inquirer.js 來實現。
const inquirer = require('inquirer');
inquirer.prompt([
{
name: 'description',
message: 'Input the object description'
},
{
name: 'author',
message: 'Input the object author'
}
]).then((answers) => {
console.log(answers.author);
})
通過這裡例子可以看出，問題就放在 prompt() 中，問題的型別為 input 就是輸入型別，name 就是作為答案物件中的 key，message 就是問題了，使用者輸入的答案就在 answers 中，使用起來就是這麼簡單。更多的引數設定可以參考官方文件。
通過命令列互動，獲得使用者的輸入，從而可以把答案渲染到模板中。
渲染模板
這裡用 handlebars 的語法對模板中的 package.json 檔案做一些修改
{
"name": "{{name}}",
"version": "1.0.0",
"description": "{{description}}",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "{{author}}",
"license": "ISC"
}並在下載模板完成之後將使用者輸入的答案渲染到 package.json 中
視覺美化
在使用者輸入答案之後，開始下載模板，這時候使用 ora 來提示使用者正在下載中。
const ora = require('ora');
// 開始下載
const spinner = ora('正在下載模板...');
spinner.start();
// 下載失敗呼叫
spinner.fail();
// 下載成功呼叫
spinner.succeed();然後通過 chalk 來為列印資訊加上樣式，比如成功資訊為綠色，失敗資訊為紅色，這樣子會讓使用者更加容易分辨，同時也讓終端的顯示更加的好看。
const chalk = require('chalk');
console.log(chalk.green('專案建立成功'));
console.log(chalk.red('專案建立失敗'));除了給列印資訊加上顏色之外，還可以使用 log-symbols 在資訊前面加上 √ 或 × 等的圖示
const chalk = require('chalk');
const symbols = require('log-symbols');
console.log(symbols.success, chalk.green('專案建立成功'));
console.log(symbols.error, chalk.red('專案建立失敗'));完整示例
#!/usr/bin/env node
// 處理使用者輸入的命令
const program = require('commander');
// 下載模板
const download = require('download-git-repo');
// 問題互動
const inquirer = require('inquirer');
// node 檔案模組
const fs = require('fs');
// 填充資訊至檔案
const handlebars = require('handlebars');
// 動畫效果
const ora = require('ora');
// 字型加顏色
const chalk = require('chalk');
// 顯示提示圖示
const symbols = require('log-symbols');
// 命令列操作
var shell = require("shelljs");
program.version('1.0.1', '-v, --version')
.command('init <name>')
.action((name) => {
if (!fs.existsSync(name)) {
inquirer.prompt([
{
name: 'description',
message: 'Input the object description'
},
{
name: 'author',
message: 'Input the object author'
}
]).then((answers) => {
const spinner = ora('Downloading...');
spinner.start();
download('zxpsuper/suporka-parcel-vue', name, (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('The vue object has downloaded successfully!'));
inquirer.prompt([
{
type: 'confirm',
name: 'ifInstall',
message: 'Are you want to install dependence now?',
default: true
}
]).then((answers) => {
if (answers.ifInstall) {
inquirer.prompt([
{
type: 'list',
name: 'installWay',
message: 'Choose the tool to install',
choices: [
'npm', 'cnpm'
]
}
]).then(ans => {
if (ans.installWay === 'npm') {
let spinner = ora('Installing...');
spinner.start();
// 命令列操作安裝依賴
shell.exec("cd " + name + " && npm i", function (err, stdout, stderr) {
if (err) {
spinner.fail();
console.log(symbols.error, chalk.red(err));
}
else {
spinner.succeed();
console.log(symbols.success, chalk.green('The object has installed dependence successfully!'));
}
});
} else {
let spinner = ora('Installing...');
spinner.start();
shell.exec("cd " + name + " && cnpm i", function (err, stdout, stderr) {
if (err) {
spinner.fail();
console.log(symbols.error, chalk.red(err));
}
else {
spinner.succeed();
console.log(symbols.success, chalk.green('The object has installed dependence successfully!'));
}
})
}
})
} else {
console.log(symbols.success, chalk.green('You should install the dependence by yourself!'));
}
})
}
})
})
} else {
// 錯誤提示專案已存在，避免覆蓋原有專案
console.log(symbols.error, chalk.red('The object has exist'));
}
});
program.parse(process.argv);
以上是我寫的一個 suporka-parcel-vue 的腳手架原始碼，suporka-parcel-vue 點選即可檢視，歡迎star.