/codeclimate-rubocop

Code Climate Engine for Rubocop

Primary LanguageRubyMIT LicenseMIT

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. Enable the engine by adding the following under plugins in your .codeclimate.yaml: 
    plugins:
  rubocop:
    enabled: true
  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.