groddeck / rubyjake Goto Github PK

RubyJake

RubyJake is a Ruby static code analyzer (a.k.a. linter) and code formatter forked from this excellent project . 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, RubyJake can also automatically fix many of them you.

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

This fork was created in order to rebrand this tool in honor of "jakes" an affectionate term for firefighters, whose daily, anonymous heroism evokes universal respect for this essential profession and its role in communities.

RubyJake's installation is pretty standard:

$ gem install rubocop

If you'd rather install RubyJake 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

RubyJake'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 RubyJake update you might want to use a conservative version lock in your Gemfile:

gem 'rubocop', '~> 0.85.1', 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 lot more about RubyJake in its official docs.

RubyJake supports the following Ruby implementations:

• MRI 2.4+
• JRuby 9.2+

RubyJake has customarily provided support for about a year after EOL of MRI Ruby version. This is done by RubyJake core to provide the community with a margin of transition.

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

• Bozhidar Batsov (author & head maintainer)
• Jonas Arvidsson
• Yuji Nakayama (retired)
• Evgeni Dzhelyov (retired)
• Ted Johansson
• Masataka Kuwabara
• Koichi Ito
• Maxim Krizhanovski
• Benjamin Quorning
• Marc-André Lafortune

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

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

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

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

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

RubyJake's changelog is available here.

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