Codacy Ameba

Tooling & Docker Definition for running Ameba on Codacy

Implements the Tool Developer Guide

Usage

Build the docker image

docker build -t codacy-ameba .

Run on a project

docker run --rm -v $srcDir:/src codacy-ameba

Regenerate docs folder:

shards install
crystal src/generate.cr

Testing

Run regular unit tests: crystal spec

Run Codacy Plugin Tests against the docker image:

docker build -t codacy-ameba .

codacy-plugins-test pattern codacy-ameba
codacy-plugins-test json codacy-ameba
codacy-plugins-test multiple codacy-ameba

Bump versions

• Crystal version should be updated in Dockerfile file (version of the image).
• Ameba version should be updated in shard.yml/shard.lock files.

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.

Contributing

1. Fork it (https://github.com/codacy/codacy-ameba/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• Vitalii Elenhaupt - creator and maintainer
• Sija Sijawusz Pur Rahnama - contributor and maintainer