{"id":19359778,"url":"https://github.com/codacy/codacy-rubocop","last_synced_at":"2025-08-26T22:15:15.553Z","repository":{"id":36360315,"uuid":"40665107","full_name":"codacy/codacy-rubocop","owner":"codacy","description":"Codacy Tool for Rubocop","archived":false,"fork":false,"pushed_at":"2025-08-15T22:15:42.000Z","size":2168,"stargazers_count":5,"open_issues_count":12,"forks_count":11,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-08-17T22:31:38.181Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codacy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-08-13T15:04:24.000Z","updated_at":"2025-08-01T16:27:18.000Z","dependencies_parsed_at":"2024-02-13T16:27:16.199Z","dependency_job_id":"9d52aae4-263b-40a6-805b-4f1da3154de9","html_url":"https://github.com/codacy/codacy-rubocop","commit_stats":null,"previous_names":[],"tags_count":297,"template":false,"template_full_name":null,"purl":"pkg:github/codacy/codacy-rubocop","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-rubocop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-rubocop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-rubocop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-rubocop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codacy","download_url":"https://codeload.github.com/codacy/codacy-rubocop/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codacy%2Fcodacy-rubocop/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272261030,"owners_count":24902393,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-26T02:00:07.904Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T07:16:07.659Z","updated_at":"2025-08-26T22:15:15.511Z","avatar_url":"https://github.com/codacy.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Codacy Badge](https://api.codacy.com/project/badge/Grade/7cb874a40208406dbe62fe96d6b3a727)](https://www.codacy.com/gh/codacy/codacy-rubocop?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=codacy/codacy-rubocop\u0026amp;utm_campaign=Badge_Grade)\n[![Build Status](https://circleci.com/gh/codacy/codacy-rubocop.svg?style=shield\u0026circle-token=:circle-token)](https://circleci.com/gh/codacy/codacy-rubocop)\n\n# Codacy Rubocop\n\nThis is the docker engine we use at Codacy to have [Rubocop](https://www.rubocop.org) support.\nYou can also create a docker to integrate the tool and language of your choice!\nSee the [codacy-engine-scala-seed](https://github.com/codacy/codacy-engine-scala-seed) repository for more information.\n\n## Usage\n\nYou can create the docker by doing:\n\n```\nsbt universal:stage\ndocker build -t codacy-rubocops .\n```\n\nThe docker is ran with the following command:\n\n```\ndocker run -it -v $srcDir:/src  \u003cDOCKER_NAME\u003e:\u003cDOCKER_VERSION\u003e\n```\n\n## Add plugin\n\nRubocop is moving some checks to separate repositories, as an example you can check\nhttps://github.com/rubocop-hq/rubocop/pull/6890\n\nThere are some important details to take into consideration:\n- Add dependency to Gemfile\n- Add it to src/main/scala/codacy/rubocop/Rubocop.scala\n\n```diff\n- private val plugins: List[String] = List(\"rubocop-performance\")\n+ private val plugins: List[String] = List(\"rubocop-performance\", \"rubocop-style\")\n```\n\n- Add it to doc_generation/codacy/rubocop/generator.rb\n\n```diff\n- $plugins = [\"rubocop-performance\"]\n+ $plugins = [\"rubocop-performance\", \"rubocop-style\"]\n```\n\n- `bundle install` so the examples for the documentation are made available at\n`vendor/bundle/ruby/{ruby_version}/gems/{plugin}/lib/rubocop/cop/*/*.rb`\n- Adding the plugin to the `$plugins` will also make the script to *require* it,\nto be able to fetch Cops for the base documentation\n\n## Test\n\nWe use the [codacy-plugins-test](https://github.com/codacy/codacy-plugins-test) to test our external tools integration.\nYou can follow the instructions there to make sure your tool is working as expected.\n\n## Update Version with Docs\n\n```sh\nbundle update\nbundle config set --local path 'vendor/bundle'\nbundle install\n./scripts/doc_generate.sh \u003cdocs_location\u003e\n```\n\nNotes on the documentation generation:\n- You need to *require* the plugin, so they are injected on the *registry* when fetching the available Cops\n- After the `bundle install` the documentation generator will fetch examples from the Cops of the added plugins\n\n## What is Codacy?\n\n[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.\n\n### Among Codacy’s features:\n\n- Identify new Static Analysis issues\n- Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)\n- Auto-comments on Commits and Pull Requests\n- Integrations with Slack, HipChat, Jira, YouTrack\n- Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories\n\nCodacy also helps keep track of Code Coverage, Code Duplication, and Code Complexity.\n\nCodacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.\n\n### Free for Open Source\n\nCodacy is free for Open Source projects.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodacy%2Fcodacy-rubocop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodacy%2Fcodacy-rubocop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodacy%2Fcodacy-rubocop/lists"}