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 :tada:

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 the created tag, and push the .gem file to rubygems.org.

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.