sue445/rubocop_auto_corrector

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# RubocopAutoCorrector

Run `rubocop --autocorrect && git commit` with each cop.

[![Gem Version](https://badge.fury.io/rb/rubocop_auto_corrector.svg)](https://badge.fury.io/rb/rubocop_auto_corrector)
[![Build Status](https://github.com/sue445/rubocop_auto_corrector/workflows/test/badge.svg?branch=master)](https://github.com/sue445/rubocop_auto_corrector/actions?query=workflow%3Atest)
[![Maintainability](https://api.codeclimate.com/v1/badges/384834e50f94e344c439/maintainability)](https://codeclimate.com/github/sue445/rubocop_auto_corrector/maintainability)
[![Coverage Status](https://coveralls.io/repos/github/sue445/rubocop_auto_corrector/badge.svg?branch=master)](https://coveralls.io/github/sue445/rubocop_auto_corrector?branch=master)

## Example
See https://github.com/sue445/rubocop_auto_corrector/pull/3/commits

## Requirements
* Ruby
* git

## Installation

Add this line to your application's Gemfile:

```ruby
group :development do
  gem 'rubocop_auto_corrector', require: false
end
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install rubocop_auto_corrector

## Usage
```bash
$ bundle exec rubocop_auto_corrector
```

## Help
```bash
$ bundle exec rubocop_auto_corrector --help
Usage: rubocop_auto_corrector [options]
        --autocorrect-count COUNT    Run `rubocop --autocorrect` and `git commit` for this number of times. (default. 2)
        --auto-correct-count COUNT   Same to '--autocorrect-count' (deprecated)
        --all                        Whether run `rubocop` with `--autocorrect-all`. (default. run with `--autocorrect`)
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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](https://rubygems.org).

## Contributing

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

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).