rubocop-docker

RuboCop Docker镜像

镜像概述

rubocop-docker是Ruby代码静态分析工具RuboCop的Docker化镜像。RuboCop可对Ruby代码进行风格检查和质量分析，遵循Ruby社区代码风格指南。该镜像提供预配置的RuboCop运行环境，用户无需本地安装Ruby及相关依赖，通过Docker容器即可快速执行代码检查。

核心功能与特性

• 零依赖运行：无需在本地安装Ruby、RuboCop或相关gem，直接通过Docker容器启动
• 代码质量检查：支持Ruby代码的静态分析，检测代码风格问题、潜在错误及不符合社区规范的写法
• 即开即用：镜像已内置RuboCop，挂载代码目录即可执行检查，无需额外配置
• 权限兼容：支持通过指定用户ID（UID/GID）运行容器，避免因权限差异导致的文件访问问题

使用场景

• 本地开发：开发者在不配置Ruby环境的情况下，快速检查项目代码风格
• CI/CD集成：嵌入持续集成流程，自动化执行代码质量检查，确保代码提交符合规范
• 环境一致性：在不同开发或部署环境中使用统一版本的RuboCop，避免版本差异导致的检查结果不一致

使用方法

基本运行命令

通过以下Docker命令对当前目录下的Ruby代码执行检查：

console
docker container run --rm -t -u "$(id -u):$(id -g)" -v "$PWD":/work:ro docker.io/shakiyam/rubocop

参数说明：

• --rm：容器运行结束后自动删除容器文件
• -t：分配伪终端，优化命令行输出格式
• -u "$(id -u):$(id -g)"：指定容器运行的用户ID和组ID（使用当前用户ID，避免权限冲突）
• -v "$PWD":/work:ro：将当前工作目录（$PWD）以只读方式挂载到容器内的/work目录，供RuboCop检查
• docker.io/shakiyam/rubocop：镜像名称

自定义配置

若项目中存在RuboCop配置文件（如.rubocop.yml），挂载目录后RuboCop会自动读取该文件，按项目自定义规则执行检查。

许可证

MIT License

作者

Shinichi Akiyama