关于 yaml-validator
yaml-validator 是一项用于检查 YAML 文件的技能，可验证语法、结构和模式，并提供常见错误及项目配置建议。
主要功能
- 01语法、结构和模式验证
- 02yamllint 命令示例
- 03常见 YAML 错误排查
- 04.yamllint.yml 配置建议
- 05GitHub Actions 检查清单
适用场景
- 01提交前检查 YAML 文件
- 02排查缩进与重复键问题
- 03配置项目级 yamllint 规则
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/yaml-validator确认已加载。
详细介绍
YAML 验证器
验证 YAML 文件的语法、结构和架构合规性。
常见问题
| 问题 | 修复方法 |
|---|---|
| 混用制表符和空格 | 将缩进统一为 2 个空格 |
| 缺少冒号 | 在键后添加 : |
| 特殊字符未加引号 | 为包含 :、{、}、[、] 的字符串加上引号 |
| 键重复 | 删除或合并 |
| 看起来像布尔值的字符串 | 为 yes、no、on、off 加上引号 |
| 行尾空格 | 使用 sed -i 's/[[:space:]]*$//' 删除 |
验证命令
# Install yamllint
pip install yamllint
# Validate single file
yamllint file.yml
# Check all YAML files
yamllint .
# Python fallback
python3 -c "import yaml; yaml.safe_load(open('file.yml'))"
项目 .yamllint 配置
在项目根目录创建 .yamllint.yml，设置 2 个空格缩进、最大行长为 120，并启用 trailing-spaces 和 key-duplicates 规则。
GitHub Actions 检查清单
- 有效的
on:触发器（push、pull_request、schedule） - 正确的
runs-on值（ubuntu-latest、macos-latest） - 结构正确的
steps:列表 - 使用较新的 action 版本（v3/v4，而非 v1/v2）
最佳实践
应该
- 使用 2 个空格缩进
- 为包含特殊字符的字符串加上引号
- 提交前进行验证
- 将行长控制在 120 个字符以内
- 在文件末尾添加换行符
不应该
- 使用制表符缩进
- 留下行尾空格
- 使用重复键
- 混用 YAML 1.1 和 1.2 的特性
评论
支持 Markdown