用途
audit-schema 是一个内容架构(content schema)审计命令,用于分析内容模型的命名规范、字段使用、关系完整性与最佳实践,并识别潜在问题。
主要能力
该命令覆盖以下审计类别:
- 命名规范审计:类型名使用 PascalCase、字段名使用 camelCase、复数形式一致、名称具描述性。
- 字段使用审计:必填字段具备默认值或验证、可选字段标记正确、字段类型与数据匹配、无重复字段。
- 关系审计:所有引用可解析、反向关系已定义、无循环依赖、基数正确。
- 最佳实践审计:可编辑内容启用版本控制、存在 slug/路由字段、公开内容具备 SEO 字段、包含审计字段(created、modified)。
- 性能相关检查(在审计类别表中列出):索引与查询模式。
使用方式
命令用法:
/cms:audit-schema
/cms:audit-schema --severity high
/cms:audit-schema --fix
选项:
--fix:针对识别出的问题给出修复建议。--severity:按问题严重程度过滤(all|high|medium)。
工作流程:
- 定位架构定义:在 YAML/JSON 规范文件、C# 实体模型、迁移文件中搜索内容类型定义。
- 调用相关技能进行分析:content-type-modeling(类型模式)、content-relationships(关系完整性)、dynamic-schema-design(JSON 列用法)。
- 执行审计(命名、字段、关系、最佳实践等类别)。
- 生成报告,包含摘要(内容类型数、字段总数、关系数、问题数及高/中/低分布)、按严重程度分组的问题详情与修复建议。
- 若使用
--fix,针对可修复问题生成修正后的架构(示例中展示将错误大小写字段改为 PascalCase 并添加[Required]属性)。
适用场景
适用于需要审查 CMS 或内容建模项目的内容架构定义、检查命名与关系一致性、发现潜在建模问题并获取修复建议的场景。
相关技能
- content-type-modeling:内容类型模式
- content-relationships:关系模式
- dynamic-schema-design:JSON 列模式
限制
资料未提供关于平台支持范围、收费或价格的更多信息。