Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kvokka/rubocop_pr
Create 1 PR per 1 Rubocop linter, which allow to do review rubocop changes smoothly.
https://github.com/kvokka/rubocop_pr
automatization lint rubocop rubocop-pr
Last synced: 1 day ago
JSON representation
Create 1 PR per 1 Rubocop linter, which allow to do review rubocop changes smoothly.
- Host: GitHub
- URL: https://github.com/kvokka/rubocop_pr
- Owner: kvokka
- License: mit
- Created: 2019-08-06T13:19:39.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-27T12:38:07.000Z (over 3 years ago)
- Last Synced: 2024-09-07T02:28:45.665Z (26 days ago)
- Topics: automatization, lint, rubocop, rubocop-pr
- Language: Ruby
- Size: 75.2 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# RubocopPr
[![Version ][rubygems_badge]][rubygems]
[![Build Status ][travisci_badge]][travisci]
[![Codacy Badge ][codacy_badge]][codacy]
[![Reviewed by Hound ][hound_badge]][hound]
CLI Issues and PR creator for Rubocop Cops. 1 linter == 1 issue == 1 PR.
Simplify the inception or version bump of [Rubocop][rubocop_repo] on the project.
With RubocopPr you can apply [Rubocop][rubocop_repo] clean and in a few minutes,
see the [example][rubocop_pr_example].
## Requirements
* Ruby 2.1+
* Hub 2.12.3 (tested with this version only, but should work with older versions)
* Github
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'rubocop_pr', require: false
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install rubocop_pr
## Usage
```bash
Usage: rubocop_pr [options]
-k, --post-checkout [command] Running after each git checkout (default: "")
-c, --continue Continue previous session (default: false)
-b, --branch [branch] internal branch with '.rubocop_todo.yml' (default: 'rubocop_todo_branch')
-m, --master [branch] branch which will be the base for all PR's (default: 'master')
-v, --version Display version
-o, --origin [origin] origin option for 'git push' (default: 'origin')
-u, --hub-version [version] Set manually minimum required version of 'hub' utility for github (default: 2.12.3)
-i, --issue-labels [labels] Labels for created issues, separated by comma (default: rubocop)
-p [labels], Labels for created pull requests, separated by comma (default: rubocop)
--pull-request-labels
-a, --issue-assignees [name] Issue assignees, separated by comma (default: "")
-t [name], Pull request assignees, separated by comma (default: "")
--pull-request-assignees
-r [name], Pull request reviewers, separated by comma (default: "")
--pull-request-reviewers
-g, --repository [name] Set repository host (default: github)
-l, --limit [limit] Limit the PS's for one run (default: 10)
-h, --help Display help
```
#### Notes
* `brach` option is useful, if you want to prepare the `.rubocop-todo.yml` manually and feed it to `rubocop_pr`.
* `post-checkout` handy for old Ruby versions, when shell may "forget" Ruby version.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/kvokka/rubocop_pr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant][contributor_covenant_link] code of conduct.
## License
The gem is available as open source under the terms of the [MIT License][mit_link].
## Code of Conduct
Everyone interacting in the RubocopPr project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct][code_of_conduct_link].
[rubocop_repo]: https://github.com/rubocop-hq/rubocop
[contributor_covenant_link]: http://contributor-covenant.org
[mit_link]: https://opensource.org/licenses/MIT
[code_of_conduct_link]: https://github.com/[USERNAME]/rubocop_pr/blob/master/CODE_OF_CONDUCT.md
[rubocop_pr_example]: https://github.com/kvokka/rubocop_pr_example
[travisci_badge]: https://travis-ci.org/kvokka/rubocop_pr.svg?branch=master
[travisci]: https://travis-ci.org/kvokka/rubocop_pr
[rubygems]: https://rubygems.org/gems/rubocop_pr
[rubygems_badge]: http://img.shields.io/gem/v/rubocop_pr.svg
[codacy_badge]: https://api.codacy.com/project/badge/Grade/8be41ff90d294d7bb4c01fb3c98ebac9
[codacy]: https://app.codacy.com/app/kvokka/rubocop_pr?utm_source=github.com&utm_medium=referral&utm_content=kvokka/rubocop_pr&utm_campaign=Badge_Grade_Dashboard
[hound_badge]: https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg
[hound]: https://houndci.com