Cli

Cli 是一个在node环境下运行的库,通过简单的命令行交互,来进行生一些预设模板文件.

模板来自于zyx-template

当前脚手架能力：

• 生成 Openshift Config/Certificate, CI Config

• 单文件组件生成 Vue2, Vue3

• 生成项目 Vue3 PC, Vue3 Mobile, Vue3 Admin, 小程序( 微信 )

• 预览 交互问答的配置列表 以及 可以生成的模板

相关资料导航链接

• 文档地址 http://frontend-group.pages.zylliondata.local/cli-zylliondata

• 源码地址 http://gitlab.zylliondata.local/frontend-group/cli-zylliondata

安装

# Install Openshift Cli
curl -LO https://storage.data4industry.com/figure-bed/oc.tar.gz
tar -xvf oc.tar.gz
cd openshift-origin-client-tools-v3.11.0-0cbc58b-linux-64bit
mv oc /usr/local/bin/
mv kubectl /usr/local/bin/
cd ..
rm -rf openshift-origin-client-tools-v3.11.0-0cbc58b-linux-64bit

# Install Cli
npm install -g cli-zylliondata

# 安装慢 可以使用淘宝镜像
npm config set registry https://registry.npmmirror.com
npm install -g cli-zylliondata

可执行命令 zyx

| Command | Description | | :-------------------------- | :----------- | | zyx -h 或 zyx --help | 查看帮助命令 | | zyx -v 或 zyx --version | 查看版本 |

维护

在进行维护前,必须先了解两个项目之间的关联,请阅读下面仓库的docs分支

模板仓库 http://gitlab.zylliondata.local/frontend-group/zyx-template

简单来讲 zyx-template 专门存储模板与定义字段, cli-zylliondata也就是当前项目来按照zyx-template给定的字段进行开发

之所以这样设计是 因为模板的更新会导致脚手架发版较频繁, 这样设计的话 在模板中 的非依赖改动是很友好的

# pnpm dev:cli 等价于 bin中的zyx 例如pnpm dev:cli g ci iqs-ci-config
pnpm dev:cli
# 打包
pnpm build:cli

pnpm p

# 单元测试
pnpm test
pnpm test:watch
# 单元测试覆盖率 - 网页生成
pnpm coverage

# 运行文档
pnpm dev:docs
# 打包文档
pnpm build:docs
# 预览文档
pnpm preview:docs

# 规范提交
pnpm commit

# npm install 回调脚本(自动执行)
pnpm postinstall

目录结构划分

cli-zylliondata
├── bin                          # 可执行脚本
|  └── cli.js
├── CHANGELOG.md                 # 版本更新日志
├── src                          # 脚手架逻辑
|  ├── index.ts                  # 入口 - 命令注册
|  ├── commands                  # 命令及参数定义
|  ├── actions                   # 命令具体处理函数
|  ├── config                    # 配置
|  ├── dicts                     # 字典
|  └── utils                     # 工具
├── Dockerfile                   # Docker 负责部署文档
├── docs                         # 文档
|  ├── command
|  ├── guide
|  ├── index.md
|  ├── package.json
|  ├── tsconfig.json
|  └── tsconfig.node.json
├── lib                          # 打包目录
├── openshift
|  └── dc.yaml
├── package.json
├── pnpm-lock.yaml               # 依赖版本明细
├── publish.sh                   # 发布
├── README.md                    # 快速了解 文档
├── run.sh                       # Docker 启动文档脚本
├── scripts                      # npm 生命周期回调
|  └── postinstall.ts            # npm install 回调
├── tsconfig.json                # ts配置
└── tsup.config.ts               # 打包配置