@aegis.inc/aegis-cli v1.5.1
aegis-cli
擎盾公司的前端命令行工具;
本项目由frontend-collection项目组负责维护。
这是开发人员文档,如果你仅仅是使用人员,请查阅 用户 README 文档
使用技术
fs-extra用于文件交互;axios用于下载文件;chalk用于打印有颜色的输出;commander用于调用命令行;compressing用于解压;inquirer用于命令行提问;ora用于模拟命令行等待的操作;prettier用于格式化代码;
开发说明
pnpm install如果你的系统里没有pnpm,请运行
npm install -g pnpm运行和部署
运行
npm run dev部署
npm run build发布
若你尚未登录npm,请先登录
npm login然后执行发布命令
# 将项目发布到`npm`
npm run release该行为会指导你填写版本号并执行发布;
然后,你需要先加入
@aegis.inc的npm团队,你可以向吴昊(@wuhao)申请加入。版本号的格式为
x.y.z(-beta.n),括号内的内容为可选项,如果你的版本包括beta,则将发布为beta版本。
安装
beta版本的命令为npm install -g "@aegis.inc/aegis-cli@beta";
分支说明
| 分支 | 说明 | 状态 |
|---|---|---|
| master | 正式分支 | 使用中 |
| develop | 开发分支 | 使用中 |
接口文档
该项目无后端
项目模块
| 模块 | 说明 |
|---|---|
| framework | 主架构 |
| lint | 配置检查 |
| create | 初始化项目 |
| init | 初始化配置 |
| install | 安装依赖 |
| update | 更新 anpm |
| utils | 工具函数 |
| configuration | 配置文件 |
| others | 其它 |
依赖备注
- 项目全局变量存储在
utils/config中。
开发人员-项目负责人
项目负责人: 徐志乐-Xmo(@xuzhile)
环境及资料说明
项目注意事项
- 项目单元测试待完成
- 该项目使用
typescript+tsc-alias进行原生打包。 - 请勿跨版本发布,版本格式为
x.y.z- 其中
x为重构次数; y为新功能、新参数;z为 bug 修复;
- 其中
颜色使用
当使用 chalk 进行命令行打印的时候,对某些内容需要用不用的颜色进行高亮,请参照如下的逻辑;
| 对象 | 示例 | 颜色 |
|---|---|---|
| 提示用户执行的命令 | anpm update | cyan |
| 正在执行的命令 | npm install eslint | blue |
| 综合路径、文件夹、url | /home/root/code/common/aegis-cli | green |
| 单文件名、分支 | README.md | greenBright |
| 模块、单项、高亮 | scope | yellowBright |
| 一级提示 | name: 'eslint ' + chalk.gray('目前仅支持 vue3 环境的eslint配置') | gray |
| 二级提示(单独一行) | '目前仅支持 vue3[+typescript] 环境的eslint配置' | bgBlack.gray |
| 警告 | ... | yellow |
| 错误 | 当前项目类型暂不支持代码格式化 | redBright |
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago