遥想四五年前，前端会用 webpack 配置项目，会搭建脚手架，就是架构师。哪里像现在卷的飞起，真是过去令人怀念
关于 webpack 搭建项目 点这里
接下来说说搭建脚手架
1、所依赖的三方
commander.js 可以自动的解析命令和参数，用于处理用户输入的命令。
download-git-repo 下载并提取 git 仓库，用于下载项目模板。
Inquirer.js 通用的命令行用户界面集合，用于和用户进行交互。
handlebars.js 模板引擎，将用户提交的信息动态填充到文件中。
ora 下载过程久的话，可以用于显示下载中的动画效果。
chalk 可以给终端的字体加上颜色。
og-symbols 可以在终端上显示出 √ 或 × 等的图标
fs 文件管理
2、开始上手
mkdir cli
cd cli
npm init
npm install commander download-git-repo inquirer handlebars ora chalk log-symbols fs -S
touch index.js
这里注意一下 三方库版本不同 引用方式有变化
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
#!/usr/bin/env node
import { program } from 'commander';
import fs from 'fs';
import chalk from 'chalk';
import symbols from 'log-symbols';
import ora from 'ora';
import inquirer from './lib/inquirer.js';
import download from './lib/download.js';
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 命令会发生的行为，要生成项目的过程就是在这里面执行的。
其实到这里，已经可以执行 init 命令了。我们来测试一下，在 lead-dream-cli 的同级目录下执行：
node index.js init HelloWorld
可以看到命令行工具也打印出了 HelloWorld，那么很清楚， action((name) => {}) 这里的参数 name，就是我们执行 init 命令时输入的项目名称。
这里我把 inquirer 和 download 抽离了，还有其他的暂时没讲到的第三方的引入先跳过
inquirer 使用
import inquirer from 'inquirer';
export default (cb) => {
inquirer.prompt([
{
name: 'description',
message: '请输入项目描述',
},
{
name: 'author',
message: '请输入作者名称',
},
]).then((answers) => {
cb(answers)
})}
其中 answers 是吧我们的如何做为 value , prompt 数组中的对象 name 做为 key ，打包成一个对象
{
description: '',
author: ''
}
download 使用
#!/usr/bin/env node
import download from 'download-git-repo';
import fs from 'fs';
import handlebars from 'handlebars';
export default (config, resolve, reject) => {
download('direct:https://github.com/PieDi/react-template.git#master',
config.name,
{ clone: true },
(err) => {
if (!err) {
const { name, answer } = config
const meta = {
name,
description: answer?.description || '',
author: answer?.author || ''
}
resolve(meta)
const fileName = `${name}/package.json`;
if (fs.existsSync(fileName)) {
const content = fs.readFileSync(fileName).toString();
const result = handlebars.compile(content)(meta);
fs.writeFileSync(fileName, result);
}
} else {
reject(err)
}
}
)}
第一个参数就是仓库地址，第二个参数是路径，上面我们直接在当前路径下创建一个 name 的文件夹存放模板，也可以使用二级目录比如 test/${name}
注意 仓库地址前 direct 以及后面 #master 代表指定分支
上面用 **handlebars** 的语法对仓库的模板中的 **package.json** 文件做一些修改。
{
"name": "{{name}}",
"version": "1.0.0",
"description": "{{description}}",
"scripts": {
"test": "echo "Error: no test specified" && exit 1"
},
"author": "{{author}}",
"license": "ISC"
}
视觉提示
import ora from 'ora';// 开始下载
const spinner = ora('正在下载模板...');
spinner.start();
// 下载失败调用
spinner.fail();
// 下载成功调用
spinner.succeed();
然后通过 chalk 来为打印信息加上样式，比如成功信息为绿色，失败信息为红色，这样子会让用户更加容易分辨，同时也让终端的显示更加的好看。
除了给打印信息加上颜色之外，还可以使用 log-symbols 在信息前面加上 √ 或 × 等的图标
import chalk from 'chalk';import symbols from 'log-symbols';
console.log(chalk.green('项目创建成功'));
console.log(chalk.red('项目创建失败'));
console.log(symbols.success, chalk.green('项目创建成功'));
console.log(symbols.error, chalk.red('项目创建失败'));
完整示例
#!/usr/bin/env node
import { program } from 'commander';
import fs from 'fs';
import chalk from 'chalk';
import symbols from 'log-symbols';
import ora from 'ora';
import inquirer from './lib/inquirer.js';
import download from './lib/download.js';
program.version('1.0.0', '-v, --version')
.command('init name')
.action((name) => {
if (!fs.existsSync(name)) {
inquirer((answer) => {
const spinner = ora('正在下载模板...');
spinner.start();
download({ name, answer }, (success) => {
spinner.succeed();
console.log(symbols.success, chalk.green('项目初始化完成'));
}, (error) => {
spinner.fail();
console.log(symbols.error, chalk.red(error));
})
})
} else {
// 项目存在
console.log(symbols.error, chalk.red('项目已存在'));
}
})
program.parse(process.argv)
