前言
像我們熟悉的 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);
npm publish
發佈你的項目即可。
以上是我寫的一個 suporka-parcel-vue 的腳手架源碼,suporka-parcel-vue 點擊即可查看,歡迎star.