thomasv314 / rubocop Goto Github PK

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

RuboCop is a Ruby static code analyzer. Out of the box it will enforce many of the guidelines outlined in the community Ruby Style Guide.

Most aspects of its behavior can be tweaked via various configuration options.

Apart from reporting problems in your code, RuboCop can also automatically fix some of the problems for you.

You can support my work on RuboCop via Salt and Gratipay.

RuboCop's installation is pretty standard:

$ gem install rubocop

If you'd rather install RuboCop using bundler, don't require it in your Gemfile:

gem 'rubocop', require: false

RuboCop's development is moving at a very rapid pace and there are often backward-incompatible changes between minor releases (since we haven't reached version 1.0 yet). To prevent an unwanted RuboCop update you might want to use a conservative version locking in your Gemfile:

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

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

$ cd my/cool/ruby/project
$ rubocop

You can read a ton more about RuboCop in its official manual.

RuboCop supports the following Ruby implementations:

• MRI 2.0
• MRI 2.1
• MRI 2.2
• MRI 2.3
• MRI 2.4
• JRuby 9.0+
• Rubinius 2.0+

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

• Bozhidar Batsov
• Jonas Arvidsson
• Yuji Nakayama
• Evgeni Dzhelyov

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.

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! :-)

You can also support my work on RuboCop via Salt and Gratipay.

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

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

RuboCop's changelog is available here.

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