SuperAPI AI 工具集

vale-linting

写作与研究

查看项目

更新于 10-15 22:37

技能介绍

用途:覆盖 InfluxData 文档的完整 Vale 风格检查流程,包括运行检查、理解规则配置、添加词汇表术语和创建自定义规则。适用于对文档运行风格检查、调试告警、维护接受/忽略词表、编写或修改自定义规则,以及排查某模式为何被标记。

主要能力:通过包装脚本 .ci/vale/vale.sh 运行 Vale,优先使用本地二进制(版本 >= 3.x),否则回退到 Docker 镜像 jdkato/vale:v${VALE_VERSION},两者都不可用时打印警告并以 0 退出。支持按最低告警级别运行、同步包和查看配置。规则来源包括 Vale 内置、InfluxDataDocs 自定义、Google 风格指南和 write-good。仓库禁用了大量机械规则与高误报风格规则,并启用 Spelling、Units、WordList、Capitalization、Branding 等自定义规则。

使用方式:常用命令为 .ci/vale/vale.sh --config=.vale.ini content/influxdb3/core/**/*.md;加 --minAlertLevel=warning 控制级别;修改 .vale.ini 后运行 .ci/vale/vale.sh sync;用 .ci/vale/vale.sh ls-config 查看配置。词汇表方面,技术术语加入 .ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt,仅拼写忽略词加入 .ci/vale/styles/InfluxDataDocs/Terms/ignore.txt。自定义规则放在 .ci/vale/styles/InfluxDataDocs/。产品专属 .vale.ini 必须重复根配置中禁用的规则,否则这些规则会被重新启用。

限制:Docker 回退只能访问仓库内文件,/tmp 等外部路径会静默失败。TokenIgnores 会在所有规则运行前剥离 URL,因此 Vale 规则无法匹配 URL 内容,支持链接校验改用 shell 脚本。macOS 自带 bash 3.2,而 CI 脚本使用关联数组需 bash 4+。沙箱环境无法运行 Vale 时包装脚本会跳过,不要使用 git commit --no-verify。