Rubocop::JRuby

This is a collection of Rubocop extensions focused on enforcing specific JRuby practises and helping with specific refactoring.

Right now the idea is to focus on three tasks:

Make sure people don't put .jar to their require, as it is just redundant (JRuby/JarExtensionInRequire)
Enforce consistent Java class reference, e.g. com::something::ClassName vs Java::ComSomething::ClassName
Help enforce snake_case over CamelCase when using Java's classes

Installation

Add this line to your application's Gemfile:

gem 'rubocop-jruby', require: false

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rubocop-jruby

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Morozzzko/rubocop-jruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Code of Conduct

Everyone interacting in the Rubocop::JRuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Morozzzko / rubocop-jruby