SuperAPI AI 工具集

docs-validate-code-samples

写作与研究

查看项目

更新于 10-15 21:37

技能介绍

用途:对 Elastic 文档的一个或多个 Markdown 文件中的代码块,按 docs-builder 样式规则做校验并报告所有违规,仅分析不修改源文件。

主要能力:检查 A 语言标识符缺失或错误;检查 B 使用 {{var}} 替换变量时是否在围栏信息中带 subs=true,以及反向误加;检查 C 行内注释是否应改为 callout 标注;检查 D 对 console 与 console-result 块做 JSON 校验(含 NDJSON _bulk、尾逗号检测,console 中禁止 ...,console-result 中允许);检查 E 非保留域名(占位域名与真实 TLD 组合);检查 F 通过文档检索核对 API 端点与请求体字段是否废弃或未识别;检查 G 对 ES|QL 校验源命令、管道命令名称、缺参命令和 SQL 语法;检查 H 校验 Painless 括号平衡、废弃的 .getValue() 与沙箱内不可用 API。

使用方式:解析 $ARGUMENTS 可选 --output <path>,目标是单个 .md、目录(递归 find … -name "*.md")或 glob;无参数时要求提供路径。用 Grep 找 ^``` 定位围栏,Read 提取代码块,跳过 HTML 注释内与 {…} 指令块。报告分两部分:摘要表与逐文件问题详情,含行号、问题、建议与上下文;无问题则输出 "No issues found across all checked files."。默认打印到控制台,指定 --output 时写入 Markdown 文件。

限制:不改动文档;跳过非 Markdown 文件;注意避免误报(歧义行内注释、括号明确平衡时才报);检查 F 依赖相关文档检索工具。未提供收费、价格、平台或效果信息。