npm-groovy-lint

NPM GROOVY LINT

Wrapper for excellent groovy linter CodeNarc, using the great jdeploy and Groovy!

npm-groovy-lint allows you to run CodeNarc via command line without any installation issue

Easy to integrate in a CD/CI process (Jenkins Pipeline,CircleCI...) to lint your groovy or Jenkinsfile :)

INSTALLATION

    $ npm install -g npm-groovy-lint

For advanced usage, you may need to define RuleSet file(s)

You can use as starters :

• All rules
• Base rules

USAGE

    $ npm-groovy-lint OPTIONS

See OPTIONS in CodeNarc documentation

EXAMPLES

    $ npm-groovy-lint -report="xml:MyGroovyLinterReport.xml"

    $ npm-groovy-lint -includes=**/Jenkinsfile -rulesetfiles="file:config/codenarc/RuleSet-All.groovy" -title="MyJenkinsfileLinterReport" -maxPriority1Violations=0 -report="html:MyJenkinsfileLinterReport.html"

    $ npm-groovy-lint -basedir="src" -rulesetfiles="file:config/codenarc/RuleSet-Base.groovy" -title="MyGroovyLinterReport" -maxPriority1Violations=0 -report="html:MyGroovyLinterReport.html"

CONTRIBUTE

Contributions are very welcome !

• Fork the repo and clone it on your computer
• Run npm run test to check your updates (jdeploy.js is manually updated by npm run prepare-package script)
• Once your code is ready, documented and linted, please make a pull request :)

THANKS

This package is just a bundle with a little script, it relies on :

• CodeNarc: https://github.com/CodeNarc/CodeNarc
• jdeploy : https://github.com/shannah/jdeploy
• slf4j : http://www.slf4j.org/
• log4j : https://logging.apache.org/log4j/2.x/
• GMetrics : https://dx42.github.io/gmetrics/