npm-groovy-lint 14.6.0 → 14.6.1-beta202408252305.0

package/lib/rules/VariableName.js

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

package/lib/rules/VariableTypeRequired.js

@@ -1,18 +1,18 @@
 // Variable type required
-const { getVariableRange } = require("../utils");
+import { getVariableRange } from "../utils.js";
 
 const rule = {
     variables: [
         {
             name: "VARIABLE_NAME",
-            regex: /The type is not specified for variable "(.*)"/
-        }
+            regex: /The type is not specified for variable "(.*)"/,
+        },
     ],
     range: {
         type: "function",
         func: (errLine, errItem, evaluatedVars) => {
             return getVariableRange(errLine, evaluatedVars, "VARIABLE_NAME", errItem);
-        }
+        },
     },
     rangeTests: [
         {
@@ -22,15 +22,15 @@ def returnCode = 0
             expectedRange: {
                 start: {
                     line: 2,
-                    character: 4
+                    character: 4,
                 },
                 end: {
                     line: 2,
-                    character: 14
-                }
-            }
-        }
-    ]
+                    character: 14,
+                },
+            },
+        },
+    ],
 };
 
-module.exports = { rule };
+export { rule };

package/lib/utils.js

@@ -1,22 +1,25 @@
 // Shared functions
-"use strict";
 
