npm-groovy-lint

NPM GROOVY LINT (and FIX !)

Groovy / Jenkinsfile linter and autofixer

Based on CodeNarc , this out of the box package allows to track groovy errors and correct a part of them

Use option --fix to activate autofixing (the function is still in experimental phase, you may have to run it several times at first so CodeNarc take in account the updates)

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

INSTALLATION

    $ npm install -g npm-groovy-lint

USAGE

    $ npm-groovy-lint OPTIONS

Parameter	Type	Description
-p --path	String	Directory containing the files to lint Example: ./path/to/my/groovy/files
-f --files	String	Comma-separated list of Ant-style file patterns specifying files that must be included. Default: "**/*.groovy,**/Jenkinsfile", or "**/*.groovy" if --rulesets Groovy, or **/Jenkinsfile if --rulesets Jenkinsfile Examples: - "**/Jenkinsfile"<br/> - "*/*.groovy"
-r --rulesets	String	RuleSet file(s) to use for linting. If it is a directory, all rulesets will be used. RuleSet file definition: http://codenarc.github.io/CodeNarc/codenarc-creating-ruleset.html. If not specified, npm-groovy-script default ones will be used depending on file types found in --path: - Groovy recommended rules, also usable with --rulesets Groovy - Jenkinsfile recommended rules, also usable with --rulesets Jenkinsfile Examples: - "./config/codenarc/RuleSet-Custom.groovy" - "./path/to/my/ruleset/files" - Jenkinsfile
-o --output	String	Output format (txt,json,html,xml), or path to a file with one of these extensions Default: txt Examples: - "txt" - "json" - "./logs/myLintResults.txt" - "./logs/myLintResults.json" - "./logs/myLintResults.html" - "./logs/myLintResults.xml"
-l --loglevel	String	Log level (error,warning or info) Default: info
-v --verbose	Boolean	More outputs in console, including performed fixes
--fix	Boolean	(Experimental) Automatically fix problems when possible See Autofixable rules
-i --ignorepattern	String	Comma-separated list of Ant-style file patterns specifying files that must be ignored Default: none Example: "**/test/*""
--failonerror	Boolean	Fails if at least one error is found
--failonwarning	Boolean	Fails if at least one warning is found
--noserver	Boolean	npm-groovy-lint launches a microservice to avoid performance issues caused by loading jaja/groovy everytime,that auto kills itself after 1h idle. Use this argument if you do not want to use this feature
--failoninfo	Boolean	Fails if at least one error is found
--codenarcargs	Boolean	Use core CodeNarc arguments (all npm-groovy-lint arguments will be ignored) Doc: http://codenarc.github.io/CodeNarc/codenarc-command-line.html Example: npm-groovy-lint --codenarcargs -basedir="jdeploy-bundle/lib/example" -rulesetfiles="file:jdeploy-bundle/lib/example/RuleSet-Groovy.groovy" -maxPriority1Violations=0 -report="xml:ReportTestCodenarc.xml
-h --help	Boolean	Show help (npm-groovy-lint -h OPTIONNAME to see option detail with examples)

EXAMPLES

• Lint a Jenkinsfile

    $ npm-groovy-lint --rulesets Jenkinsfile

• Lint groovy files

    $ npm-groovy-lint --rulesets Groovy

• Lint and fix a Jenkinsfile

    $ npm-groovy-lint --rulesets Jenkinsfile --fix

• Lint groovy with JSON output

    $ npm-groovy-lint --rulesets Groovy --output json

• Advanced config

    $ npm-groovy-lint --path "./path/to/my/groovy/files" --files "**/*.groovy" --rulesets "./config/codenarc/RuleSet-Custom.groovy" --loglevel warning --output txt

• Lint using core CodeNarc parameters and generate HTML report file

    $ npm-groovy-lint --codenarcargs -basedir="jdeploy-bundle/lib/example" -rulesetfiles="file:jdeploy-bundle/lib/example/RuleSet-Groovy.groovy" -title="TestTitleCodenarc" -maxPriority1Violations=0' -report="html:ReportTestCodenarc.html"

Autofixable rules (experimental)

• ConsecutiveBlankLines
• Indentation (IfStatementBraces and ElsefStatementBraces must be manually fixed to have correct indentation)
• NoTabCharacter
• SpaceAfterCatch
• SpaceAfterOpeningBrace
• SpaceAroundOperator
• SpaceAfterComma
• SpaceBeforeOpeningBrace
• UnnecessaryDefInFieldDeclaration
• UnnecessaryGString
• UnnecessarySemicolon
• TrailingWhitespace

Contribute to add more rules fixes :)

Call via JS module

You can import npm-groovy-lint into your NPM package and call lint & fix via module, using the same options than from npm-groovy-lint command line

Example

    $ npm install npm-groovy-lint --save

    const NpmGroovyLint = require("npm-groovy-lint/jdeploy-bundle/groovy-lint.js");
    const fse = require("fs-extra");
    
    const npmGroovyLintConfig = {
        source: fse.readFileSync('./lib/example/SampleFile.groovy').toString(),
        fix: true,
        loglevel: 'warning',
        output: 'none'
    };
    const linter = new NpmGroovyLint(npmGroovyLintConfig, {});
    await linter.run();
    console.log(JSON.stringify(linter.lintResult));

TROUBLESHOOTING

• Embedded Groovy 3.0.1 has issues with JDK12, please use JDK11 or a precedent version if possible

CONTRIBUTE

Contributions are very welcome !

• Fork the repo and clone it on your computer
• Run npm run lint then npm run test to check your updates didn't break anything
• Once your code is ready, documented and testing, please make a pull request :)

THANKS

This package uses :

• CodeNarc : https://github.com/CodeNarc/CodeNarc (groovy lint)
• jdeploy : https://github.com/shannah/jdeploy (jar deployment and run)
• slf4j : http://www.slf4j.org/ (logging for CodeNarc)
• log4j : https://logging.apache.org/log4j/2.x/ (logging for CodeNarc)
• GMetrics : https://dx42.github.io/gmetrics/ (Code mesures for CodeNarc)