https://github.com/codacy/codacy-rubocop
Codacy Tool for Rubocop
https://github.com/codacy/codacy-rubocop
Last synced: 5 months ago
JSON representation
Codacy Tool for Rubocop
- Host: GitHub
- URL: https://github.com/codacy/codacy-rubocop
- Owner: codacy
- License: other
- Created: 2015-08-13T15:04:24.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-08-15T22:15:42.000Z (5 months ago)
- Last Synced: 2025-08-17T22:31:38.181Z (5 months ago)
- Language: Ruby
- Homepage:
- Size: 2.07 MB
- Stars: 5
- Watchers: 15
- Forks: 11
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://www.codacy.com/gh/codacy/codacy-rubocop?utm_source=github.com&utm_medium=referral&utm_content=codacy/codacy-rubocop&utm_campaign=Badge_Grade)
[](https://circleci.com/gh/codacy/codacy-rubocop)
# Codacy Rubocop
This is the docker engine we use at Codacy to have [Rubocop](https://www.rubocop.org) support.
You can also create a docker to integrate the tool and language of your choice!
See the [codacy-engine-scala-seed](https://github.com/codacy/codacy-engine-scala-seed) repository for more information.
## Usage
You can create the docker by doing:
```
sbt universal:stage
docker build -t codacy-rubocops .
```
The docker is ran with the following command:
```
docker run -it -v $srcDir:/src :
```
## Add plugin
Rubocop is moving some checks to separate repositories, as an example you can check
https://github.com/rubocop-hq/rubocop/pull/6890
There are some important details to take into consideration:
- Add dependency to Gemfile
- Add it to src/main/scala/codacy/rubocop/Rubocop.scala
```diff
- private val plugins: List[String] = List("rubocop-performance")
+ private val plugins: List[String] = List("rubocop-performance", "rubocop-style")
```
- Add it to doc_generation/codacy/rubocop/generator.rb
```diff
- $plugins = ["rubocop-performance"]
+ $plugins = ["rubocop-performance", "rubocop-style"]
```
- `bundle install` so the examples for the documentation are made available at
`vendor/bundle/ruby/{ruby_version}/gems/{plugin}/lib/rubocop/cop/*/*.rb`
- Adding the plugin to the `$plugins` will also make the script to *require* it,
to be able to fetch Cops for the base documentation
## Test
We use the [codacy-plugins-test](https://github.com/codacy/codacy-plugins-test) to test our external tools integration.
You can follow the instructions there to make sure your tool is working as expected.
## Update Version with Docs
```sh
bundle update
bundle config set --local path 'vendor/bundle'
bundle install
./scripts/doc_generate.sh
```
Notes on the documentation generation:
- You need to *require* the plugin, so they are injected on the *registry* when fetching the available Cops
- After the `bundle install` the documentation generator will fetch examples from the Cops of the added plugins
## What is Codacy?
[Codacy](https://www.codacy.com/) is an Automated Code Review Tool that monitors your technical debt, helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.
### Among Codacy’s features:
- Identify new Static Analysis issues
- Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)
- Auto-comments on Commits and Pull Requests
- Integrations with Slack, HipChat, Jira, YouTrack
- Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories
Codacy also helps keep track of Code Coverage, Code Duplication, and Code Complexity.
Codacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.
### Free for Open Source
Codacy is free for Open Source projects.