YAML 美化器
专业的 YAML 格式化工具,提供缩进控制、键名排序等高级排版选项。
原始 YAML
格式化选项
美化结果
为什么需要 YAML 美化器?
在处理复杂的 Kubernetes 编排文件或大型微服务配置时,混乱的缩进和无序的键名往往会降低代码的可读性。YAML 美化器能把合法 YAML 的缩进统一为你选择的风格,还能通过对键名进行字母顺序排序 (Sort Keys),让配置文件在版本管理(如 Git Diff)中更加清晰、可预测。
我们的美化器提供了细粒度的控制,包括自定义缩进长度、禁用复杂的 YAML 锚点引用、以及强制统一引号风格等。所有处理逻辑均在本地浏览器端完成,确保您的服务器敏感配置绝对安全。
如何使用此工具
将您的 YAML 内容粘贴到左侧区域,然后在下方的“格式化选项”面板中根据需求调整缩进、排序等参数。工具会随输入实时格式化,右侧即刻展示排版后的 YAML 文本,无需点击按钮。
如果您的 YAML 存在语法错误,工具会实时给予提示。美化完成后,点击“复制美化结果”即可直接使用。
典型生产场景
在提交之前,开启键名排序 (Sort Keys) 并统一缩进为 2 格。这样同一配置文件在不同同事机器上操作后,Git Diff 的结果只会显示真实的业务变更,而不是因为键顺序不同导致的大量伪变更,大幅降低 PR 评审的噪音。
团队维护多套 Helm Chart 时,values.yaml 的格式往往参差不齐。在 CI/CD 流水线的 lint 步骤之前,用美化器统一缩进为 2 格、禁用 Aliases、设置 lineWidth 为 -1,可以确保生成的 chart 包在不同 Helm 版本间行为一致。
多人协作时,GitHub Actions 的 .yml 文件容易产生缩进不统一、引号风格混乱的问题。统一强制 2 格缩进 + 自动引号,并在团队的 pre-commit hook 中集成相同参数的格式化,可以从根源杜绝此类问题。
从第三方获取的 Kubernetes YAML 示例往往有 4 格缩进或混用 Tab,直接 apply 可能因解析异常导致静默错误。批量粘贴后,设置 indent=2、noRefs=true,即可生成干净、可直接 kubectl apply 的清单。
格式化参数深度指南
键名排序 (Sort Keys) 的注意事项:虽然字母顺序排序对大多数 YAML 有益,但某些格式对键顺序有隐式依赖,例如 Docker Compose 的 depends_on、Kubernetes 的 spec/metadata 层级、以及部分自研配置解析器。建议在自动化流水线中使用前,先验证排序后的文件功能是否正常。
禁用引用 (noRefs) 的适用场景:YAML 的锚点 (&) 和别名 (*) 在本地开发时便于维护,但多个 CI/CD 平台(尤其是旧版 Jenkins、部分 GitLab Runner 配置)的 YAML 解析器不支持这些扩展语法。如果您的配置最终会被这类工具消费,建议开启 noRefs 将别名展开为独立重复块。
最大行宽与可读性:lineWidth=-1(无限制)适合机器消费型配置,如 Kubernetes Annotation 中的长 JSON 值、长 URL 等。lineWidth=100 到 120 适合人工评审场景,避免代码评审工具因为超长行而无法正确展示 Diff。