Repolode
提交项目
rubocop

rubocop/rubocop

Ruby 静态代码分析与格式化工具，依据社区 Ruby 风格指南检查代码，并可自动修复多数问题。

在 GitHub 查看官网
Star
12,921
Fork
3,164
未关闭 Issue
165
最近提交
1小时前

这是什么？

RuboCop 是一款面向 Ruby 的静态代码分析器（linter）和代码格式化工具。开箱即用时，它会执行社区 Ruby 风格指南中的多数规范，既能报告代码中的问题，也能自动修复其中很多。

几乎所有检查行为都可以通过配置项调整。它内置 LSP 服务器，可以在编辑器中实时运行同样的检查。官方支持 MRI 2.7+ 与 JRuby 9.4+，同时可分析面向 Ruby 2.0 及以上版本编写的代码。

通过 `gem install rubocop` 安装，或在 Gemfile 中添加依赖（设置 `require: false`），然后在项目目录执行 `rubocop` 即可开始使用。

核心功能

  • 01默认执行社区 Ruby 风格指南中的大量规范。
  • 02可自动修复检测到的多数违规问题。
  • 03支持通过 YAML 配置项灵活调整检查规则。
  • 04内置 LSP 服务器，可接入代码编辑器。
  • 05支持 MRI Ruby 2.7+ 与 JRuby 9.4+。

适用场景

  • 在团队的 Ruby 项目中统一代码风格。
  • 在 CI 中于合并代码前运行风格与静态检查。
  • 借助自动修复功能整理旧的 Ruby 代码。
  • 在编辑器中编写 Ruby 时获得实时风格提示。

快速上手

  1. 1

    使用 RubyGems 安装 RuboCop

    gem install rubocop
  2. 2

    进入你的 Ruby 项目目录并运行 RuboCop

    cd my/cool/ruby/project rubocop

使用前须知

  • 只能分析 Ruby 代码，不适用于其他语言。
  • 许多行为需要通过配置调整，为现有代码库做好设置需要一定投入。

收录于专题

代码检查与格式化工具

标签

#ruby#linter#code-formatter#static-analysis#code-style#devtools#hacktoberfest#rubocop#static-code-analysis

常见问题

rubocop 是什么？
Ruby 静态代码分析与格式化工具，依据社区 Ruby 风格指南检查代码，并可自动修复多数问题。 RuboCop 是一款面向 Ruby 的静态代码分析器（linter）和代码格式化工具。开箱即用时，它会执行社区 Ruby 风格指南中的多数规范，既能报告代码中的问题，也能自动修复其中很多。
rubocop 可以免费使用吗？用的什么许可证？
rubocop 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
rubocop 还在维护吗？
活跃维护中。rubocop 最近一次提交是在 2026年11月7日。
rubocop 适合用来做什么？
在团队的 Ruby 项目中统一代码风格。 在 CI 中于合并代码前运行风格与静态检查。 借助自动修复功能整理旧的 Ruby 代码。 在编辑器中编写 Ruby 时获得实时风格提示。
rubocop 怎么安装和运行？
使用 RubyGems 安装 RuboCop: gem install rubocop 进入你的 Ruby 项目目录并运行 RuboCop: cd my/cool/ruby/project rubocop
在哪里获取 rubocop？
源代码和安装说明在 GitHub 上：https://github.com/rubocop/rubocop

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目