SuperAPI AI 工具集

yaml-validator

编程与开发

查看项目

更新于 10-15 20:30

技能介绍

用途:校验 YAML 文件的语法、结构与 schema 合规性,适合在编辑、创建或调试 YAML 配置、GitHub Actions 工作流及 CI/CD 文件时使用。

主要能力:识别常见 YAML 问题并给出修复方式,包括制表符与空格混用(改为 2 空格缩进)、缺少冒号(在键后补 :)、特殊字符未加引号(含 :、{、}、[、] 的字符串需加引号)、重复键(删除或合并)、形似布尔值的字符串(yes、no、on、off 需加引号)、行尾空格(可用 sed -i 's/[[:space:]]*$//' 去除)。

使用方式:安装 yamllint 用 pip install yamllint;校验单个文件用 yamllint file.yml;检查全部 YAML 文件用 yamllint .;Python 备用方案为 python3 -c "import yaml; yaml.safe_load(open('file.yml'))"。可在项目根目录创建 .yamllint.yml,配置 2 空格缩进、最长 120 字符,并启用 trailing-spaces 与 key-duplicates 规则。

GitHub Actions 检查清单:触发器(push、pull_request、schedule)有效;runs-on 取值正确(ubuntu-latest、macos-latest);steps 为正确的列表结构;使用较新的 action 版本(v3/v4,而非 v1/v2)。

最佳实践:缩进用 2 空格;含特殊字符的字符串加引号;提交前先校验;每行不超过 120 字符;文件以换行结尾。避免:用制表符缩进、留下行尾空格、使用重复键、混用 YAML 1.1 与 1.2 特性。

限制:资料未提供该技能的收费、价格、平台支持范围及具体效果说明。