codeclimate-codenarc
is a Code Climate engine for Groovy that wraps the CodeNarc static analysis tool. You can run it on your command line using the Code Climate CLI.
- only will run locally in dev mode after building locally from docker file
- categories for the rules could use some more curating along with the point values
- If you haven't already, install the Code Climate CLI.
- clone the repo and run
make test
to build the image locally and test it - Add a
.codeclimate.yml
to your project folder that enables the experimental codenarc engine (see below) - You're ready to analyze! Browse into your project's folder and run
CODECLIMATE_DEBUG=1 codeclimate analyze --dev
. - To add you custom codenarc rules, open
.codeclimate.yml
and add aconfig
entry pointing to yourruleset.xml
file:
engines:
codenarc:
enabled: true
config: ruleset.xml
For help with CodeNarc, check out their documentation.