Skip to content

codacy/codacy-metrics-rubocop

Repository files navigation

Codacy-Metrics-RuboCop

Codacy Badge Codacy Badge CircleCI Docker Version

This is the metrics docker we use at Codacy to get Ruby file complexity, using RuboCop.

Usage

You can create the docker by doing:

./scripts/publish.sh

The docker is ran with the following command:

docker run -it -v $srcDir:/src  <DOCKER_NAME>:<DOCKER_VERSION>
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:

gem install rubocop

After that, you can run the tests:

./scripts/test.sh

What is Codacy

Codacy 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.