Project

mry

0.09
No commit activity in last 3 years
No release in over 3 years
RuboCop has many breaking changes between releases. This tool migrates your RuboCop config, making updating RuboCop easier.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 Dependencies

Development

= 1.12.1
>= 0
~> 13.0
= 0.51.0

Runtime

>= 0.41.0
 Project Readme

Mry

Mry Migrates .Rubocop.Yml 💪

RuboCop has many many breaking changes, because it is before version 1.0. So, if you update your RuboCop version, .rubocop.yml breaks in many cases... This tool supports migrating .rubocop.yml. It automatically renames the configuration in your .rubocop.yml that was renamed by the updated RuboCop version. So, with this tool, you do not have to be afraid of updating RuboCop anymore!

Installation

Add this line to your application's Gemfile:

gem 'mry'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mry

Usage

Update .rubocop.yml to latest release:

$ mry .rubocop.yml

Update .rubocop.yml to a specified version:

$ mry --target=0.51.0 .rubocop.yml

And you can specify the current RuboCop version. If you specify a new RuboCop version, mry adds cops that were added in this new RuboCop version to your .rubocop.yml. With this feature, you can check new RuboCop cops with mry.

$ mry --from=0.50.0 --target=0.51.0 .rubocop.yml
$ cat .rubocop.yml
...


# The following cops are added between 0.50.0 and 0.51.0.
# The configurations are default.
# If you want to use a cop by default, remove a configuration for the cop from here.
# If you want to disable a cop, change `Enabled` to false.

# Supports --auto-correct
Gemspec/OrderedDependencies:
  Description: Dependencies in the gemspec should be alphabetically sorted.
  Enabled: true
  Include:
  - "**/*.gemspec"
  TreatCommentsAsGroupSeparators: true

# Supports --auto-correct
Lint/RedundantWithObject:
  Description: Checks for redundant `with_object`.
  Enabled: true

...

Example

Example Animation

Development

How to support new version RuboCop

Run bin/check_rubocop_update script (depend on Ruby 2.6 or higher). This script displays renamed, added and deleted cop names.

# Clone rubocop repository if it does not exist.
$ git clone https://github.com/rubocop-hq/rubocop/ ~/path/to/rubocop/
$ bin/check_rubocop_update v0.55.0 v0.56.0 ~/path/to/rubocop/

(...log...)

:added:
- Lint/SplatKeywordArguments
- Performance/InefficientHashSearch
- Lint/ErbNewArguments
- Rails/AssertNot
- Rails/RefuteMethods
:renamed:
- :before:
  - Style/EmptyLineAfterGuardClause
  :after:
  - Layout/EmptyLineAfterGuardClause
- :before:
  - Style/MethodMissing
  :after:
  - Style/MethodMissingSuper
  - Style/MissingRespondToMissing
:deleted: []

Update lib/mry/added_cops.rb and lib/mry/rewriters.rb with this result.

Note: Mry does not support deleted cops and split cops. See #37 and #38.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pocke/mry.

License

Copyright 2017-2018 Masataka Pocke Kuwabara

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.