-const debug = require("debug")("npm-groovy-lint");
-const trace = require("debug")("npm-groovy-lint-trace");
-const decodeHtml = require("decode-html");
-const fse = require("fs-extra");
-const os = require("os");
+import Debug from "debug";
+const debug = Debug("npm-groovy-lint");
+const trace = Debug("npm-groovy-lint-trace");
+import fs from "fs-extra";
+import * as os from "os";
+import * as path from "path";
+import { fileURLToPath } from "url";
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+import find from "find-package-json";
 
 const validErrorCombinations = {
     error: ["error", "warning", "info"],
     warning: ["warning", "info"],
     info: ["info"],
-    none: ["error", "warning", "info"]
+    none: ["error", "warning", "info"],
 };
 
 function addImport(allLineLs, classToImport) {
     // Check if import is already there
-    if (allLineLs.map(line => line.trim()).findIndex(line => line.startsWith(`import ${classToImport}`)) > -1) {
+    if (allLineLs.map((line) => line.trim()).findIndex((line) => line.startsWith(`import ${classToImport}`)) > -1) {
         return allLineLs;
     }
     // Add import after existing imports
@@ -26,13 +29,13 @@ function addImport(allLineLs, classToImport) {
         allLineLs
             .slice()
             .reverse()
-            .findIndex(line => line.trim().startsWith("import"));
+            .findIndex((line) => line.trim().startsWith("import"));
     if (lastImportIndex > -1 && lastImportIndex !== allLineLs.length) {
         allLineLs.splice(lastImportIndex + 1, 0, `import ${classToImport}`);
         return allLineLs;
     }
     // Add import after package declaration
-    const packageIndex = allLineLs.findIndex(line => line.trim().startsWith("package"));
+    const packageIndex = allLineLs.findIndex((line) => line.trim().startsWith("package"));
     if (packageIndex > -1) {
         allLineLs.splice(packageIndex + 1, 0, "");
         allLineLs.splice(packageIndex + 2, 0, `import ${classToImport}`);
@@ -63,7 +66,7 @@ function addSpaceAfterChar(line, char) {
     let pos = -1;
     const lineIndent = line.search(/\S/);
     const splits = line.split(char);
-    const newArray = splits.map(str => {
+    const newArray = splits.map((str) => {
         pos++;
         if (pos === splits.length - 1) {
             return str.trimStart();
@@ -82,7 +85,7 @@ function addSpaceAroundChar(line, char, postReplaces = []) {
     //const regSplit = new RegExp(escapedChar + `+(?=(?:(?:[^']*'){2})*[^']*$)`);
     const regSplit = new RegExp(escapedChar + `+(?=(?:(?:[^"]*"){2})*[^"]*$)(?=(?:(?:[^']*'){2})*[^']*$)(?=(?:(?:[^\`]*\`){2})*[^\`]*$)`);
     const splits = line.split(regSplit);
-    const newArray = splits.map(str => {
+    const newArray = splits.map((str) => {
         pos++;
         if (pos === 0) {
             return str.trimEnd();
@@ -105,7 +108,7 @@ function addSpaceAroundChar(line, char, postReplaces = []) {
 // Checks that a string contains other things than a list of strings
 function containsOtherThan(str, stringArray) {
     const splits = splitMulti(str, stringArray);
-    return splits.filter(item => item !== "").length > 0;
+    return splits.filter((item) => item !== "").length > 0;
 }
 
 // Get position to highlight in sources
@@ -154,17 +157,17 @@ function evaluateVariables(variableDefs, msg) {
             const regexRes = msg.match(varDef.regex);
             if (regexRes && regexRes.length > 1) {
                 const regexPos = varDef.regexPos || 1;
-                let value = decodeHtml(regexRes[regexPos]);
+                let value = decodeHTMLEntities(regexRes[regexPos]);
                 value = escapeValue(value);
                 const varValue =
                     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
+                    value: varValue,
                 });
             } else {
                 trace(`GroovyLint: Unable to match ${varDef.regex} in ${msg}`);
@@ -203,7 +206,7 @@ function findRangeBetweenStrings(allLines, errItem, strStart, strEnd) {
 function getDefaultRange(allLines, errItem) {
     return {
         start: { line: errItem.line, character: 0 },
-        end: { line: errItem.line, character: allLines[errItem.line - 1].length }
+        end: { line: errItem.line, character: allLines[errItem.line - 1].length },
     };
 }
 
@@ -217,16 +220,14 @@ function getLastStringRange(errLine, str, errItem) {
     const varStartPos = errLine.lastIndexOf(str);
     return {
         start: { line: errItem.line, character: varStartPos },
-        end: { line: errItem.line, character: varStartPos + str.length }
+        end: { line: errItem.line, character: varStartPos + str.length },
     };
 }
 
-/*
 function getLastVariableRange(errLine, evaluatedVars, variable, errItem) {
     const varValue = getVariable(evaluatedVars, variable);
     return getLastStringRange(errLine, varValue, errItem);
 }
-*/
 
 // Returns all strings which are not inside braces
 function getOutOfBracesStrings(str, exclude = []) {
@@ -250,14 +251,14 @@ function getOutOfBracesStrings(str, exclude = []) {
         }
         pos++;
     }
-    return outOfBracesStrings.filter(item => !exclude.includes(item) && item !== "");
+    return outOfBracesStrings.filter((item) => !exclude.includes(item) && item !== "");
 }
 
 // Split source lines to analyse
 async function getSourceLines(source, fileNm) {
     let fileContent =
         source ||
-        (await fse.readFile(fileNm).catch(err => {
+        (await fs.readFile(fileNm).catch((err) => {
             throw new Error(`Unable to read source lines: ${err}`); // Ensure that we have a stack trace.
         }));
     return normalizeNewLines(fileContent.toString()).split(os.EOL);
@@ -271,12 +272,12 @@ function getStringRange(errLine, strOrRegex, errItem) {
         return {
             start: {
                 line: errItem.line,
-                character: strOrRegex.lastIndex - match[0].length
+                character: strOrRegex.lastIndex - match[0].length,
             },
             end: {
                 line: errItem.line,
-                character: strOrRegex.lastIndex - 1
-            }
+                character: strOrRegex.lastIndex - 1,
+            },
         };
     }
     // String matcher
@@ -284,12 +285,12 @@ function getStringRange(errLine, strOrRegex, errItem) {
     return {
         start: {
             line: errItem.line,
-            character: varStartPos
+            character: varStartPos,
         },
         end: {
             line: errItem.line,
-            character: varStartPos + strOrRegex.length
-        }
+            character: varStartPos + strOrRegex.length,
+        },
     };
 }
 
@@ -308,7 +309,7 @@ function getStringRangeMultiline(allLines, str, errItem, levelKey) {
                 const varStartPos = allLines[pos].indexOf(str);
                 range = {
                     start: { line: pos + 1, character: varStartPos },
-                    end: { line: pos + 1, character: varStartPos + str.length }
+                    end: { line: pos + 1, character: varStartPos + str.length },
                 };
                 isFound = true;
             } else {
@@ -322,9 +323,9 @@ function getStringRangeMultiline(allLines, str, errItem, levelKey) {
 
 // Get variable value from evaluated vars
 function getVariable(evaluatedVars, name, optns = { mandatory: true, decodeHtml: false, line: "" }) {
-    const matchingVars = evaluatedVars.filter(evaluatedVar => evaluatedVar.name === name);
+    const matchingVars = evaluatedVars.filter((evaluatedVar) => evaluatedVar.name === name);
     if (matchingVars && matchingVars.length > 0) {
-        return optns.decodeHtml ? decodeHtml(matchingVars[0].value) : matchingVars[0].value;
+        return optns.decodeHtml ? decodeHTMLEntities(matchingVars[0].value) : matchingVars[0].value;
     } else if (optns.mandatory) {
         throw new Error("GroovyLint fix: missing mandatory variable " + name + " in " + JSON.stringify(evaluatedVars)) + "for line :\n" + optns.line;
     } else {
@@ -354,12 +355,7 @@ function moveOpeningBracket(allLines, variables) {
     if (realPos === -1) {
         throw new Error("Unable to find opening bracket");
     }
-    if (
-        allLines[realPos - 1]
-            .trim()
-            .replace(/ /g, "")
-            .includes("){")
-    ) {
+    if (allLines[realPos - 1].trim().replace(/ /g, "").includes("){")) {
         throw new Error("Fix not applied: probably a CodeNarc false positive");
     }
     // Add bracket after if
@@ -388,7 +384,7 @@ function normalizeNewLines(str) {
 function notBetweenQuotesOrComment(str, substr) {
     const singleQuotesMatch = str.match(/'(.*?)'/) || [];
     const doubleQuotesMatch = str.match(/"(.*?)"/) || [];
-    const res = singleQuotesMatch.concat(doubleQuotesMatch).filter(match => match.includes(substr));
+    const res = singleQuotesMatch.concat(doubleQuotesMatch).filter((match) => match.includes(substr));
     if (res.length > 0) {
         return false;
     }
@@ -425,8 +421,7 @@ function getNpmGroovyLintVersion() {
     let v = process.env.npm_package_version;
     if (!v) {
         try {
-            const FindPackageJson = require("find-package-json");
-            const finder = FindPackageJson(__dirname);
+            const finder = find(__dirname);
             v = finder.next().value.version;
         } catch {
             v = "error";
@@ -435,18 +430,42 @@ function getNpmGroovyLintVersion() {
     return v;
 }
 
-module.exports = {
+const entities = {
+    amp: "&",
+    apos: "'",
+    lt: "<",
+    gt: ">",
+    quot: '"',
+    nbsp: "\xa0",
+};
+const entityPattern = /&([a-z]+);/gi;
+
+function decodeHTMLEntities(text) {
+    // A single replace pass with a static RegExp is faster than a loop
+    return text.replace(entityPattern, function (match, entity) {
+        entity = entity.toLowerCase();
+        if (Object.prototype.hasOwnProperty.call(entities, entity)) {
+            return entities[entity];
+        }
+        // return original string if there is no matching entity (no replace)
+        return match;
+    });
+}
+
+export {
     addImport,
     addSpaceAfterChar,
     addSpaceAroundChar,
     containsOtherThan,
     containsExceptInsideString,
+    decodeHTMLEntities,
     evaluateRange,
     evaluateRangeFromLine,
     evaluateVariables,
     findRangeBetweenStrings,
     getIndentLength,
     getLastStringRange,
+    getLastVariableRange,
     getNpmGroovyLintVersion,
     getOutOfBracesStrings,
     getSourceLines,
@@ -457,5 +476,5 @@ module.exports = {
     isErrorInLogLevelScope,
     isValidCodeLine,
     moveOpeningBracket,
-    normalizeNewLines
+    normalizeNewLines,
 };

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "npm-groovy-lint",
-  "version": "14.6.0",
+  "version": "14.6.1-beta202408252305.0",
   "description": "Lint, format and auto-fix your Groovy / Jenkinsfile / Gradle files",
-  "main": "index.js",
+  "exports": "./index.js",
+  "type": "module",
   "scripts": {
     "lint:fix": "eslint **/*.js --fix && prettier --write \"./lib/**/*.{js,jsx}\" --tab-width 4 --print-width 150",
     "server:run-from-source": "npm run server:kill && groovy -cp \"lib/java/*\" groovy/src/main/com/nvuillam/CodeNarcServer.groovy --server",
@@ -48,39 +49,41 @@
   "dependencies": {
     "ansi-colors": "^4.1.1",
     "axios": "^1.6.2",
-    "chalk": "^4.1.2",
+    "chalk": "^5.3.0",
     "cli-progress": "^3.12.0",
     "commondir": "^1.0.1",
     "debug": "^4.1.1",
-    "decode-html": "^2.0.0",
-    "find-java-home": "^1.1.0",
+    "find-java-home": "^2.0.0",
     "find-package-json": "^1.2.0",
-    "fs-extra": "^8.1.0",
-    "glob": "^7.1.6",
+    "fs-extra": "^11.0.0",
+    "glob": "^11.0.0",
     "import-fresh": "^3.2.1",
     "java-caller": "^4.0.0",
     "js-yaml": "^4.1.0",
-    "node-sarif-builder": "^2.0.3",
-    "optionator": "^0.8.3",
-    "strip-json-comments": "^3.0.1",
-    "uuid": "^8.2.0"
+    "node-sarif-builder": "^3.0.0",
+    "optionator": "^0.9.0",
+    "strip-json-comments": "^5.0.0",
+    "uuid": "^10.0.0"
   },
   "devDependencies": {
     "@babel/core": "^7.23.2",
     "@babel/eslint-parser": "^7.22.15",
+    "@eslint/eslintrc": "^3.1.0",
+    "@eslint/js": "^9.9.1",
     "adm-zip": "^0.5.10",
-    "diff": "^4.0.2",
-    "eslint": "^8.52.0",
+    "diff": "^5.0.0",
+    "eslint": "^9.0.0",
+    "globals": "^15.9.0",
     "handlebars": "^4.7.8",
     "mocha": "^10.2.0",
-    "npm-run-all": "^4.1.5",
-    "nyc": "^15.1.0",
-    "prettier": "^1.19.1",
-    "rimraf": "^3.0.2",
-    "which": "^2.0.2"
+    "npm-run-all2": "^6.0.0",
+    "nyc": "^17.0.0",
+    "prettier": "^3.0.0",
+    "rimraf": "^6.0.0",
+    "which": "^4.0.0"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "mocha": {
     "require": [