YAML 格式化工具

Source: Dev.to

为什么正确的格式化很重要

• 防止 应用程序、CI/CD 流水线和部署中的配置失败。
• 提升可读性 与可维护性，方便团队协作。
• 加快调试 速度，使父子关系一目了然。

核心格式化收益

• 修复缩进并确保使用空格（不允许使用制表符）。
• 对齐层级结构和列表项。
• 统一风格（例如，将内联 YAML 转换为块格式，统一引用方式）。
• 验证语法：检测缺失的冒号、无效的嵌套以及其他错误。

可选增强功能

• 按字母顺序对键进行排序。
• 强制执行项目范围的格式化规则。

常见特性

• 粘贴并格式化 – 对复制的 YAML 进行即时格式化。
• 语法错误高亮 – 为问题提供可视化提示。
• 一键复制输出 – 轻松复用格式化后的结果。
• 实时格式化 – 在输入或保存时自动格式化。

流行工具

这些工具可以集成到构建流水线中，实现自动化检查。

使用示例

# 使用 yamllint 检查 YAML 文件
yamllint file.yaml

# 使用 Prettier 格式化 YAML 文件
prettier --write file.yaml

示例 前后对比

之前（缩进错误）：

services:
app:
image:node
ports:
- "3000:3000"

之后（正确格式化）：

services:
  app:
    image: node
    ports:
      - "3000:3000"

典型使用场景

• Docker 配置文件（docker-compose.yml）
• Kubernetes 清单
• GitHub Actions 工作流
• CI/CD 流水线定义
• Helm Chart
• 通用应用程序配置文件

正确的格式化有助于防止运行时配置错误，使 YAML 文件易于阅读，强制统一标准，降低调试和部署问题，从而提升团队项目的协作效率。