RuboCop GitLab Formatter
A very simple RuboCop formatter that renders a json compliant with the Gitlab CodeQuality format.
Installation
Add this line to your application's Gemfile:
gem 'rubocop-gitlab_formatter', require: false
And then execute:
$ bundle
Or install it yourself as:
$ gem install rubocop-gitlab_formatter
Usage
rubocop --require rubocop-gitlab_formatter --format RuboCop::Formatter::GitLabFormatter
Or require it in .rubocop.yml
:
require:
- rubocop-gitlab_formatter
The main purpose of the formatter is to be used with the GitLab code quality report.
Configure your .gitlab-ci.yml
like that:
rubocop:
artifacts:
reports:
codequality: codequality_reports.json
script:
- rubocop --require rubocop-gitlab_formatter --format RuboCop::Formatter::GitLabFormatter --out codequality_reports.json
And enjoy the Code Quality features 🎉
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jojos003/rubocop-gitlab_formatter.
License
The gem is available as open source under the terms of the MIT License.