dcycle/yaml-lint

Dcycle YAML Lint 镜像文档

镜像概述

Dcycle YAML Lint 是一个轻量级Docker镜像，基于yamllint工具构建，专门用于对YAML文件进行语法检查和风格验证。通过容器化方式提供开箱即用的YAML lint环境，无需在本地配置yamllint依赖，即可快速检测YAML文件中的语法错误、格式问题及风格不一致，确保文件符合规范。

核心功能与特性

• 基于yamllint工具：集成yamllint（YAML语法检查工具），支持检测语法错误、缩进问题、键重复等常见YAML格式问题。
• 零依赖部署：容器化设计，无需本地安装Python或yamllint，直接通过Docker命令运行，简化环境配置。
• 灵活检查范围：支持检查单个YAML文件、目录下所有YAML文件（自动识别.yaml/.yml扩展名）。
• 自定义配置支持：可挂载本地yamllint配置文件（如.yamllint），自定义检查规则（如缩进空格数、允许的键格式等）。

使用场景与适用范围

• 开发环境本地检查：开发人员在提交代码前，快速检查YAML配置文件（如docker-compose.yml、Kubernetes配置、CI配置等）的格式合法性。
• CI/CD流程集成：作为代码质量检查环节，在CI流水线中自动运行，拒绝格式错误的YAML文件合并入代码库。
• 团队规范统一：通过共享yamllint配置文件，确保团队成员使用一致的YAML风格，减少因格式差异导致的协作问题。

使用方法与配置说明

基本使用：检查单个YAML文件

将本地YAML文件挂载到容器内，执行yamllint检查：

bash
docker run --rm -v $(pwd):/app dcycle/yaml-lint:latest yamllint /app/your-config.yaml

• 参数说明：
  • --rm：容器运行结束后自动删除，避免残留容器。
  • -v $(pwd):/app：将当前工作目录（包含待检查文件）挂载到容器内的/app目录。
  • dcycle/yaml-lint:latest：镜像名称及标签（默认使用最新版本）。
  • yamllint /app/your-config.yaml：执行yamllint命令，检查容器内路径/app/your-config.yaml（对应本地your-config.yaml）。

检查目录下所有YAML文件

若需检查当前目录下所有.yaml/.yml文件，可直接指定目录路径：

bash
docker run --rm -v $(pwd):/app dcycle/yaml-lint:latest yamllint /app

使用自定义yamllint配置

如需自定义检查规则（如调整缩进为2空格、允许特定注释格式等），可通过本地.yamllint配置文件实现：

1. 本地创建.yamllint配置文件（参考yamllint配置文档），示例：

   yaml
   extends: default
   rules:
     indentation:
       spaces: 2
       indent-sequences: consistent
     line-length: disable
   

2. 挂载配置文件并指定检查：

   bash
   docker run --rm -v $(pwd):/app -v $(pwd)/.yamllint:/etc/yamllint/config dcycle/yaml-lint:latest yamllint -c /etc/yamllint/config /app/your-config.yaml
   

   • -v $(pwd)/.yamllint:/etc/yamllint/config：将本地.yamllint挂载到容器内的配置路径。
   • -c /etc/yamllint/config：显式指定yamllint使用挂载的配置文件。

高级参数示例

通过yamllint原生参数自定义输出格式或检查规则：

• JSON格式输出（便于CI工具解析）：

  bash
  docker run --rm -v $(pwd):/app dcycle/yaml-lint:latest yamllint -f json /app/your-config.yaml
  

• 仅显示错误（忽略警告）：

  bash
  docker run --rm -v $(pwd):/app dcycle/yaml-lint:latest yamllint -d "{rules: {warning: {level: error}}}" /app/your-config.yaml
  

参考文档

完整使用说明及更多示例，请参见GitHub仓库：https://github.com/dcycle/docker-yaml-lint