npm-groovy-lint 10.1.0 → 11.1.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## UNRELEASED
 
+## [11.1.0] 2022-10-31
+
+- Provide default range when only information available is a line number ([#248](https://github.com/nvuillam/npm-groovy-lint/issues/248))
+- New CodeNarc issues definition to calculate range in file
+  - GStringExpressionWithinString
+  - VariableName
+
+## [11.0.0] 2022-10-07
+
+- **BREAKING CHANGE**:`--failon` is now `ìnfo` by default, meaning exit code will be `1` if there is at least an info issue found. To have previous behaviour, use `--failon none`.
+- Display all files in console log only if `--verbose` is used ([#243](https://github.com/nvuillam/npm-groovy-lint/issues/243))
+
 ## [10.1.0] 2022-08-15
 
 - Allow to send groovy sources as input from stdin

package/lib/codenarc-factory.js

@@ -9,7 +9,7 @@ const path = require("path");
 const { getConfigFileName } = require("./config.js");
 const { collectDisabledBlocks, isFilteredError } = require("./filter.js");
 const { getNpmGroovyLintRules } = require("./groovy-lint-rules.js");
-const { evaluateRange, evaluateVariables, getSourceLines, normalizeNewLines } = require("./utils.js");
+const { evaluateRange, evaluateRangeFromLine, evaluateVariables, getSourceLines, normalizeNewLines } = require("./utils.js");
 
 ////////////////////////////
 // Build codenarc options //
@@ -325,6 +325,13 @@ async function parseCodeNarcResult(options, codeNarcBaseDir, codeNarcJsonResult,
                                 errItem.range = range;
                             }
                         }
+                        // Add unprecise range based on line when range function has not been defined on rule
+                        else if (errItem.line > 0) {
+                            const range = evaluateRangeFromLine(errItem,  allLines);
+                            if (range && range.start.character > -1) {
+                                errItem.range = range;
+                            }
+                        }
                     }
                     // Add in file errors
                     files[fileNm].errors.push(errItem);

package/lib/config.js

@@ -239,7 +239,7 @@ async function loadYAMLConfigFile(filePath) {
     try {
         // empty YAML file can be null, so always use
         const fileContent = await readFile(filePath);
-        return yaml.safeLoad(fileContent) || {};
+        return yaml.load(fileContent) || {};
     } catch (e) {
         debug(`Error reading YAML file: ${filePath}`);
         e.message = `Cannot read config file: ${filePath}\nError: ${e.message}`;

package/lib/groovy-lint.js

@@ -467,6 +467,10 @@ class NpmGroovyLint {
 
     // Exit with code 1 if failon, failonerror, failonwarning or failoninfo is set
     manageReturnCode() {
+        if (this.status > 1) {
+            // There has been a fatal error before, so there are no results
+            return ;
+        }
         const failureLevel =
             this.options.failon && this.options.failon !== "none"
                 ? this.options.failon
@@ -480,6 +484,10 @@ class NpmGroovyLint {
         if (failureLevel === "none") {
             return;
         }
+        if (this.lintResult.summary == null) {
+            // Special case like --codenarcargs (should not be used in thee future)
+            return;
+        }
 
         const errorNb = this.lintResult.summary.totalFoundErrorNumber;
         const warningNb = this.lintResult.summary.totalFoundWarningNumber;

package/lib/options.js

@@ -139,7 +139,7 @@ module.exports = optionator({
             option: "failon",
             type: "String",
             enum: ["error", "warning", "info", "none"],
-            default: "none",
+            default: "info",
             description:
                 "Defines the error level where CLI will fail (return code = 1). error,warning,info or none. Every failure level includes the more critical ones.",
             example: ["error", "warning", "info", "none"]

package/lib/output.js

@@ -108,11 +108,13 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
         // Errors
         for (const fileNm of Object.keys(lintResult.files)) {
             const fileErrors = lintResult.files[fileNm].errors;
-            outputString += c.underline(fileNm) + "\n";
+            let fileOutputString = c.underline(fileNm) + "\n";
+            let showFileInOutput = false ;
             for (const err of fileErrors) {
                 if (!isErrorInLogLevelScope(err.severity, options.loglevel)) {
                     continue;
                 }
+                showFileInOutput = true ;
                 let color = "grey";
                 switch (err.severity) {
                     case "error":
@@ -135,7 +137,7 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
                     }
                 }
                 // Build error output line
-                outputString +=
+                fileOutputString +=
                     "  " +
                     err.line.toString().padEnd(4, " ") +
                     "  " +
@@ -146,7 +148,10 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
                     err.rule.padEnd(24, " ") +
                     "\n";
             }
-            outputString += "\n";
+            fileOutputString += "\n";
+            if (showFileInOutput || options.verbose) {
+                outputString += fileOutputString ;
+            }
         }
         outputString += "\nnpm-groovy-lint results in " + c.bold(lintResult.summary.totalFilesLinted) + " linted files:";
 

package/lib/rules/BlankLineBeforePackage.js

@@ -45,6 +45,32 @@ class BuildEnv implements Serializable {
 }
 `
         }
+    ],
+    rangeTests: [
+        {
+            source: `#!/usr/bin/env groovy
+
+package org.pdxc.devops
+
+class BuildEnv implements Serializable {
+    private String image
+    private String tag 
+    private String dockerRegistry
+    private String dockerRegistryCredsId
+    private Map envVars
+}
+`,
+            expectedRange: {
+                start: {
+                    line: 1,
+                    character: 0
+                },
+                end: {
+                    line: 1,
+                    character: 21
+                }
+            }
+        }
     ]
 };
 

package/lib/rules/GStringExpressionWithinString.js

@@ -0,0 +1,23 @@
+// GString Expression within string
+
+const rule = {
+    rangeTests: [
+        {
+            source: `
+def someString = '\${SCRIPT,template=\\"mail_template_robot_results.groovy\\"}'
+`,
+            expectedRange: {
+                start: {
+                    line: 2,
+                    character: 0
+                },
+                end: {
+                    line: 2,
+                    character: 76
+                }
+            }
+        }
+    ]
+};
+
+module.exports = { rule };

package/lib/rules/VariableName.js

@@ -0,0 +1,36 @@
+// Variable name invalid
+const { getVariableRange } = require("../utils");
+
+const rule = {
+    variables: [
+        {
+            name: "VARIABLE_NAME",
+            regex: /Variable named (.*) in (.*) does not match the pattern (.*)/
+        }
+    ],
+    range: {
+        type: "function",
+        func: (errLine, errItem, evaluatedVars) => {
+            return getVariableRange(errLine, evaluatedVars, "VARIABLE_NAME", errItem);
+        }
+    },
+    rangeTests: [
+        {
+            source: `
+def RANDOM_ID = 0
+`,
+            expectedRange: {
+                start: {
+                    line: 2,
+                    character: 4
+                },
+                end: {
+                    line: 2,
+                    character: 13
+                }
+            }
+        }
+    ]
+};
+
+module.exports = { rule };

package/lib/utils.js

@@ -122,6 +122,11 @@ function evaluateRange(errItem, rule, evaluatedVars, errLine, allLines) {
     return range;
 }
 
+// Get position to highlight in sources
+function evaluateRangeFromLine(errItem, allLines) {
+    return getDefaultRange(allLines, errItem)
+}
+
 // Evaluate variables from messages
 function evaluateVariables(variableDefs, msg) {
     const evaluatedVars = [];
@@ -137,8 +142,8 @@ function evaluateVariables(variableDefs, msg) {
                     varDef.type && varDef.type === "number"
                         ? parseInt(value, 10)
                         : varDef.type && varDef.type === "array"
-                        ? JSON.parse(value)
-                        : value;
+                            ? JSON.parse(value)
+                            : value;
                 evaluatedVars.push({
                     name: varDef.name,
                     value: varValue
@@ -415,6 +420,7 @@ module.exports = {
     containsOtherThan,
     containsExceptInsideString,
     evaluateRange,
+    evaluateRangeFromLine,
     evaluateVariables,
     findRangeBetweenStrings,
     getIndentLength,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-groovy-lint",
-  "version": "10.1.0",
+  "version": "11.1.0",
   "description": "Lint, format and auto-fix your Groovy / Jenkinsfile / Gradle files",
   "main": "index.js",
   "scripts": {