YAML 格式化工具

前后对比

杂乱的输入：

server:
  port:   8080
  hosts: ["api.example.com",  "api2.example.com"]
  timeout:  30
  debug: true

格式化后（2 个空格，块式）：

server:
  port: 8080
  hosts:
    - api.example.com
    - api2.example.com
  timeout: 30
  debug: true

格式化选项

引号规则

最少引号通常正是你想要的：字符串保持不加引号，除非裸写会带来风险。以下情况格式化工具会自动加引号：

• 写成字符串的旧式布尔值：yes、no、on、off、y、n。YAML 1.2 已经把它们当作字符串读取，但很多解析器仍遵循 YAML 1.1，不加引号的 no 会变成 false。格式化工具在输出中始终给它们加引号，这样著名的挪威 bug（国家列表里的 NO 被读成 false）就不会坑到使用你文件的任何一方。
• 写成字符串的数字：'007'、'3.14'。不加引号会被解析成整数或浮点数。
• 含有 :、#、[、{ 等字符或以空白开头的字符串，裸写输出会改变结构。

每次运行都会做的清理

• 行尾空白。 会被去除。
• 混乱或不规则的缩进。 统一为你选择的缩进宽度。
• 集合内部的空行。 会被移除。
• 缩进中的制表符。 YAML 禁止制表符；解析器会拒绝这样的输入，并给出指明所在行的清晰错误，让你可以先修复，而不是交付一份其他解析器都会拒绝的文件。

注释、锚点与合并键

格式化会规范化文档模型，在提交之前有几个限制值得了解：

• 注释会被移除。 解析器会把文档解析成数据，因此 # 注释无法在格式化后保留。如果注释很重要，请先保留一份副本。
• 锚点和别名会被解析。 通过别名共享的节点仍然保持共享，但会以 &ref_0 这样自动生成的名称重新输出；原始锚点名不会保留。
• 合并键（<<:）会被解析，展开成包含合并后值的普通映射。

多文档流

支持包含多个文档的流：每个文档会被独立格式化，再用 --- 分隔符重新连接，每次最多处理 100 个文档。