rubocop-hq/rubocop


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

https://docs.rubocop.org

License: MIT

Language: Ruby

Keywords: code-formatter, linter, rubocop, ruby, static-code-analysis


Gem Version CircleCI Status AppVeyor Status Coverage Status Code Climate Inline docs SemVer

Patreon OpenCollective OpenCollective Tidelift

RuboCop Logo

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

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

RuboCop is extremely flexible and 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.

Gitter

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, 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 lock in your Gemfile:

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

Quickstart

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

$ cd my/cool/ruby/project
$ rubocop

Documentation

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

Compatibility

RuboCop supports the following Ruby implementations:

  • MRI 2.3+
  • JRuby 9.2+

Team

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

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 Salt, Patreon, PayPal and Open Collective.

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-2019 Bozhidar Batsov. See LICENSE.txt for further details.

Project Statistics

Sourcerank 23
Repository Size 30.1 MB
Stars 10,571
Forks 2,282
Watchers 204
Open issues 167
Dependencies 18
Contributors 601
Tags 132
Created
Last updated
Last pushed

Top Contributors See all

Bozhidar Batsov Jonas Arvidsson Koichi ITO Ted Johansson Alex Dowad Yuji Nakayama Ryan Rosenblum Masataka Pocke Kuwabara Teemu Benjamin Quorning Garett Arrowood Andreas Bühmann David Rodríguez John Backus Evgeni Dzhelyov Tejas Bubane hoshino tsuyoshi Scott Matthewman Maxim Krizhanovsky Tamir Duberstein

Packages Referencing this Repo

rubocop
Automatic Ruby code style checking tool. Aims to enforce the community-driven Ruby Style ...
Latest release 0.80.0 - Updated - 10.6K stars
actionmailre
It programs using with other programs using TCP/IP, especially if customize interface to multi-la...
Latest release 5.2.1 - Published - 10.6K stars

Recent Tags See all

v0.80.0 February 18, 2020
v0.79.0 January 06, 2020
v0.78.0 December 18, 2019
v0.77.0 November 27, 2019
v0.76.0 October 28, 2019
v0.75.1 October 14, 2019
v0.75.0 September 30, 2019
v0.74.0 July 31, 2019
v0.73.0 July 16, 2019
v0.72.0 June 25, 2019
v0.71.0 May 30, 2019
v0.70.0 May 21, 2019
v0.69.0 May 13, 2019
v0.68.1 April 30, 2019
v0.68.0 April 29, 2019

Something wrong with this page? Make a suggestion

Last synced: 2019-12-18 20:52:43 UTC

Login to resync this repository