安装YAML Formatter插件并配置ruamel.yaml依赖,设置保存自动格式化或快捷键即可实现sublime Text中YAML文件的自动格式化。

在 sublime text 中配置 YAML/YML 文件的自动格式化,可以通过安装插件并设置快捷键或保存时自动触发来实现。虽然 Sublime 本身不自带 YAML 格式化功能,但借助社区插件可以轻松完成。
1. 安装必要的插件
使用 Package Control 安装以下插件之一:
- YAML Formatter:专为 YAML 设计的格式化工具,依赖于 python 的
ruamel.yaml库。 - jsFormat 或 html-css-JS Prettify:部分支持 YAML,但推荐优先选择专用插件。
- SublimeAStyleFormatter:主要用于 c++,不推荐用于 YAML。
推荐使用 YAML Formatter,步骤如下:
- 按下 Ctrl+Shift+P(mac 上是 Cmd+Shift+P)打开命令面板。
- 输入 “Package Control: Install Package”,回车。
- 搜索 “YAML Formatter”,点击安装。
2. 安装 ruamel.yaml(必需依赖)
该插件依赖 Python 的 ruamel.yaml 模块,需手动安装:
- 打开终端(命令行)。
- 运行命令:pip install ruamel.yaml
- 如果系统有多个 Python 版本,可能需要使用 pip3 install ruamel.yaml。
确保 Sublime 使用的 Python 环境能访问到这个库。
3. 配置插件设置(可选)
安装完成后,可以自定义格式化行为:
- 进入菜单栏:Preferences → Package Settings → YAML Formatter → Settings。
- 修改配置,例如缩进、是否换行等。示例配置:
{ “yaml_indent_mapping”: 2, “yaml_indent_sequence”: 4, “yaml_indent_offset”: 2, "on_save": true // 保存时自动格式化 }
4. 设置自动格式化或绑定快捷键
让格式化更高效:
- 保存时自动格式化:在设置中开启
"on_save": true,每次保存 .yml 文件会自动整理结构。 - 绑定快捷键:进入 Preferences → Key Bindings,添加快捷键,例如:
[ { “keys”: [“ctrl+alt+f”], “command”: “yaml_formatter” } ]
之后按 Ctrl+Alt+F 即可快速格式化当前 YAML 文件。
5. 确保文件被识别为 YAML
如果文件未正确识别,右下角语法可能是 “Plain Text” 而非 “YAML”:
- 点击右下角语法标识。
- 选择 Open all with current extension as… → YAML。
- 这样插件才能正确触发。
基本上就这些。配置一次后,YAML 编辑会清爽很多,尤其适合写 docker Compose、ansible、CI/CD 配置等场景。关键是装对插件 + 装好依赖库 + 设置保存自动执行。不复杂但容易忽略依赖安装。


