umbraco-review-checks
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseUmbraco Extension Review Checks
Umbraco扩展审核检查
Reference skill containing all review checks for the agent.
umbraco-extension-reviewer本参考文档包含 Agent所需的全部审核检查项。
umbraco-extension-reviewerCheck Categories
检查分类
| Category | File | Checks |
|---|---|---|
| Code Quality | | CQ-1 to CQ-9 |
| Architecture | | AR-1 to AR-6 |
| UI Patterns | | UI-1 to UI-7 |
| 分类 | 文件 | 检查项 |
|---|---|---|
| 代码质量 | | CQ-1 至 CQ-9 |
| 架构 | | AR-1 至 AR-6 |
| UI模式 | | UI-1 至 UI-7 |
Quick Reference
快速参考
| ID | Check | Severity | Auto-Fix |
|---|---|---|---|
| Code Quality | |||
| CQ-1 | Extension Type Usage | Critical | Yes |
| CQ-2 | Manifest Registration | High | No |
| CQ-3 | Element Implementation | Medium | Partial |
| CQ-4 | Context API Usage | High | No |
| CQ-5 | State Management | Medium | No |
| CQ-6 | Localization | Medium | Partial |
| CQ-7 | Naming Conventions | Low | No |
| CQ-8 | Conditions | Low | No |
| CQ-9 | Property Editor Schema Alias | Critical | No |
| Architecture | |||
| AR-1 | Direct API Client Access | High | No |
| AR-2 | No Workspace Context | High | No |
| AR-3 | Source Pattern Verification | Medium | No |
| AR-4 | Inconsistent Persistence | Medium | No |
| AR-5 | Missing Repository Layer | High | No |
| AR-6 | Circular Context Dependencies | Critical | No |
| UI Patterns | |||
| UI-1 | Custom Error Handling | High | Partial |
| UI-2 | Layout Component Issues | High | No |
| UI-3 | Non-UUI Component Usage | Medium | Partial |
| UI-4 | Enum/Select Handling | Medium | Partial |
| UI-5 | Missing Loading States | Low | No |
| UI-6 | Accessibility Issues | Medium | No |
| UI-7 | Inline Styles | Low | Partial |
| ID | 检查内容 | 严重程度 | 自动修复 |
|---|---|---|---|
| 代码质量 | |||
| CQ-1 | 扩展类型使用 | 严重 | 是 |
| CQ-2 | 清单注册 | 高 | 否 |
| CQ-3 | 元素实现 | 中 | 部分支持 |
| CQ-4 | Context API 使用 | 高 | 否 |
| CQ-5 | 状态管理 | 中 | 否 |
| CQ-6 | 本地化 | 中 | 部分支持 |
| CQ-7 | 命名规范 | 低 | 否 |
| CQ-8 | 条件判断 | 低 | 否 |
| CQ-9 | 属性编辑器Schema别名 | 严重 | 否 |
| 架构 | |||
| AR-1 | 直接访问API客户端 | 高 | 否 |
| AR-2 | 缺少工作区上下文 | 高 | 否 |
| AR-3 | 源模式验证 | 中 | 否 |
| AR-4 | 持久化不一致 | 中 | 否 |
| AR-5 | 缺少仓储层 | 高 | 否 |
| AR-6 | 循环上下文依赖 | 严重 | 否 |
| UI模式 | |||
| UI-1 | 自定义错误处理 | 高 | 部分支持 |
| UI-2 | 布局组件问题 | 高 | 否 |
| UI-3 | 非UUI组件使用 | 中 | 部分支持 |
| UI-4 | 枚举/选择器处理 | 中 | 部分支持 |
| UI-5 | 缺少加载状态 | 低 | 否 |
| UI-6 | 可访问性问题 | 中 | 否 |
| UI-7 | 内联样式 | 低 | 部分支持 |
Usage
使用方法
Read the relevant category file(s) based on extension type:
| Extension Type | Load Files |
|---|---|
| Dashboard | All three |
| Workspace | All three |
| Property Editor | code-quality, ui-pattern |
| Entity Action | code-quality only |
| Context/Repository | code-quality, architecture |
根据扩展类型阅读对应的分类文件:
| 扩展类型 | 需加载的文件 |
|---|---|
| 仪表板(Dashboard) | 全部三个 |
| 工作区(Workspace) | 全部三个 |
| 属性编辑器(Property Editor) | code-quality, ui-pattern |
| 实体操作(Entity Action) | 仅code-quality |
| 上下文/仓储(Context/Repository) | code-quality, architecture |
Related Skills
相关技能
| Pattern Area | Skill |
|---|---|
| Repository pattern | |
| Workspace context | |
| Notifications | |
| Context API | |
| Localization | |
| 模式领域 | 技能 |
|---|---|
| 仓储模式 | |
| 工作区上下文 | |
| 通知 | |
| Context API | |
| 本地化 | |
Source References
参考资源
UUI Library
UUI库
For UI pattern checks, refer to the UUI (Umbraco UI) library for component best practices.
Check locally first - The UUI source may be available in the workspace (e.g., ). Use Glob to search for it.
Umbraco.UI/packages/Online resources:
- Storybook: https://uui.umbraco.com/
- GitHub: https://github.com/umbraco/Umbraco.UI
对于UI模式检查,请参考UUI(Umbraco UI)库的组件最佳实践。
优先检查本地资源 - UUI源码可能已存在于工作区中(例如:)。使用Glob进行搜索。
Umbraco.UI/packages/在线资源:
- Storybook: https://uui.umbraco.com/
- GitHub: https://github.com/umbraco/Umbraco.UI
Umbraco CMS Source
Umbraco CMS源码
For architecture and pattern checks, compare against Umbraco CMS source implementations.
Check locally first - The Umbraco CMS source may be available in the workspace (e.g., ). Use Glob to search for reference implementations.
Umbraco-CMS/src/Umbraco.Web.UI.Client/Online resources:
When reviewing, prefer local source over web fetches for accuracy and speed.
对于架构和模式检查,请与Umbraco CMS的源码实现进行对比。
优先检查本地资源 - Umbraco CMS源码可能已存在于工作区中(例如:)。使用Glob搜索参考实现。
Umbraco-CMS/src/Umbraco.Web.UI.Client/在线资源:
审核时,优先使用本地资源而非网络资源,以确保准确性和速度。