ymlfmt Docker 镜像文档

镜像概述和主要用途

ymlfmt 是一个 YAML 格式化工具，功能类似于 gofmt 和 markdownfmt。该 Docker 镜像提供了一个便捷的方式来使用 ymlfmt，无需在本地系统安装依赖，可直接用于格式化 YAML 文件，确保代码风格一致性和可读性。

核心功能和特性

• YAML 格式化：自动调整 YAML 文件的缩进、空格和结构
• 语法保持：格式化过程中保持 YAML 语法正确性
• 无依赖运行：通过 Docker 容器运行，无需本地安装
• 轻量级：基于精简基础镜像，体积小，启动快速
• 命令行操作：支持通过命令行参数自定义格式化行为

使用场景和适用范围

• 开发环境中 YAML 配置文件的格式化
• CI/CD 流程中集成 YAML 文件格式检查
• 团队协作中统一 YAML 文件格式标准
• 批量处理多个 YAML 文件
• 作为 Git 预提交钩子的一部分使用

使用方法和配置说明

基本使用方法

格式化单个文件

bash
docker run --rm -v $(pwd):/workspace tianon/ymlfmt ymlfmt /workspace/file.yaml

格式化目录中的所有 YAML 文件

bash
docker run --rm -v $(pwd):/workspace tianon/ymlfmt ymlfmt -w /workspace

Docker Compose 配置示例

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  ymlfmt:
    image: tianon/ymlfmt
    volumes:
      - ./:/workspace
    command: ymlfmt -w /workspace/configs

运行命令：

bash
docker-compose run --rm ymlfmt

命令行参数说明

高级用法示例

检查文件格式并显示差异

bash
docker run --rm -v $(pwd):/workspace tianon/ymlfmt ymlfmt -d /workspace/example.yaml

仅列出需要格式化的文件

bash
docker run --rm -v $(pwd):/workspace tianon/ymlfmt ymlfmt -l /workspace

结合 find 命令批量处理

bash
docker run --rm -v $(pwd):/workspace tianon/ymlfmt sh -c "find /workspace -name '*.yaml' -exec ymlfmt -w {} \;"

注意事项

• 确保挂载目录具有适当的读写权限
• 格式化前建议备份重要 YAML 文件
• 对于大型 YAML 文件，可能需要增加容器内存限制
• 不支持格式化压缩文件或网络文件系统中的文件

维护和更新

该镜像由 tianon 维护，源代码托管于 GitHub。建议定期更新镜像以获取最新功能和 bug 修复：

bash
docker pull tianon/ymlfmt