A Ruby static code analyzer and formatter, based on the community Ruby style guide.
The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:
Role models are important.
-- Officer Alex J. Murphy / RoboCop
RuboCop is a Ruby static code analyzer (a.k.a.
) 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 you.
RuboCop is extremely flexible and most aspects of its behavior can be tweaked via variousconfiguration options.
Please consider financially supporting its ongoing development.
RuboCop's installation is pretty standard:
$ gem install rubocop
If you'd rather install RuboCop using
, add a line for it in your
(but set the
, as it is a standalone tool):
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 lock in your
gem 'rubocop', '~\> 0.88.0', require: false
in a Ruby project's folder and watch the magic happen.
$ cd my/cool/ruby/project $ rubocop
You can read a lot more about RuboCop in its official docs.
RuboCop supports the following Ruby implementations:
See compatibility for further details.
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.
Here's a list of RuboCop's core developers:
The logo is licensed under aCreative 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 shortcontribution 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! :-)
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.
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-2020 Bozhidar Batsov. See LICENSE.txt for further details.