Codacy CPPCheck

This is the docker engine we use at Codacy to have CPPCheck support. You can also create a docker to integrate the tool and language of your choice! Check the Docs section for more information.

Usage

You can create the docker by doing:

docker build --no-cache -f Dockerfile.base -t codacy-cppcheck-base:latest .
docker build -t codacy-cppcheck .

The docker is ran with the following command:

docker run --rm -v $srcDir:/src -v $configFile:/.codacyrc codacy-cppcheck

Generate Docs

Update the ARG toolVersion in Dockerfile
Run the documentation generator:

docker build --no-cache -f Dockerfile.base -t codacy-cppcheck-base:latest .
sbt doc-generator/run

Docs

Tool Developer Guide

Tool Developer Guide - Using Scala

Test

For a faster development loop you can create a Docker image based on the JVM instead of creating a native-image:

sbt stage
docker build --no-cache -f Dockerfile.base -t codacy-cppcheck-base:latest .
docker build -t codacy-cppcheck --target dev .

We use the codacy-plugins-test to test our external tools integration. You can follow the instructions there to make sure your tool is working as expected.

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.

martinbutt/codacy-cppcheck