Project

ruboclean

0.01
The project is in a healthy, maintained state
rubocleanlxxxvi/rubocleanHomepageDocumentationSource CodeBug TrackerWiki
Cleans and orders settings in .rubocop.yml
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
43,611
Stars
18
Forks
4
Watchers
2
 Releases
Current version
0.6.0
Total releases
7
First release
2020-08-04
Latest release
2024-03-07
 Issues
Open Issues
1
Closed Issues
2
Total Issues
3
Issue Closure Rate
66%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
2
Merged Pull Requests
38
Pull Request Acceptance Rate
95%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2024-02-21
Reverse Dependencies
1

 Dependencies
 Project Readme

Continuous Integration Maintainability Test Coverage

ruboclean

ruboclean puts .rubocop.yml into order. It groups the configuration into three groups:

  1. "Base"-configuration like require, inherit_from, etc.
  2. Namespaces
  3. Namespace/Cops

Finally it orders the configurations alphabetically within these groups.

Example

Input .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.

Output .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

Installation

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

Command synopsis

ruboclean [path] [--silent] [--preserve-comments] [--preserve-paths] [--verify]

Parameters

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.

Examples

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

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/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.

License

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

Code of Conduct

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