@herenit/hrd-toolkit-cli
v1.5.2
Published
hrdc command line interface for heren-design toolkit
Readme
@herenit/hrd-toolkit-cli
@herenit/hrd-toolkit-cli 提供 hrdc 命令,用于查询 heren-design-web-vue 组件知识、Icon、业务模板,并扫描本地 Vue 项目的组件和命令式插件使用情况。
安装
npm install -g @herenit/hrd-toolkit-cli安装后验证:
hrdc --cli-version快速开始
hrdc --cli-version
hrdc list
hrdc info hr-button全局参数
| 参数 | 说明 |
| -------------------------- | ----------------------------------------------------- |
| --format <format> | 输出格式:text、json 或 markdown,默认 text。 |
| --lang <lang> | 输出语言:zh 或 en,默认 zh。 |
| --data-version <version> | 使用指定内置组件知识版本,例如 1.8.0。 |
| --detail | 输出更完整的信息,部分命令会使用。 |
命令速查
| 命令 | 用途 |
| ------------------------------ | --------------------------------------------------------------- |
| hrdc --cli-version | 输出 CLI 版本号。 |
| hrdc list | 列出组件,可用 --category 过滤。 |
| hrdc info <component> | 查询组件 Props、Events、Slots 和 Expose 方法。 |
| hrdc doc <component> | 获取组件完整 Markdown 文档。 |
| hrdc demo <component> [name] | 列出或获取组件 Demo。 |
| hrdc icons [query] | 查询 hr-icon 图标数据,可用 --type、--limit、--offset。 |
| hrdc templates [name] | 列出或获取业务代码模板。 |
| hrdc usage [dir] | 扫描本地项目中的组件和命令式插件使用统计,可用 --filter。 |
| hrdc lint [target] | 检查本地项目中的 heren-design 使用规范问题。 |
| hrdc doctor | 诊断项目配置。 |
| hrdc env [dir] | 收集项目环境信息。 |
使用示例
hrdc list --format json
hrdc info hr-button --data-version 1.8.0
hrdc icons search --format json
hrdc templates list-page --format markdown
hrdc usage ./src --filter hr-button常见用途
- 查询组件 Props、Events、Slots 和 Expose 方法。
- 获取组件文档、Demo 和业务代码模板。
- 搜索
hr-icon图标。 - 扫描本地 Vue 项目中的 heren-design 组件和命令式插件使用情况。
usage中的插件统计按导入出现次数计算,不统计具体方法调用次数。- 诊断项目环境和常见配置问题。
