@yeepay/yeepay-cli/README.md

易宝前端脚手架

# yeepay-cli

## 技术文档
[前端脚手架搭建技术方案](https://yeepay.feishu.cn/wiki/E8f2w59i6i6Jp2kUIJlcHw2In2g)

## 开发&调试

>入口文件 ：bin/index.js

>调试：在当前目录下 npm link 就可以开始调试了

### 目录结构
``` shell
yeepay-cli
├─ CHANGELOG.md                 # 版本更新日志
├─ README.md                    # 项目说明文档
├─ bin
│  └─ index.js                 # CLI入口文件
├─ config
│  ├─ git.config.js            # Git相关配置
│  └─ inquire.config.js        # 命令行交互问题配置
├─ lib
│  ├─ init.js                  # 项目初始化逻辑
│  ├─ utils                    # 工具函数目录
│  │  ├─ changeFile.js         # 文件修改相关工具
│  │  ├─ gitCreateProject.js   # Git项目创建工具
│  │  ├─ log.js               # 日志输出工具
│  │  ├─ operateGit.js        # Git操作相关工具
│  │  └─ utils.js             # 通用工具函数
│  └─ view.js                  # 视图相关逻辑
├─ package.json                # 项目配置文件
├─ pnpm-lock.yaml             # pnpm依赖锁定文件
└─ publish.sh                 # 发布脚本
```

## 发布
``` shell
sh publish.sh
```

## 工具使用：
[【commander】node命令行接口解决方案](https://github.com/tj/commander.js/blob/HEAD/Readme_zh-CN.md#%e5%a3%b0%e6%98%8e-program-%e5%8f%98%e9%87%8f)

[【chalk】输出彩色的字，可以搭配commander，zx等很多工具使用](https://www.npmjs.com/package/chalk)

[【semver】node版本校验助手](https://www.npmjs.com/package/semver)

[【zx】google推出的命令行工具](https://google.github.io/zx)

[【inquirer】交互式命令行集合，用于设置问题让用户选择](https://www.npmjs.com/package/inquirer)

[【ora】用来美化控制台的加载](https://www.npmjs.com/package/ora)