This is the docker engine we use at Codacy to have Staticcheck support. You can also create a docker to integrate the tool and language of your choice! Check the Docs section for more information.
You can create the docker by doing:
sbt docker:publishLocalThe docker is ran with the following command:
docker run -it -v $srcDir:/src <DOCKER_NAME>:<DOCKER_VERSION>Tool Developer Guide - Using Scala
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.
Make sure that you have the raw-docs for the version that you want to target.
For example, to generate documentation for version 2017.2.2, the underlying tool documentation must be available at src/main/resources/raw-docks/2017.2.2.
Using the version 2017.2.2 as example, you should copy all the files
from https://github.com/dominikh/go-tools/tree/2017.2.2/cmd/staticcheck/docs/checks
to the src/main/resources/raw-docks/2017.2.2.
As long as the raw-docs are available, running the command above will generate the patterns.json and description.json:
sbt "run-main codacy.staticcheck.DocGenerator <version-of-the-tool>"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.
- 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.
Codacy is free for Open Source projects.