关于 umbraco-review-checks
为 `umbraco-extension-reviewer` Agent 提供 Umbraco 扩展审查参考,涵盖代码质量、架构和 UI 模式,并按扩展类型指明相关检查文件及严重程度和自动修复情况。
主要功能
- 01代码质量审查项
- 02架构审查项
- 03UI 模式审查项
- 04按扩展类型指引文件
- 05严重程度与自动修复参考
适用场景
- 01审查 Umbraco 仪表板或工作区
- 02检查属性编辑器或实体操作
- 03审查上下文或仓储扩展
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ umbraco/ umbraco-cms-backoffice-skills --skill umbraco-review-checks安装后在 Claude Code 中输入/umbraco-review-checks确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
architecture-checks.mdcode-quality-checks.mdui-pattern-checks.md详细介绍
Umbraco 扩展审查检查项
umbraco-extension-reviewer Agent 的参考技能,包含所有审查检查项。
检查类别
| 类别 | 文件 | 检查项 |
|---|---|---|
| 代码质量 | code-quality-checks.md | CQ-1 至 CQ-9 |
| 架构 | architecture-checks.md | AR-1 至 AR-6 |
| UI 模式 | ui-pattern-checks.md | UI-1 至 UI-7 |
快速参考
| ID | 检查项 | 严重性 | 自动修复 |
|---|---|---|---|
| 代码质量 | |||
| CQ-1 | 扩展类型用法 | 严重 | 是 |
| CQ-2 | Manifest 注册 | 高 | 否 |
| CQ-3 | 元素实现 | 中 | 部分 |
| CQ-4 | 上下文 API 用法 | 高 | 否 |
| CQ-5 | 状态管理 | 中 | 否 |
| CQ-6 | 本地化 | 中 | 部分 |
| CQ-7 | 命名约定 | 低 | 否 |
| CQ-8 | 条件 | 低 | 否 |
| CQ-9 | 属性编辑器 Schema 别名 | 严重 | 否 |
| 架构 | |||
| AR-1 | 直接访问 API 客户端 | 高 | 否 |
| AR-2 | 缺少工作区上下文 | 高 | 否 |
| AR-3 | 源码模式验证 | 中 | 否 |
| AR-4 | 持久化方式不一致 | 中 | 否 |
| AR-5 | 缺少 Repository 层 | 高 | 否 |
| AR-6 | 循环上下文依赖 | 严重 | 否 |
| UI 模式 | |||
| UI-1 | 自定义错误处理 | 高 | 部分 |
| UI-2 | 布局组件问题 | 高 | 否 |
| UI-3 | 使用非 UUI 组件 | 中 | 部分 |
| UI-4 | 枚举/选择处理 | 中 | 部分 |
| UI-5 | 缺少加载状态 | 低 | 否 |
| UI-6 | 无障碍问题 | 中 | 否 |
| UI-7 | 内联样式 | 低 | 部分 |
用法
根据扩展类型读取相关类别文件:
| 扩展类型 | 加载文件 |
|---|---|
| 仪表板 | 全部三个 |
| 工作区 | 全部三个 |
| 属性编辑器 | code-quality、ui-pattern |
| 实体操作 | 仅 code-quality |
| 上下文/Repository | code-quality、architecture |
相关技能
| 模式领域 | 技能 |
|---|---|
| Repository 模式 | umbraco-repository-pattern |
| 工作区上下文 | umbraco-workspace |
| 通知 | umbraco-notifications |
| 上下文 API | umbraco-context-api |
| 本地化 | umbraco-localization |
源码参考
UUI 库
对于 UI 模式检查,请参考 UUI(Umbraco UI)库中的组件最佳实践。
先检查本地资源——工作区中可能已有 UUI 源码(例如 Umbraco.UI/packages/)。使用 Glob 搜索。
在线资源:
- Storybook:https://uui.umbraco.com/
- GitHub:https://github.com/umbraco/Umbraco.UI
Umbraco CMS 源码
对于架构和模式检查,请与 Umbraco CMS 源码中的实现进行比较。
先检查本地资源——工作区中可能已有 Umbraco CMS 源码(例如 Umbraco-CMS/src/Umbraco.Web.UI.Client/)。使用 Glob 搜索参考实现。
在线资源:
审查时,优先使用本地源码,而不是通过网络获取,以确保准确性并提高速度。
评论
支持 Markdown