Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1.21 KB

README.md

File metadata and controls

27 lines (19 loc) · 1.21 KB
Raw

Code Climate CodeNarc (Groovy) Engine

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

Installation

  1. If you haven't already, install the Code Climate CLI.
  2. clone the repo and run make test to build the image locally and test it
  3. Add a .codeclimate.yml to your project folder that enables the experimental codenarc engine (see below)
  4. You're ready to analyze! Browse into your project's folder and run CODECLIMATE_DEBUG=1 codeclimate analyze --dev .
  5. To add you custom codenarc rules, open .codeclimate.yml and add a config entry pointing to your ruleset.xml file:
engines:
  codenarc:
    enabled: true
    config: ruleset.xml

Need help?

For help with CodeNarc, check out their documentation.