https://github.com/codeclimate/codeclimate-rubocop

Code Climate Engine for Rubocop
https://github.com/codeclimate/codeclimate-rubocop

code-quality codeclimate codeclimate-engine complexity linter linting metrics performance quality rails rubocop ruby security static-analysis static-code-analysis

Last synced: 22 days ago
JSON representation

Code Climate Engine for Rubocop

• Host: GitHub
• URL: https://github.com/codeclimate/codeclimate-rubocop
• Owner: codeclimate
• License: mit
• Created: 2015-06-19T13:19:23.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-07-01T16:54:02.000Z (7 months ago)
• Last Synced: 2024-12-24T06:09:29.494Z (29 days ago)
• Topics: code-quality, codeclimate, codeclimate-engine, complexity, linter, linting, metrics, performance, quality, rails, rubocop, ruby, security, static-analysis, static-code-analysis
• Language: Ruby
• Homepage:
• Size: 2.71 MB
• Stars: 60
• Watchers: 30
• Forks: 46
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Code Climate Rubocop Engine

[![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate-rubocop/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate-rubocop)

`codeclimate-rubocop` is a Code Climate engine that wraps the [RuboCop](https://github.com/rubocop-hq/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](https://github.com/rubocop-hq/ruby-style-guide). Most aspects of its behavior can be tweaked via various [configuration options](https://github.com/rubocop-hq/rubocop/blob/master/config/default.yml), 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][cc-docs-rubocop].

### Installation

1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).

2. Enable the engine by adding the following under `plugins` in your `.codeclimate.yaml`:

    ```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](https://github.com/rubocop-hq/rubocop).

If you're running into a Code Climate issue, first check out [our RuboCop engine docs][cc-docs-rubocop] and look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-rubocop/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help).

[cc-docs-rubocop]: https://docs.codeclimate.com/docs/rubocop