YAML 格式化

YAML 格式化是指将 YAML（YAML Ain't Markup Language）数据进行结构化和优化，使其更易于阅读、理解和维护。YAML 是一种常用的数据序列化格式，广泛应用于配置文件、数据交换和日志文件中。良好的格式化能够让 YAML 文件的层级关系更加清晰，减少错误的发生。

为什么需要 YAML 格式化？
YAML 格式本身设计上就强调可读性，但当 YAML 数据量很大或层级较深时，如果没有良好的格式化，代码可能显得混乱，难以快速理解。格式化后的 YAML 数据可以帮助开发者：

更容易理解文件的层次结构。
更方便地查找和调试配置项。
增强团队协作，保持代码一致性。
YAML 格式化示例：
非格式化的 YAML 示例：
yaml

server:prod;database:mydb;user:admin;password:secret;services:[service1,service2,service3];logging:{level:debug,output:console}
格式化后的 YAML 示例：
yaml

server: prod
database: mydb
user: admin
password: secret
services:
- service1
- service2
- service3
logging:
level: debug
output: console
格式化的关键内容：
缩进：YAML 使用缩进来表示层级关系。每一层的嵌套通常使用 2 个空格（或 4 个空格）进行缩进。请确保使用一致的空格数量。
换行：每个键值对或数组项通常独占一行，这样可以使文件结构更清晰。
冒号和空格：键和值之间需要有一个冒号 : 和空格。key: value 是 YAML 的标准格式。
数组格式化：数组元素使用破折号 - 开头，并应缩进与其父级键一致。
字典格式化：字典（或映射）中的键值对使用缩进来表示其层级，通常一个键对应一个子级列表。
字符串和多行文本：如果值包含特殊字符或需要多行文本，可以使用引号（单引号 ' 或双引号 "）来包围字符串，或者使用"块格式"进行多行文本格式化。
如何格式化 YAML：
手动格式化：通过调整缩进和换行来手动格式化 YAML 数据。
使用在线工具：有很多在线工具可以帮助你格式化 YAML。例如：
YAML Formatter
Online YAML Tools
使用编辑器插件：很多编辑器（如 Visual Studio Code、Sublime Text）都提供了自动格式化 YAML 的插件或内置支持。
YAML 格式化的好处：
提高可读性：格式化后的 YAML 数据更加清晰，易于理解和修改。
减少错误：良好的格式化有助于减少 YAML 文件中的结构错误，如缩进错误、遗漏的键值对等。
团队协作：一致的格式使得多个开发者能够更好地理解和编辑 YAML 文件，避免因格式不一致产生的混乱。
可维护性：格式化的 YAML 文件更容易维护和扩展，尤其在大型项目中。
格式化工具：
在线格式化工具：
JSON Formatter & Validator — 支持 YAML 格式化。
YAML Formatter — 专门的 YAML 格式化工具。
使用编辑器插件：
Visual Studio Code：安装插件 Prettier - Code Formatter，支持 YAML 自动格式化。
Sublime Text：可以使用 YAML 插件，或者通过快捷键来格式化 YAML 文件。
命令行工具：
如果你喜欢使用命令行工具，也可以使用像 yamllint 或 yq 这样的工具进行格式化和校验。
小贴士：
保持缩进一致：YAML 是基于缩进的，确保每一层的缩进量相同。不要使用混合空格和制表符。
多行字符串：如果值是多行文本，使用 |（保留换行符）或 >（折叠换行符）来处理多行字符串。
yaml

multiline: |
This is
a multiline
string.
或者
yaml

multiline: >
This is
a folded
string.
避免不必要的引号：如果值中没有特殊字符（如空格、冒号等），可以不使用引号。仅在需要时使用引号。
yaml

key: "value with spaces"
键值对的顺序：YAML 中键值对没有严格的顺序要求，但保持一致性有助于可读性。
小结：
YAML 格式化是通过调整缩进、换行和空格等方式，使得 YAML 数据更清晰、易于理解和维护。格式化后的 YAML 文件结构更明了，便于开发者修改和扩展。在多人合作的项目中，统一的格式化有助于减少因格式不一致导致的问题。