• Stars
    star
    12,608
  • Rank 2,532 (Top 0.06 %)
  • Language
    Ruby
  • License
    MIT License
  • Created over 12 years ago
  • Updated 9 days ago

Reviews 5.0 (1)

about 1 year ago by Marc Anguera

Rubocop is probably the de facto linter and static code analyzer for Ruby. It comes with some "sensible" defaults, but it's really really flexible, so your team can easily customize your preferences. The hardest part is to align those preferences :) That's why probably Standard Ruby exists.

Repository Details

A Ruby static code analyzer and formatter, based on the community Ruby style guide.

RuboCop Logo


Ruby Style Guide Gem Version CircleCI Status Actions Status Test Coverage Maintainability Discord

Role models are important.
-- Officer Alex J. Murphy / RoboCop

RuboCop is a Ruby static code analyzer (a.k.a. linter) and code formatter. Out of the box it will enforce many of the guidelines outlined in the community Ruby Style Guide. Apart from reporting the problems discovered in your code, RuboCop can also automatically fix many of them for you.

RuboCop is extremely flexible and most aspects of its behavior can be tweaked via various configuration options.


Patreon OpenCollective OpenCollective Tidelift

Working on RuboCop is often fun, but it also requires a great deal of time and energy.

Please consider financially supporting its ongoing development.

Installation

RuboCop's installation is pretty standard:

$ gem install rubocop

If you'd rather install RuboCop using bundler, add a line for it in your Gemfile (but set the require option to false, as it is a standalone tool):

gem 'rubocop', require: false

RuboCop is stable between minor versions, both in terms of API and cop configuration. We aim to ease the maintenance of RuboCop extensions and the upgrades between RuboCop releases. All big changes are reserved for major releases. To prevent an unwanted RuboCop update you might want to use a conservative version lock in your Gemfile:

gem 'rubocop', '~> 1.63', require: false

See our versioning policy for further details.

Quickstart

Just type rubocop in a Ruby project's folder and watch the magic happen.

$ cd my/cool/ruby/project
$ rubocop

You can also use this magic in your favorite editor with RuboCop's built-in LSP server.

Documentation

You can read a lot more about RuboCop in its official docs.

Compatibility

RuboCop officially supports the following runtime Ruby implementations:

  • MRI 2.7+
  • JRuby 9.4+

Targets Ruby 2.0+ code analysis.

See the compatibility documentation for further details.

Readme Badge

If you use RuboCop in your project, you can include one of these badges in your readme to let people know that your code is written following the community Ruby Style Guide.

Ruby Style Guide

Ruby Style Guide

Here are the Markdown snippets for the two badges:

[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)

[![Ruby Style Guide](https://img.shields.io/badge/code_style-community-brightgreen.svg)](https://rubystyle.guide)

Team

Here's a list of RuboCop's core developers:

See the team page for more details.

Logo

RuboCop's logo was created by Dimiter Petrov. You can find the logo in various formats here.

The logo is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.

Contributors

Here's a list of all the people who have contributed to the development of RuboCop.

I'm extremely grateful to each and every one of them!

If you'd like to contribute to RuboCop, please take the time to go through our short contribution guidelines.

Converting more of the Ruby Style Guide into RuboCop cops is our top priority right now. Writing a new cop is a great way to dive into RuboCop!

Of course, bug reports and suggestions for improvements are always welcome. GitHub pull requests are even better! :-)

Funding

While RuboCop is free software and will always be, the project would benefit immensely from some funding. Raising a monthly budget of a couple of thousand dollars would make it possible to pay people to work on certain complex features, fund other development related stuff (e.g. hardware, conference trips) and so on. Raising a monthly budget of over $5000 would open the possibility of someone working full-time on the project which would speed up the pace of development significantly.

We welcome both individual and corporate sponsors! We also offer a wide array of funding channels to account for your preferences (although currently Open Collective is our preferred funding platform).

If you're working in a company that's making significant use of RuboCop we'd appreciate it if you suggest to your company to become a RuboCop sponsor.

You can support the development of RuboCop via GitHub Sponsors, Patreon, PayPal, Open Collective and Tidelift .

Note: If doing a sponsorship in the form of donation is problematic for your company from an accounting standpoint, we'd recommend the use of Tidelift, where you can get a support-like subscription instead.

Open Collective Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

Open Collective Sponsors

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]

Changelog

RuboCop's changelog is available here.

Copyright

Copyright (c) 2012-2024 Bozhidar Batsov. See LICENSE.txt for further details.

More Repositories

1

ruby-style-guide

A community-driven Ruby coding style guide
16,439
star
2

rails-style-guide

A community-driven Ruby on Rails style guide
6,469
star
3

rspec-style-guide

Best practices for writing your specs!
952
star
4

rubocop-rspec

Code style checking for RSpec files.
Ruby
804
star
5

rubocop-rails

A RuboCop extension focused on enforcing Rails best practices and coding conventions.
Ruby
799
star
6

rubocop-performance

An extension of RuboCop focused on code performance checks.
Ruby
665
star
7

guard-rubocop

Guard plugin for RuboCop
Ruby
262
star
8

rubocop-minitest

Code style checking for Minitest files.
Ruby
134
star
9

rubocop-emacs

An Emacs interface for RuboCop
Emacs Lisp
128
star
10

rubocop-ast

RuboCop's AST extensions and NodePattern functionality
Ruby
99
star
11

rubocop-rake

A RuboCop plugin for Rake
Ruby
75
star
12

rubocop-md

RuboCop for Markdown code snippets
Ruby
71
star
13

minitest-style-guide

Best practices for writing your tests
68
star
14

rubocop-jp

A place for RuboCop discussions in Japanese
55
star
15

rubocop-extension-generator

A generator of RuboCop's custom cops gem.
Ruby
48
star
16

vscode-rubocop

The official VS Code extension for the RuboCop linter and code formatter.
TypeScript
47
star
17

rubocop-factory_bot

Code style checking for factory_bot files.
Ruby
44
star
18

rubocop-capybara

Code style checking for Capybara files.
Ruby
39
star
19

rubocop-sequel

Code style checking for Sequel
Ruby
28
star
20

rubocop-rubycw

Wrap ruby -cw by RuboCop
Ruby
26
star
21

rubocop-rspec_rails

Code style checking for Rails-related RSpec files.
Ruby
14
star
22

blog.rubystyle.guide

A companion blog to the community Ruby, Rails and RSpec guides
HTML
7
star
23

packaging-style-guide

Best practices for writing downstream compatible code!
6
star
24

docs.rubocop.org

RuboCop's documentation site
Handlebars
4
star
25

circleci-ruby-snapshot-image

Builds a Ruby nightly image and publishes it to Docker Hub
Ruby
3
star
26

.github

2
star
27

capybara-style-guide

A community-driven Capybara coding style guide
1
star