https://github.com/codacy/codacy-metrics-rubocop
https://github.com/codacy/codacy-metrics-rubocop
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codacy/codacy-metrics-rubocop
- Owner: codacy
- Created: 2018-07-13T19:05:17.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T18:55:40.000Z (over 1 year ago)
- Last Synced: 2025-04-20T11:43:56.423Z (about 1 year ago)
- Language: Scala
- Size: 66.4 KB
- Stars: 0
- Watchers: 14
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Codacy-Metrics-RuboCop
[](https://www.codacy.com/gh/codacy/codacy-metrics-rubocop?utm_source=github.com&utm_medium=referral&utm_content=codacy/codacy-metrics-rubocop&utm_campaign=Badge_Grade)
[](https://www.codacy.com/gh/codacy/codacy-metrics-rubocop?utm_source=github.com&utm_medium=referral&utm_content=codacy/codacy-metrics-rubocop&utm_campaign=Badge_Coverage)
[](https://circleci.com/gh/codacy/codacy-metrics-rubocop)
[](https://microbadger.com/images/codacy/codacy-metrics-rubocop "Get your own version badge on microbadger.com")
This is the metrics docker we use at Codacy to get Ruby file complexity, using [RuboCop](https://github.com/rubocop-hq/rubocop).
## Usage
You can create the docker by doing:
```bash
./scripts/publish.sh
```
The docker is ran with the following command:
```bash
docker run -it -v $srcDir:/src :
docker run -it -v $PWD/src/test/resources:/src codacy/codacy-metrics-rubocop:latest
```
## Test
Before running the tests, you need to install RuboCop
and add the binaries localtion to your path:
```bash
gem install rubocop
```
After that, you can run the tests:
```bash
./scripts/test.sh
```
## 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.