本文目录
什么是 YAML 格式化?
YAML 格式化会统一 YAML 文档的缩进、间距和结构。格式良好的 YAML 更易于阅读、审查和维护——这一点尤为重要,因为 YAML 完全依赖缩进(而非中括号或大括号)来表示结构。
YAML 格式化工具还会验证语法,在缩进错误、缺失冒号和嵌套不当导致应用故障之前将其捕获。这种美化工具与验证工具的双重角色,使它成为任何处理配置文件的人不可或缺的工具。
YAML 格式化的工作原理
格式化工具会解析你的 YAML 文档,验证其结构,并输出一个缩进恰当、格式一致的版本。
- 缩进规范化——将整个文档统一为 2 个空格的缩进
- 语法验证——检查无效字符、错误缩进、重复键和结构性错误
- 错误报告——为发现的任何语法错误显示确切的行号和列号
免费试用 —— 无需注册
格式化 YAML →常见的 YAML 错误
YAML 对空白敏感的语法使其容易出现难以用肉眼发现的细微错误。
- 制表符——YAML 只允许用空格进行缩进,制表符会导致解析失败
- 缩进不一致——在同一文档中混用 2 个空格和 4 个空格的缩进
- 缺失冒号——在键名后忘记写冒号是一个常见的笔误
- 未加引号的特殊值——yes、no、on、off 之类的字符串在不加引号时会被解释为布尔值
何时格式化 YAML
每当编辑 Docker、Kubernetes、GitHub Actions 或任何 CI/CD 流水线的配置文件时,都应格式化 YAML。在提交 YAML 变更之前运行格式化工具,以尽早发现错误。对于格式已经走样的现有配置文件,格式化工具能让其重新恢复一致性。
常见问题
格式化会改变我的 YAML 值吗?
不会。格式化只会改变空白和缩进。所有的键、值和数据结构都保持不变。格式化工具会保留字符串的引号,注释可能会被重新排列,但其内容会被保留。
格式化工具使用哪种缩进?
格式化工具默认使用 2 个空格的缩进,这是 Kubernetes、Docker Compose 和 GitHub Actions 等 YAML 生态系统中最常见的约定。