codeclimate/codeclimate-rubocop

Name: codeclimate-rubocop

Owner: Code Climate

Description: Code Climate Engine for Rubocop

Created: 2015-06-19 13:19:23.0

Updated: 2018-05-23 22:33:12.0

Pushed: 2018-04-10 19:47:50.0

Homepage: null

Size: 2181

Language: Ruby

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Code Climate Rubocop Engine

Code Climate

codeclimate-rubocop is a Code Climate engine that wraps the RuboCop static analysis tool. You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform.

RuboCop helps you enforce many of the guidelines outlined in the community Ruby Style Guide. Most aspects of its behavior can be tweaked via various configuration options, which are set in a .rubocop.yml file.

You can find some basic setup instructions and links to the RuboCop OSS project below. For additional Code Climate-specific config details, check out our RuboCop engine documentation.

Installation
  1. If you haven't already, install the Code Climate CLI.
  2. Run codeclimate engines:enable rubocop. This command both installs the engine and enables it in your .codeclimate.yml file.
  3. You're ready to analyze! Browse into your project's folder and run codeclimate analyze.
Need help?

For help with RuboCop, check out their documentation.

If you're running into a Code Climate issue, first check out our RuboCop engine docs and look over this project's GitHub Issues, as your question may have already been covered. If not, go ahead and open a support ticket with us.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.