rubocop-rubyfmt

rubyfmt-compliant Rubocop configuration.

Install the gem and add to the application's Gemfile by executing:

bundle add rubocop-rubyfmt

If bundler is not being used to manage dependencies, install the gem by executing:

gem install rubocop-rubyfmt

Add the plugin to your .rubocop.yml:

plugins:
  - rubocop-rubyfmt

Rubocop allows two ways to disable lints for a certain expression. You can disable them at the end of a line, like so:

'foo' # rubocop:disable Some/Lint

Alternatively, you can wrap the whole expression with comments on multiple lines.

# rubocop:disable Some/Lint
'foo'
# rubocop:enable Some/Lint

rubyfmt only supports comments on their own line, and thus the latter is the only one that will work.

Rubyfmt/NoEndOfLineRubocopDisables is a custom lint that prevents usages of the end-of-line format, and it includes an autocorrect.

All the disabled lints along with the rationale for disabling them is listed in config/default.yml.

The goal of these lints is not to prevent any violations, but to prevent lint violations specific to rubyfmt. Other lint violations may still occur after formatting: for example, a method body may get longer and cause a Metrics/MethodLength violation. Such violations are not covered by rubocop-rubyfmt.

There are also some matters of taste (especially in RuboCop's Style department) that rubyfmt doesn't automatically enforce but which may be modified by rubyfmt and cause failures. For example, rubyfmt does not currently enforce that multiline blocks must use do/end. For those who wish to leave formatting decisions entirely up to rubyfmt and not worry about them, there's a "full" config that more aggressively disables such lints, which you can include in your RuboCop config:

inherit_gem:
  rubocop-rubyfmt:
    - config/full.yml

You may also wish to instead read the file and pick-and-choose which ones to disable.

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 the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/reese/rubocop-rubyfmt.

The gem is available as open source under the terms of the MIT License.