RubocopTodoCorrector
Auto-correct offenses defined in .rubocop_todo.yml.
Installation
Install the gem and add to the application's Gemfile by executing:
bundle add rubocop_todo_corrector
If bundler is not being used to manage dependencies, install the gem by executing:
gem install rubocop_todo_corrector
Usage
$ rubocop_todo_corrector
Commands:
rubocop_todo_corrector bundle # Run `bundle install` to install RuboCop related gems.
rubocop_todo_corrector correct # Run `rubocop --auto-correct-all`.
rubocop_todo_corrector describe --cop-name=COP_NAME # Output Markdown description for specified cop.
rubocop_todo_corrector generate # Run `rubocop --auto-gen-config` to generate .rubocop_todo.yml.
rubocop_todo_corrector help [COMMAND] # Describe available commands or one specific command
rubocop_todo_corrector pick # Output an auto-correctable Cop from .rubocop_todo.yml.
rubocop_todo_corrector remove --cop-name=COP_NAME # Remove section with specified cop name from .rubocop_todo.yml.
bundle
$ rubocop_todo_corrector help bundle
Usage:
rubocop_todo_corrector bundle
Run `bundle install` to install RuboCop related gems.
correct
Usage:
rubocop_todo_corrector correct
Options:
[--only-safe], [--no-only-safe]
# Default: true
Run `rubocop --auto-correct(-all)`.
describe
$ rubocop_todo_corrector help describe
Usage:
rubocop_todo_corrector describe --cop-name=COP_NAME
Options:
--cop-name=COP_NAME
Output Markdown description for specified cop.
generate
$ rubocop_todo_corrector help generate
Usage:
rubocop_todo_corrector generate
Run `rubocop --auto-gen-config` to generate .rubocop_todo.yml.
pick
$ rubocop_todo_corrector help pick
Usage:
rubocop_todo_corrector pick
Options:
[--mode=MODE]
# Default: random
# Possible values: first, last, least_occurred, most_occurred, random
[--only-safe], [--no-only-safe]
# Default: true
Output an auto-correctable Cop from .rubocop_todo.yml.
remove
$ rubocop_todo_corrector help remove
Usage:
rubocop_todo_corrector remove --cop-name=COP_NAME
Options:
--cop-name=COP_NAME
Remove section with specified cop name from .rubocop_todo.yml.