YAML 格式化工具

用 Prettier 格式化 YAML:统一缩进和间距,同时保留注释和多文档结构。语法错误会显示行号和列号。

输出

完全在浏览器中运行,您的数据不会被上传。

相关工具

查看全部

什么是 YAML 格式化?

YAML 格式化工具用于规范 Kubernetes 清单、GitHub Actions 工作流或 Docker Compose 文件等 YAML 文件的缩进和间距。与先加载再导出数据的转换器不同,它会保留注释、文档分隔符(---)和键的顺序。

如何使用 YAML 格式化

  1. 把 YAML 粘贴到输入框中,或点击 加载示例。
  2. 选择 缩进(YAML 通常使用 2 个空格)。
  3. 点击 格式化(输入时输出也会更新)。
  4. 复制或下载格式化后的 YAML。

示例

输入
a:   1
b:
      - x  # note
输出
a: 1
b:
  - x # note

何时使用 YAML 格式化

适合修复不一致的缩进、整理 CI/CD 和 Kubernetes 文件,或在提交前检查 YAML。YAML 缩进不允许使用制表符,因此不建议选择制表符选项。如果只想检查语法,请使用 YAML 验证器。

YAML 格式化 的工作原理

输入内容先用 js-yaml 加载,以便检测错误(包括重复键)并给出精确的行号和列号。然后由 Prettier 的 YAML 插件输出,它基于具体语法树工作,因此注释、锚点、多行字符串和流式集合都会保留,同时缩进和间距被规范化。

常见用例

  • 规范 Kubernetes 或 Helm 的 values 文件
  • 整理 GitHub Actions 工作流
  • 修复 docker-compose.yml 中混用的缩进
  • 为文档格式化 YAML 示例

安全提示

所有处理都在你的浏览器本地完成,粘贴的代码不会被上传。

常见问题

注释会保留吗?

会,注释都会保留。

会改变键的顺序吗?

不会。

为什么它会拒绝重复的键?

YAML 1.2 要求映射中的键必须唯一,所以 js-yaml 会把重复键报告为错误。

探索更多分类