CLI
@aplus-frontend/cli 是 APlus-UI 的命令行工具,其提供多个命令来查询组件详情/检查更新和诊断外部依赖版本/项目使用情况分析等,并具有以下特点:
- 内置完整的文档数据和版本数据,使用完全离线
- 支持
json、markdown以及格式化文本三种方式输出
安装
bash
npm install -g @aplus-frontend/cli完成后在命令行中输入aplus --help查看支持的命令。
支持的命令
| 命令 | 说明 |
|---|---|
list | 列出所有支持的组件及其简单介绍 |
info <component> | 查询指定组件的基础信息 |
demo <component> [name] | 查询指定组件的示例,支持传递示例名称查询特定的示例 |
doc <component> | 查询指定组件的完整文档 |
token [component] | 获取此组件的设计令牌 |
changelog <component> [version] | 获取变更日志(可以指定组件和版本) |
doctor [dir] | 诊断当前项目中@aplus-frontend/ui的安装问题(版本/外部依赖版本/重复等) |
usage [options] [dir] | 获取组件在项目中的使用情况(可指定扫描目录和通过--component参数指定扫描的组件) |
scan [dir] | 扫描弃用组件(ApTable、ApGrid等)在项目中的使用情况,支持指定扫描目录 |
离线数据
此命令行工具内置两种数据,以下是其介绍和相关说明
文档数据
在data/v[x].json中,会按照大版本生成文件,比如当前版本的文档数据就为v7.json,由于文档的格式灵活多变,目前暂时无法通过脚本生成。
为了方便提取文档数据,在编写组件文档时需尽可能满足如下需求:
- 在frontmatter中维护组件名称、加入版本等数据,例如:
YAML
---
title: AgGrid
title_cn: 表格
version: 6.22.0
---- 属性表格中添加
版本列,以获取某个数据添加/更新的版本 - 在编写
demo时,应一个文件一个示例,避免跨文件,示例内容尽量贴近实际使用场景 - 所有复杂类型定义都必须在文档中有所体现
变更日志
变更日志通过site/guide/CHANGELOG.UI.md生成,每次@aplus-frontend/ui完成新版本发布后,需要在cli目录运行
bash
pnpm gen:changelog重新生成变更记录。
为了更好的生成变更记录,在提交时应使用pnpm commit并通过交互式命令行完成提交,提交内容中应注明具体哪个组件发生了变更。
通过 AI 工具使用
想要让AI使用此命令行,你先需要安装APlus-UI的skill,安装(更新)方式为:
bash
npx skills add git@codeup.aliyun.com:65f941491febde2b6c514822/frontend/aplus-basic/aplus-ui.git提示
使用以上命令安装skill时请先配置SSH。
建议将此skill安装到全局。
安装完成后,使用任何支持skill的AI工具,将在此skill被载入后自行安装(也会执行更新)。