npm-groovy-lint 9.3.2 → 9.4.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## UNRELEASED
 
+- Add your updates here :)
+
+## [9.4.0] 2022-01-11
+
+- Add [SARIF](https://sarifweb.azurewebsites.net/) output format using [node-sarif-builder](https://github.com/nvuillam/node-sarif-builder)
+
 ## [9.3.2] 2022-01-09
 
 - Upgrade cli-progress to avoid [colors lib boring but harmless hack](https://github.com/Marak/colors.js/issues/285)

package/README.md

@@ -47,7 +47,7 @@ Any **question**, **problem** or **enhancement request** ? Ask [**here**](https:
 |-------------------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | -p<br/> --path          | String  | Directory containing the files to lint<br/> Example: `./path/to/my/groovy/files`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
 | -f<br/> --files         | String  | Comma-separated list of Ant-style file patterns specifying files that must be included.<br/> Default: `"**/*.groovy,**/Jenkinsfile,**/*.gradle"`<br/>Examples:<br/> - `"**/Jenkinsfile"`<br/> - `"**/*.groovy"`<br/> - `"**/*.gradle"`<br/> - `"**/mySingleFile.groovy"`                                                                                                                                                                                                                                                                                                          |
-| -o<br/> --output        | String  | Output format (txt,json,html,xml), or path to a file with one of these extensions<br/> Default: `txt`<br/> Examples:<br/> - `"txt"`<br/> - `"json"`<br/> - `"./logs/myLintResults.txt"`<br/> - `"./logs/myLintResults.json"`<br/> - `"./logs/myLintResults.html"`<br/> - `"./logs/myLintResults.xml"`                                                                                                                                                                                                                                                                             |
+| -o<br/> --output        | String  | Output format (txt,json,sarif,html,xml), or path to a file with one of these extensions<br/> Default: `txt`<br/> Examples:<br/> - `"txt"`<br/> - `"json"`<br/> - `"./logs/myLintResults.txt"`<br/> - `"./logs/myLintResults.sarif"`<br/> - `"./logs/myLintResults.html"`<br/> - `"./logs/myLintResults.xml"`                                                                                                                                                                                                                                                                      |
 | -l<br/> --loglevel      | String  | Log level (error,warning or info)<br/>Default: info                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | --failon                | String  | Defines the error level where CLI will fail (return code = 1). error,warning,info or none. Each failure level includes the more critical ones.                                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | -c<br/> --config        | String  | Custom path to [GroovyLint config file](#Configuration), or preset config `recommended|recommended-jenkinsfile|all`<br/> Default: Browse current directory to find `.groovylintrc.json|js|yml|package.json` config file, or default npm-groovy-lint config if not defined.<br/>Note: command-line arguments have priority on config file properties                                                                                                                                                                                                                               |

package/lib/codenarc-caller.js

@@ -304,7 +304,7 @@ class CodeNarcCaller {
         });
 
         if (this.serverStatus === "running") {
-            console.log(c.green(`GroovyLint: Started CodeNarc Server`));
+            debug(c.green(`GroovyLint: Started CodeNarc Server`));
             return true;
         } else {
             return false;

package/lib/codenarc-factory.js

@@ -35,7 +35,7 @@ async function prepareCodeNarcCall(options) {
             const pathParse = path.parse(options.sourcefilepath);
             cnPath = cnPath + "/codeNarcTmpDir_" + Math.random();
             await fs.ensureDir(cnPath, { mode: "0777" });
-            const pathBase = pathParse.base.replace(/ /g, '_');
+            const pathBase = pathParse.base.replace(/ /g, "_");
             result.tmpGroovyFileName = path.resolve(cnPath + "/" + pathBase);
             cnFiles = "**/" + pathBase;
         }
@@ -91,8 +91,14 @@ async function prepareCodeNarcCall(options) {
 
     // Output
     result.output = options.output.replace(/^"(.*)"$/, "$1");
-    if (["txt", "json", "none"].includes(result.output) || result.output.endsWith(".txt") || result.output.endsWith(".json")) {
-        result.outputType = result.output.endsWith(".txt") ? "txt" : result.output.endsWith(".json") ? "json" : result.output;
+    if (["txt", "json", "sarif", "none"].includes(result.output) ||
+        result.output.endsWith(".txt") ||
+        result.output.endsWith(".sarif") ||
+        result.output.endsWith(".json")) {
+        result.outputType = result.output.endsWith(".txt") ? "txt"
+            : result.output.endsWith(".json") ? "json"
+                : result.output.endsWith(".sarif") ? "sarif"
+                    : result.output;
         result.codenarcArgs.push(`-report=json:stdout`);
     } else if (["html", "xml"].includes(result.output.split(".").pop())) {
         result.outputType = result.output
@@ -101,11 +107,11 @@ async function prepareCodeNarcCall(options) {
             .endsWith("html")
             ? "html"
             : result.output
-                  .split(".")
-                  .pop()
-                  .endsWith("xml")
-            ? "xml"
-            : "";
+                .split(".")
+                .pop()
+                .endsWith("xml")
+                ? "xml"
+                : "";
         const ext = result.output.split(".").pop();
         result.codenarcArgs.push(`-report=${ext}:${result.output}`);
 
@@ -266,7 +272,7 @@ async function parseCodeNarcResult(options, codeNarcBaseDir, codeNarcJsonResult,
     }
 
     // Parse error definitions & build url if not already done and not noreturnrules option
-    if (result.rules == null && options.returnrules === true) {
+    if (result.rules == null && (options.returnrules === true || options.output.includes("sarif"))) {
         const configAllFileName = await getConfigFileName(__dirname, null, [".groovylintrc-all.json"]);
         const grooylintrcAllRules = Object.keys(JSON.parse(fs.readFileSync(configAllFileName, "utf8").toString()).rules);
         const rules = {};
@@ -338,8 +344,8 @@ async function buildRuleSets(options) {
                 typeof ruleFromConfig === "object"
                     ? Object.assign(ruleFromConfig, ruleOptions)
                     : Object.keys(ruleOptions).length > 0
-                    ? ruleOptions
-                    : ruleFromConfig;
+                        ? ruleOptions
+                        : ruleFromConfig;
             const ruleDef = buildCodeNarcRule(ruleName, mergedRuleConfig);
             return ruleDef;
         });
@@ -356,8 +362,8 @@ async function buildRuleSets(options) {
                     typeof ruleDef === "object"
                         ? Object.assign(ruleDef, ruleFromRuleSetsArg)
                         : Object.keys(ruleFromRuleSetsArg).length > 0
-                        ? ruleFromRuleSetsArg
-                        : ruleDef;
+                            ? ruleFromRuleSetsArg
+                            : ruleDef;
             }
             // Add in the list of rules to test , except if it is disabled
             if (!(ruleDef === "off" || ruleDef.disabled === true || ruleDef.enabled === false)) {

package/lib/options.js

@@ -119,8 +119,8 @@ module.exports = optionator({
             alias: "o",
             type: "String",
             default: "txt",
-            description: "Output format (txt,json,html,xml), or path to a file with one of these extensions",
-            example: ["txt", "json", "./logs/myLintResults.txt", "./logs/myLintResults.json", "./logs/myLintResults.html", "./logs/myLintResults.xml"]
+            description: "Output format (txt,json,sarif,html,xml), or path to a file with one of these extensions",
+            example: ["txt", "json", "sarif", "./logs/myLintResults.txt", "./logs/myLintResults.json","./logs/myLintResults.sarif", "./logs/myLintResults.html", "./logs/myLintResults.xml"]
         },
         {
             option: "loglevel",

package/lib/output.js

@@ -1,6 +1,7 @@
 // Output management
 const c = require("ansi-colors");
 const fse = require("fs-extra");
+const { SarifBuilder, SarifRunBuilder, SarifResultBuilder, SarifRuleBuilder } = require("node-sarif-builder");
 const path = require("path");
 const { isErrorInLogLevelScope } = require("./utils");
 
@@ -204,8 +205,80 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
             outputString = JSON.stringify(lintResult);
             console.log(outputString);
         }
+    } else if (outputType === "sarif") {
+        const sarifJsonString = buildSarifResult(lintResult);
+        // SARIF file
+        if (output.endsWith(".sarif")) {
+            fse.writeFileSync(output, sarifJsonString);
+            const absolutePath = path.resolve(".", output);
+            outputString = "GroovyLint: Logged SARIF results in file " + absolutePath;
+            console.info(outputString);
+        } else {
+            // SARIF in stdout
+            outputString = sarifJsonString;
+            console.log(sarifJsonString);
+        }
     }
     return outputString;
 }
 
+function buildSarifResult(lintResult) {
+    // SARIF builder
+    const sarifBuilder = new SarifBuilder();
+    // SARIF Run builder
+    const sarifRunBuilder = new SarifRunBuilder().initSimple({
+        name: "npm-groovy-lint",
+        url: "https://nvuillam.github.io/npm-groovy-lint/"
+    });
+    // SARIF rules
+    for (const ruleId of Object.keys(lintResult.rules || {})) {
+        const rule = lintResult.rules[ruleId];
+        const sarifRuleBuilder = new SarifRuleBuilder().initSimple({
+            ruleId: ruleId,
+            shortDescriptionText: rule.description,
+            helpUri: rule.docUrl
+        });
+        sarifRunBuilder.addRule(sarifRuleBuilder);
+    }
+    // Add SARIF results (individual errors)
+    for (const fileNm of Object.keys(lintResult.files)) {
+        const fileErrors = lintResult.files[fileNm].errors;
+        for (const err of fileErrors) {
+            const sarifResultBuilder = new SarifResultBuilder();
+            const sarifResultInit = {
+                level: err.severity === "info" ? "note" : err.severity, // Other values can be "warning" or "error"
+                messageText: err.msg,
+                ruleId: err.rule,
+                fileUri: process.env.SARIF_URI_ABSOLUTE
+                    ? "file:///" + fileNm.replace(/\\/g, "/")
+                    : path.relative(process.cwd(), fileNm)
+            };
+            if (err.range) {
+                sarifResultInit.startLine = fixLine(err.range.start.line);
+                sarifResultInit.startColumn = fixCol(err.range.start.character);
+                sarifResultInit.endLine = fixLine(err.range.end.line);
+                sarifResultInit.endColumn = fixCol(err.range.end.character);
+            }
+            sarifResultBuilder.initSimple(sarifResultInit);
+            sarifRunBuilder.addResult(sarifResultBuilder);
+        }
+    }
+    sarifBuilder.addRun(sarifRunBuilder);
+    return sarifBuilder.buildSarifJsonString({ indent: false });
+}
+
+function fixLine(val) {
+    if (val === null) {
+        return undefined;
+    }
+    return val === 0 ? 1 : val;
+}
+
+function fixCol(val) {
+    if (val === null) {
+        return undefined;
+    }
+    return val === 0 ? 1 : val + 1;
+}
+
 module.exports = { computeStats, processOutput };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-groovy-lint",
-  "version": "9.3.2",
+  "version": "9.4.0",
   "description": "Lint, format and auto-fix your Groovy / Jenkinsfile / Gradle files",
   "main": "index.js",
   "scripts": {
@@ -58,6 +58,7 @@
     "import-fresh": "^3.2.1",
     "ip": "^1.1.5",
     "java-caller": "^2.2.4",
+    "node-sarif-builder": "^1.0.0",
     "optionator": "^0.8.3",
     "semver": "^7.1.3",
     "strip-json-comments": "^3.0.1",
@@ -75,7 +76,7 @@
     "eslint-plugin-standard": "^5.0.0",
     "mocha": "^7.0.1",
     "nyc": "^15.1.0",
-    "prettier": "1.19.1",
+    "prettier": "^1.19.1",
     "rimraf": "^3.0.2",
     "which": "^2.0.2"
   },