用途:审计 Elastic 文档仓库中 Markdown 文件的 frontmatter,检查字段完整性与正确性,并生成结构化报告。输入为文件路径或目录($ARGUMENTS);若为空需向用户询问审计范围。
主要检查项:1)products(必填):须包含配置的必需产品 ID(如 kibana),可含额外产品;缺失或缺少必需产品会被标记;product 单数形式视为疑似错误,除非本地仓库明确使用该 schema。2)description(必填):须存在且非空,建议约 150 字符,超过 200 字符判为过长;须为完整句子;不得含 Jinja2 替换变量(如 {{kib}}、{{es}}、{{esql}});不得带“Reference -”等标签前缀;须面向用户概括页面内容;含冒号等易被 YAML 误解的标点时须加引号。3)navigation_title(推荐):当 H1 标题超过约 50 字符时,提示应添加该字段。4)mapped_pages:若存在则保留,不标记或建议修改;若不存在也不建议添加。
执行流程:在指定范围 glob 所有 .md 文件,读取各文件 frontmatter,按上述规则逐项校验,读取 H1 标题检查长度,最后汇总报告。
报告格式:标题为“Frontmatter audit: <scope>”,列出配置(必需产品、扫描文件数),按问题类型分组的问题表格(缺失 products、无效或缺失 description、缺失 navigation_title),并给出汇总统计(通过文件数、存在问题文件数及各类问题计数)。仅输出存在问题的小节,按类型而非按文件分组,便于批量修复。
配置默认值:必需产品为无,允许额外产品为是;仅当目标范围导致必需键或产品含义不明确时,才向用户请求确认。
限制:资料未提供安装方式、价格、适用平台或除上述规则外的其他能力。