SuperAPI AI 工具集

validate-integration-docs

通用与其它

查看项目

更新于 10-15 21:37

技能介绍

用途:对 Elastic 集成包的文档源做 lint,过滤模板噪声,提出修复建议,并验证构建后的渲染输出。

主要能力:分两阶段执行。阶段一检查 vale 与 elastic-package 是否可用(缺失则提示按 Elastic 官方指南安装),定位包含 manifest.yml 和 _dev/build/docs/README.md 的包根目录,运行 vale _dev/build/docs/README.md --output JSON,识别 {{/* */}} 模板注释范围并抑制其中的误报,按文件分组报告 Line、Match、Severity、Check、Message,并针对 replace、remove 及无参数检查(如 Elastic.Semicolons、Elastic.DontUse、Elastic.Ellipses)起草修改建议。阶段二运行 elastic-package build,再对 packages/<pkg>/docs/README.md 运行 vale,报告并提议修复。

使用方式:先确认工具可用,再定位包根目录;所有编辑需用户确认后通过 Edit 工具应用,只改 _dev/build/docs/ 源文件,绝不编辑 packages/*/docs/;源文件修改后需重新构建以确认渲染输出干净。

适用场景:用户要求 vale check、lint docs、validate the README 等文档校验任务。

限制:依赖 vale 与 elastic-package;模板注释内的发现会被抑制;不自动应用未确认的编辑;未提供具体安装命令与版本要求。