RuboCop

服务和保护 Ruby 代码的 Lint 工具和格式化工具

在 GitHub 上查看 阅读文档 风格指南

概述

RuboCop 是一个基于社区驱动的 Ruby 风格指南 的 Ruby 代码风格检查器(Lint 工具)和格式化工具。

RuboCop 非常灵活,其大部分行为可以通过各种配置选项进行调整。实际上,RuboCop 支持几乎所有你能想到的(比较流行的)编码风格。

除了报告代码中的问题,RuboCop 还可以自动修复其中的一些问题。

安装

RuboCop 的安装非常标准

$ gem install rubocop

如果你想使用 bundler 安装 RuboCop,在你的 Gemfile 中添加一行(但将 require 选项设置为 false,因为它是一个独立的工具)

gem 'rubocop', require: false

使用

在没有参数的情况下运行 rubocop 将检查当前目录中的所有 Ruby 源文件

$ rubocop

或者,你可以指定要检查的文件和目录列表

$ rubocop app spec lib/something.rb

你也可以模拟 ruby -wc 的行为

$ rubocop -l

你可以使用 rubocop -a 自动修复违规

$ rubocop -a

你可以使用 rubocop -x 将自动修复限制为与布局/格式相关的违规

$ rubocop -x

RuboCop 可以做更多的事情。使用 -h 查看所有可用的命令行选项。

兼容性

RuboCop 支持 MRI 2.7+ 和 JRuby 9.4+。