Agent Skills
uniboot-ui 发布包内附带 Agent Skills,用于在业务项目(如本模板)中辅助 Cursor 等 AI 编码工具正确使用 Uniboot UI 组件。Skills 由组件库文档自动生成,随 uniboot-ui 版本发布。
包含内容
安装后会在项目 .cursor/skills/ 下得到按场景划分的 skill,例如:
| Skill | 适用场景 |
|---|---|
uniboot-ui-foundation | 安装、引入、主题、国际化、ConfigProvider |
uniboot-ui-basic | 按钮、布局、图标、间距等基础组件 |
uniboot-ui-form | 表单、输入、选择、上传、日期等 |
uniboot-ui-data | 表格、树、卡片、分页等数据展示 |
uniboot-ui-navigation | 固钉、菜单、Tabs、面包屑、步骤条 |
uniboot-ui-feedback | 对话框、消息、通知、Loading |
uniboot-ui-pro | ProTable、QueryFilter、ProLayout、登录页等 |
uniboot-ui-config | 全局配置 |
uniboot-ui-misc | 分割线、水印等 |
每个 skill 目录内含 SKILL.md(使用指引)和 references/(各组件 API 与示例)。
安装
自动安装(推荐)
在业务项目 package.json 的 scripts 中加入 postinstall:
json
{
"scripts": {
"postinstall": "node ./node_modules/uniboot-ui/skills/install.mjs"
}
}执行 pnpm install 或升级 uniboot-ui 后会自动将 skills 安装到 .cursor/skills/。
TIP
请将 .cursor/skills/ 纳入版本控制,便于团队共享同一套组件使用规范;若希望每人本地安装,可加入 .gitignore。
手动安装
bash
node ./node_modules/uniboot-ui/skills/install.mjs按需安装
仅安装部分场景时,可通过环境变量指定 skill 名称(逗号分隔):
bash
UNIBOOT_SKILLS=uniboot-ui-foundation,uniboot-ui-form,uniboot-ui-pro \
node ./node_modules/uniboot-ui/skills/install.mjs在 Cursor 中使用
- 在 Agent 对话中通过
/命令选择对应 skill,例如/uniboot-ui-form、/uniboot-ui-pro。 - Agent 会先阅读
SKILL.md中的场景索引,再按需打开references/<组件>.md获取 Props、Events 与示例代码。 - 可在项目根目录
AGENTS.md中补充说明,例如:
markdown
## Uniboot UI
使用 Uniboot UI 组件时,优先加载 `.cursor/skills/uniboot-ui-*` 中与当前任务匹配的场景 skill。
组件标签前缀为 `u-`,导入名为 `U*`(Pro 系列为 `Pro*`、`<pro-*>`)。版本同步
Skills 与当前安装的 uniboot-ui 版本对应。升级组件库后请重新执行安装脚本,避免文档 API 与项目依赖不一致:
bash
pnpm update uniboot-ui
node ./node_modules/uniboot-ui/skills/install.mjs常见问题
执行 install 后没有生成 .cursor/skills
确认 node_modules/uniboot-ui/skills/manifest.json 存在。若不存在,说明当前安装的 uniboot-ui 版本尚未包含 skills,请升级到包含该能力的版本,或使用已执行 pnpm build 的本地包。
旧 skill 名称残留
若曾安装过已更名的 skill(例如 uniboot-ui-advanced),可手动删除 .cursor/skills/uniboot-ui-advanced/ 后重新运行安装脚本。