Node.js搭建前后端脚手架
1.1 为什么需要脚手架
- 减少重复性的工作，从零创建一个项目和文件。
- 根据交互动态生成项目结构和配置文件等。
- 多人协作更为方便，不需要把文件传来传去。
1.2 第三方工具
commander.js 可以自动的解析命令和参数，用于处理用户输入的命令。
download-git-repo 下载并提取 git 仓库，用于下载项目模板。
Inquirer.js 通用的命令行用户界面集合，用于和用户进行交互。
handlebars.js 模板引擎，将用户提交的信息动态填充到文件中。
ora 下载过程久的话，可以用于显示下载中的动画效果。
chalk 可以给终端的字体加上颜色。
og-symbols 可以在终端上显示出 √ 或 × 等的图标
2. 开始上手
mkdir lead-dream-cli
npm init
# 理论上是执行下面的命令即可自动配置package.json文件，但下载的却是最新的依赖，所以需要手动配置package.json文件
npm install commander download-git-repo inquirer handlebars ora chalk log-symbols -S
2.1 手动配置package.json 文件
// 配置好后执行命令: npm install
"dependencies": {
"chalk": "^2.4.1",
"commander": "^9.5.0",
"download-git-repo": "^3.0.2",
"fs": "^0.0.1-security",
"handlebars": "3.0.8",
"inquirer": "^8.2.5",
"log-symbols": "^2.2.0",
"ora": "^3.0.0"
}
node.js内置了对命令行操作的支持，在 package.json 中的 bin 字段可以定义命令名和关联的执行文件。
// 添加如下内容，其中index.js代表的你的执行文件，也有叫做command.js的
"bin": {
"lead-dream-cli": "./index.js"
},
# 命令可以将一个任意位置的 npm 包链接到全局执行环境，从而在任意位置使用命令行都可以直接运行该 npm 包。
npm link
# 取消链接
npm unlink lead-dream-cli
# 如果出现报错说有什么已存在某个包可以进到里面进行删除该包
然后在 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 命令了。我们来测试一下，在 lead-dream-cli 的同级目录下执行：
node ./index.js init HelloWorld
可以看到命令行工具也打印出了 HelloWorld，那么很清楚， action((name) => {}) 这里的参数 name，就是我们执行 init 命令时输入的项目名称。
命令已经完成，接下来就要下载模板生成项目结构了。
2.2 下载模板
download-git-repo 支持从 Github、Gitlab 和 Bitbucket 下载仓库，各自的具体用法可以参考官方文档。
#!/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('direct:https://github.com/dualseason/Project_koa.git', name, {clone: true}, (err) => {
console.log(err ? 'Error' : 'Success')
})
});
program.parse(process.argv);
当然也可以把下载地址写成https://github.com:dualseason/Project_koa.git#master
download() 第一个参数就是仓库地址，但是有一点点不一样。实际的仓库地址是https://github.com/dualseason/Project_koa.git，可以看到端口号后面的 '/' 在参数中要写成 ':'，#master 代表的就是分支名，不同的模板可以放在不同的分支中，更改分支便可以实现下载不同的模板文件了。第二个参数是路径，上面我们直接在当前路径下创建一个 name 的文件夹存放模板，也可以使用二级目录比如 test/${name}
2.3 命令行交互
命令行交互功能可以在用户执行 init 命令后，向用户提出问题，接收用户的输入并作出相应的处理。这里使用 inquirer.js 来实现。
const inquirer = require('inquirer');
inquirer.prompt([
{
type: 'input',
name: 'author',
message: '请输入作者名称'
}
]).then((answers) => {
console.log(answers.author);
});
通过这里例子可以看出，问题就放在 prompt() 中，问题的类型为 input就是输入类型，name 就是作为答案对象中的 key，message 就是问题了，用户输入的答案就在 answers 中，使用起来就是这么简单，通过命令行交互，获得用户的输入，从而可以把答案渲染到模板中。
2.4 渲染模板
这里用 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 中
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);
})
})
});
这里使用了node.js的文件模块 fs，将 handlebars 渲染完后的模板重新写入到文件中。
2.5 视觉美化
在用户输入答案之后，开始下载模板，这时候使用 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('项目创建失败'));
2.6 完整示例
#!/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('direct:https://github.com/dualseason/Project_koa.git', 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{
// 错误提示项目已存在，避免覆盖原有项目
console.log(symbols.error, chalk.red('项目已存在'));
}
})
program.parse(process.argv);
