ruboclean puts .rubocop.yml
into order. It groups the configuration into three groups:
require
, inherit_from
, etc.Namespaces
Namespace/Cops
Finally it orders the configurations alphabetically within these groups.
.rubocop.yml
:Rails/ShortI18n:
Enabled: true
Layout/LineLength:
Max: 120
Rails:
Enabled: true
AllCops:
Exclude:
- path/file_exists.rb
- path_with_files/**/*
- path/file_does_not_exist.rb # This entry will be removed if the file doesn't exist. Skip with --preserve-paths option.
- path_without_files/**/* # Will be removed if no files within pattern exist. Skip with --preserve-paths option.
# Preceding comments will be removed unless the --preserve-comments option is used.
require:
- rubocop-rails # Inline comments will always be removed.
.rubocop.yml
:---
require:
- rubocop-rails
AllCops:
Exclude:
- path/file_exists.rb
- path_with_files/**/*
Rails:
Enabled: true
Layout/LineLength:
Max: 120
Rails/ShortI18n:
Enabled: true
Add this line to your application's Gemfile:
gem "ruboclean", require: false
And then execute:
bundle install
Or install it yourself as:
gem install ruboclean
ruboclean [path] [--silent] [--preserve-comments] [--preserve-paths] [--verify]
Parameter | Description |
---|---|
path |
Can be a directory that contains a .rubocop.yml , or a path to a .rubocop.yml directly. Defaults to the current working directory. |
--silent |
Suppress any output displayed on the screen when executing the command. |
--preserve-comments |
Preserves preceding comments for each top-level entry in the configuration. Inline comments are not preserved. |
--preserve-paths |
Skips the path cleanup that are applied against Include: and Exclude: configuration. |
--verify |
Executes in dry-run mode. Exits with 1 if changes are needed, otherwise 0. |
ruboclean # uses `.rubocop.yml` of current working directory
ruboclean /path/to/dir # uses `.rubocop.yml` of /path/to/dir
ruboclean /path/to/dir/.rubocop.yml
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.
Bug reports and pull requests are welcome on GitHub at https://github.com/lxxxvi/ruboclean. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Ruboclean project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.