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

package/lib/options.js

@@ -3,13 +3,11 @@
  * @author Nicolas Vuillamy
  */
 
-"use strict";
-
 //------------------------------------------------------------------------------
 // Requirements
 //------------------------------------------------------------------------------
 
-const optionator = require("optionator");
+import optionator from "optionator";
 
 const defaultServerPort = process.env.SERVER_PORT ? process.env.SERVER_PORT : "7484";
 
@@ -17,36 +15,36 @@ const defaultServerPort = process.env.SERVER_PORT ? process.env.SERVER_PORT : "7
 // Initialization and Public Interface
 //------------------------------------------------------------------------------
 
-let options = optionator({
+export const optionsDefinition = optionator({
     prepend: "npm-groovy-lint [options]",
     defaults: {
         concatRepeatedArrays: true,
-        mergeRepeatedObjects: true
+        mergeRepeatedObjects: true,
     },
     options: [
         {
             option: "ext",
             type: "[String]",
-            description: "Specify Groovy file extensions"
+            description: "Specify Groovy file extensions",
         },
         {
             option: "source",
             alias: "s",
             type: "String",
             description: "Source text to lint (if no path/files arguments)",
-            example: ["import groovyx.net.http.HTTPBuilder\n\nimport class Toto { \n }"]
+            example: ["import groovyx.net.http.HTTPBuilder\n\nimport class Toto { \n }"],
         },
         {
             option: "sourcefilepath",
             type: "String",
             dependsOn: ["source"],
             description: "Full path of the file whose content is sent in source argument ",
-            example: ["C:/some/folder/myScript.groovy", "/var/some/folder/myScript.groovy"]
+            example: ["C:/some/folder/myScript.groovy", "/var/some/folder/myScript.groovy"],
         },
         {
             option: "parse",
             type: "Boolean",
-            description: "Try to parse the source code with GroovyShell and return errors (use argument --no-parse if you want to deactivate)"
+            description: "Try to parse the source code with GroovyShell and return errors (use argument --no-parse if you want to deactivate)",
         },
         {
             option: "config",
@@ -55,17 +53,17 @@ let options = optionator({
             default: process.cwd(),
             description:
                 "Custom path to directory containing GroovyLint config file.\n Default: Found groovylintrc.js/json/yml/package.json config file, or default npm-groovy-lint config if not defined. \nNote: command-line arguments have priority on config file properties",
-            example: ["./config", "./config/whatever"]
+            example: ["./config", "./config/whatever"],
         },
         {
             option: "format",
             type: "Boolean",
-            description: "Format source code"
+            description: "Format source code",
         },
         {
             option: "fix",
             type: "Boolean",
-            description: "Automatically fix problems when possible"
+            description: "Automatically fix problems when possible",
         },
         {
             option: "fixrules",
@@ -74,14 +72,14 @@ let options = optionator({
             default: "all",
             dependsOn: ["fix"],
             description: "Option for --fix argument: List of rule identifiers to fix (if not specified, all available fixes will be applied)",
-            example: ["SpaceBeforeClosingBrace,SpaceAfterClosingBrace,UnusedImport"]
+            example: ["SpaceBeforeClosingBrace,SpaceAfterClosingBrace,UnusedImport"],
         },
         {
             option: "ignorepattern",
             alias: "i",
             type: "String",
             description: "Comma-separated list of Ant-style file patterns specifying files that must be ignored. Default: none",
-            example: ["**/test/*"]
+            example: ["**/test/*"],
         },
         {
             option: "rulesets",
@@ -92,8 +90,8 @@ let options = optionator({
             example: [
                 "./config/codenarc/RuleSet-Custom.groovy",
                 "./path/to/my/ruleset/files",
-                'Indentation{"spacesPerIndentLevel":2,"severity":"warning"},UnnecessarySemicolon,UnnecessaryGString,ConsecutiveBlankLines{"severity":"warning"},NoTabCharacter'
-            ]
+                'Indentation{"spacesPerIndentLevel":2,"severity":"warning"},UnnecessarySemicolon,UnnecessaryGString,ConsecutiveBlankLines{"severity":"warning"},NoTabCharacter',
+            ],
         },
         {
             option: "rulesetsoverridetype",
@@ -103,7 +101,7 @@ let options = optionator({
             default: "replaceConfig",
             description:
                 "If list of rules sent in rulesets option, defines if they replace rules defined in .groovylintrc.json, or if they are appended",
-            example: ["replaceConfig", "appendConfig"]
+            example: ["replaceConfig", "appendConfig"],
         },
         {
             option: "output",
@@ -119,8 +117,8 @@ let options = optionator({
                 "./logs/myLintResults.json",
                 "./logs/myLintResults.sarif",
                 "./logs/myLintResults.html",
-                "./logs/myLintResults.xml"
-            ]
+                "./logs/myLintResults.xml",
+            ],
         },
         {
             option: "loglevel",
@@ -129,12 +127,12 @@ let options = optionator({
             enum: ["error", "warning", "info"],
             default: "info",
             description: "Log level (error,warning,info)",
-            example: ["warning", "error"]
+            example: ["warning", "error"],
         },
         {
             option: "verbose",
             type: "Boolean",
-            description: "More outputs in console, including performed fixes"
+            description: "More outputs in console, including performed fixes",
         },
         {
             option: "failon",
@@ -143,22 +141,22 @@ let options = optionator({
             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"]
+            example: ["error", "warning", "info", "none"],
         },
         {
             option: "failonerror",
             type: "Boolean",
-            description: "(Deprecated) Fails if at least one error is found"
+            description: "(Deprecated) Fails if at least one error is found",
         },
         {
             option: "failonwarning",
             type: "Boolean",
-            description: "(Deprecated) Fails if at least one warning is found"
+            description: "(Deprecated) Fails if at least one warning is found",
         },
         {
             option: "failoninfo",
             type: "Boolean",
-            description: "(Deprecated) Fails if at least one error is found"
+            description: "(Deprecated) Fails if at least one error is found",
         },
         {
             option: "codenarcargs",
@@ -166,27 +164,27 @@ let options = optionator({
             description:
                 "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="lib/example" -rulesetfiles="file:lib/example/RuleSet-Groovy.groovy" -maxPriority1Violations=0 -report="xml:ReportTestCodenarc.xml'
-            ]
+                'npm-groovy-lint --codenarcargs -basedir="lib/example" -rulesetfiles="file:lib/example/RuleSet-Groovy.groovy" -maxPriority1Violations=0 -report="xml:ReportTestCodenarc.xml',
+            ],
         },
         {
             option: "noserver",
             type: "Boolean",
             description:
-                "For better performances, npm-groovy-lint runs a local server to eep CodeNarc alive instead of loading java/groovy at each call. If you don't want that, send this argument"
+                "For better performances, npm-groovy-lint runs a local server to eep CodeNarc alive instead of loading java/groovy at each call. If you don't want that, send this argument",
         },
         {
             option: "serverhost",
             type: "String",
             default: "http://localhost",
-            description: "If use of CodeNarc server, host where is the CodeNarc server (default: localhost)"
+            description: "If use of CodeNarc server, host where is the CodeNarc server (default: localhost)",
         },
         {
             option: "serverport",
             type: "String",
             default: defaultServerPort,
             description: `If use of CodeNarc server, port of the CodeNarc server (default: ${defaultServerPort})`,
-            example: ["2702"]
+            example: ["2702"],
         },
         {
             option: "javaexecutable",
@@ -194,48 +192,48 @@ let options = optionator({
             type: "String",
             default: "java",
             description: "If you do not want to use default java executable to run CodeNarcServer, you can override it",
-            example: [`C:\\Program Files\\Java\\jdk1.8.0_144\\bin\\java.exe`, `/users/nvuillam/jdk1.8.0_144/bin/java`]
+            example: [`C:\\Program Files\\Java\\jdk1.8.0_144\\bin\\java.exe`, `/users/nvuillam/jdk1.8.0_144/bin/java`],
         },
         {
             option: "javaoptions",
             type: "String",
             default: "-Xms256m,-Xmx2048m",
             description: "Override java options",
-            example: [`-Xms256m,-Xmx2048m`]
+            example: [`-Xms256m,-Xmx2048m`],
         },
         {
             option: "killserver",
             type: "Boolean",
-            description: "Terminate the CodeNarcServer if running"
+            description: "Terminate the CodeNarcServer if running",
         },
         {
             option: "nolintafter",
             type: "Boolean",
-            description: "Do not lint again after format and fix options (useful for client calling Npm Groovy Lint)"
+            description: "Do not lint again after format and fix options (useful for client calling Npm Groovy Lint)",
         },
         {
             option: "returnrules",
             type: "Boolean",
-            description: "Return rule descriptions and url if this argument is set"
+            description: "Return rule descriptions and url if this argument is set",
         },
         {
             option: "insight",
             type: "Boolean",
             default: false,
             description:
-                "npm-groovy-lint collects anonymous usage statistics using package https://www.npmjs.com/package/insight. If you want to enable them, use --insight option"
+                "npm-groovy-lint collects anonymous usage statistics using package https://www.npmjs.com/package/insight. If you want to enable them, use --insight option",
         },
         {
             option: "help",
             alias: "h",
             type: "Boolean",
-            description: "Show help (npm-groovy-lint -help OPTIONNAME to see option detail)"
+            description: "Show help (npm-groovy-lint -help OPTIONNAME to see option detail)",
         },
         {
             option: "version",
             alias: "v",
             type: "Boolean",
-            description: "Show version"
+            description: "Show version",
         },
         {
             option: "path",
@@ -243,15 +241,15 @@ let options = optionator({
             type: "path::String",
             default: ".",
             description: "(DEPRECATED) Directory containing the files to lint (default: current directory)",
-            example: ["./path/to/my/groovy/files"]
+            example: ["./path/to/my/groovy/files"],
         },
         {
             option: "files",
             alias: "f",
             type: "String",
             description: "(DEPRECATED) Comma-separated list of Ant-style file patterns specifying files that must be included",
-            example: ["**/Jenkinsfile", "**/*.groovy", "**/*.gradle"]
-        }
+            example: ["**/Jenkinsfile", "**/*.groovy", "**/*.gradle"],
+        },
     ],
     mutuallyExclusive: [
         ["files", "source", "codenarcargs", "help", "version"],
@@ -274,23 +272,16 @@ let options = optionator({
                 "nolintafter",
                 "noserver",
                 "serverhost",
-                "serverport"
-            ]
+                "serverport",
+            ],
         ],
         ["noserver", ["serverhost", "serverport", "killserver"]],
         ["fix", "format"],
         [
             ["fix", "format"],
-            ["failonerror", "failonwarning", "failoninfo"]
-        ]
-    ]
+            ["failonerror", "failonwarning", "failoninfo"],
+        ],
+    ],
 });
 
-options.defaultServerPort = defaultServerPort;
-
-// Export:
-// - parse(args)
-// - generateHelp()
-// - generateHelpForOption(optionName)
-// - defaultServerPort
-module.exports = options;
+optionsDefinition.defaultServerPort = defaultServerPort;

package/lib/output.js

@@ -1,9 +1,9 @@
 // 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, getNpmGroovyLintVersion } = require("./utils");
+import ansiColors from "ansi-colors";
+import fs from "fs-extra";
+import { SarifBuilder, SarifRunBuilder, SarifResultBuilder, SarifRuleBuilder } from "node-sarif-builder";
+import * as path from "path";
+import { isErrorInLogLevelScope, getNpmGroovyLintVersion } from "./utils.js";
 
 // Compute statistics for output
 function computeStats(lintResult) {
@@ -23,7 +23,7 @@ function computeStats(lintResult) {
         totalRemainingInfoNumber: 0,
 
         detectedRules: {},
-        fixedRules: {}
+        fixedRules: {},
     };
 
     // No files = no result (mostly happens when lint has been cancelled before being completed)
@@ -56,11 +56,11 @@ function computeStats(lintResult) {
 // Collect stats about errors in a linted / formatted / fixed file
 function appendErrorTypeStats(severity, fileErrors, counterResultsSummary) {
     // Found
-    const fileFoundSeverityNumber = fileErrors.filter(err => {
+    const fileFoundSeverityNumber = fileErrors.filter((err) => {
         return err.severity === severity;
     }).length;
     // Fixed
-    const fileFixedSeverityNumber = fileErrors.filter(err => {
+    const fileFixedSeverityNumber = fileErrors.filter((err) => {
         return err.severity === severity && err.fixed && err.fixed === true;
     }).length;
     // Remaining
@@ -91,7 +91,7 @@ function appendErrorTypeStats(severity, fileErrors, counterResultsSummary) {
     return {
         found: fileFoundSeverityNumber,
         fixed: fileFixedSeverityNumber,
-        remaining: fileRemainingSeverityNumber
+        remaining: fileRemainingSeverityNumber,
     };
 }
 
@@ -103,12 +103,12 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
         // Disable colors if output results in text file or no output result
         if (output.includes(".txt") || output === "none") {
             // Disable ansi colors if output in txt file
-            c.enabled = false;
+            ansiColors.enabled = false;
         }
         // Errors
         for (const fileNm of Object.keys(lintResult.files)) {
             const fileErrors = lintResult.files[fileNm].errors;
-            let fileOutputString = c.underline(fileNm) + "\n";
+            let fileOutputString = ansiColors.underline(fileNm) + "\n";
             let showFileInOutput = false;
             for (const err of fileErrors) {
                 if (!isErrorInLogLevelScope(err.severity, options.loglevel)) {
@@ -141,7 +141,7 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
                     "  " +
                     err.line.toString().padEnd(4, " ") +
                     "  " +
-                    c[color](err.severity.padEnd(7, " ")) +
+                    ansiColors[color](err.severity.padEnd(7, " ")) +
                     "  " +
                     err.msg +
                     "  " +
@@ -153,26 +153,26 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
                 outputString += fileOutputString;
             }
         }
-        outputString += "\nnpm-groovy-lint results in " + c.bold(lintResult.summary.totalFilesLinted) + " linted files:";
+        outputString += "\nnpm-groovy-lint results in " + ansiColors.bold(lintResult.summary.totalFilesLinted) + " linted files:";
 
         // Summary table
         const errorTableLine = {
             Severity: "Error",
             "Total found": lintResult.summary.totalFoundErrorNumber,
             "Total fixed": lintResult.summary.totalFixedErrorNumber,
-            "Total remaining": lintResult.summary.totalRemainingErrorNumber
+            "Total remaining": lintResult.summary.totalRemainingErrorNumber,
         };
         const warningTableLine = {
             Severity: "Warning",
             "Total found": lintResult.summary.totalFoundWarningNumber,
             "Total fixed": lintResult.summary.totalFixedWarningNumber,
-            "Total remaining": lintResult.summary.totalRemainingWarningNumber
+            "Total remaining": lintResult.summary.totalRemainingWarningNumber,
         };
         const infoTableLine = {
             Severity: "Info",
             "Total found": lintResult.summary.totalFoundInfoNumber,
             "Total fixed": lintResult.summary.totalFixedInfoNumber,
-            "Total remaining": lintResult.summary.totalRemainingInfoNumber
+            "Total remaining": lintResult.summary.totalRemainingInfoNumber,
         };
         const summaryTable = [];
         if (isErrorInLogLevelScope("error", options.loglevel)) {
@@ -188,7 +188,7 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
         // Output text log in file
         if (output.endsWith(".txt")) {
             const fullFileContent = outputString;
-            fse.writeFileSync(output, fullFileContent);
+            fs.writeFileSync(output, fullFileContent);
             console.table(summaryTable, fixer ? ["Severity", "Total found", "Total fixed", "Total remaining"] : ["Severity", "Total found"]);
             const absolutePath = path.resolve(".", output);
             console.info("GroovyLint: Logged results in file " + absolutePath);
@@ -203,7 +203,7 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
         // Output log
         if (output.endsWith(".json")) {
             const fullFileContent = JSON.stringify(lintResult, null, 2);
-            fse.writeFileSync(output, fullFileContent);
+            fs.writeFileSync(output, fullFileContent);
             const absolutePath = path.resolve(".", output);
             console.info("GroovyLint: Logged results in file " + absolutePath);
         } else {
@@ -216,7 +216,7 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
         const sarifJsonString = buildSarifResult(lintResult);
         // SARIF file
         if (output.endsWith(".sarif")) {
-            fse.writeFileSync(output, sarifJsonString);
+            fs.writeFileSync(output, sarifJsonString);
             const absolutePath = path.resolve(".", output);
             outputString = "GroovyLint: Logged SARIF results in file " + absolutePath;
             console.info(outputString);
@@ -240,7 +240,7 @@ function buildSarifResult(lintResult) {
     const sarifRunBuilder = new SarifRunBuilder().initSimple({
         toolDriverName: "npm-groovy-lint",
         toolDriverVersion: getNpmGroovyLintVersion(),
-        url: "https://nvuillam.github.io/npm-groovy-lint/"
+        url: "https://nvuillam.github.io/npm-groovy-lint/",
     });
     // SARIF rules
     for (const ruleId of Object.keys(lintResult.rules || {})) {
@@ -248,7 +248,7 @@ function buildSarifResult(lintResult) {
         const sarifRuleBuilder = new SarifRuleBuilder().initSimple({
             ruleId: ruleId,
             shortDescriptionText: rule.description,
-            helpUri: rule.docUrl
+            helpUri: rule.docUrl,
         });
         sarifRunBuilder.addRule(sarifRuleBuilder);
     }
@@ -261,7 +261,7 @@ function buildSarifResult(lintResult) {
                 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)
+                fileUri: process.env.SARIF_URI_ABSOLUTE ? "file:///" + fileNm.replace(/\\/g, "/") : path.relative(process.cwd(), fileNm),
             };
             if (err && err.range && err.range.start && (err.range.start.line === 0 || err.range.start.line > 0)) {
                 sarifResultInit.startLine = fixLine(err.range.start.line);
@@ -291,4 +291,4 @@ function fixCol(val) {
     return val === 0 ? 1 : val + 1;
 }
 
-module.exports = { computeStats, processOutput };
+export { computeStats, processOutput };

package/lib/rules/AssignmentInConditional.js

@@ -1,19 +1,19 @@
 // Assignment in condition
 
-const { getStringRange } = require("../utils");
+import { getStringRange } from "../utils.js";
 
 const rule = {
     range: {
         type: "function",
         func: (errLine, errItem) => {
             return getStringRange(errLine, /(?<!=|!|>|<)=(?!=)/g, errItem);
-        }
+        },
     },
     fix: {
         label: `Replace "=" by "=="`,
         type: "replaceString",
         before: /(?<!=|!|>|<)=(?!=)/g,
-        after: "=="
+        after: "==",
     },
     tests: [
         {
@@ -48,9 +48,9 @@ while (value == true && value != false) {
 
 (value == true) ? x : y
 (value == true) ?: x
-`
-        }
-    ]
+`,
+        },
+    ],
 };
 
-module.exports = { rule };
+export { rule };

package/lib/rules/BlankLineBeforePackage.js

@@ -1,6 +1,6 @@
 // Blank line before package
 
-const { getVariable } = require("../utils");
+import { getVariable } from "../utils.js";
 
 const rule = {
     scope: "file",
@@ -16,7 +16,7 @@ const rule = {
                 allLines.splice(lineNumber + 1, 1);
             }
             return allLines;
-        }
+        },
     },
 
     tests: [
@@ -43,8 +43,8 @@ class BuildEnv implements Serializable {
     private String dockerRegistryCredsId
     private Map envVars
 }
-`
-        }
+`,
+        },
     ],
     rangeTests: [
         {
@@ -63,15 +63,15 @@ class BuildEnv implements Serializable {
             expectedRange: {
                 start: {
                     line: 1,
-                    character: 0
+                    character: 0,
                 },
                 end: {
                     line: 1,
-                    character: 21
-                }
-            }
-        }
-    ]
+                    character: 21,
+                },
+            },
+        },
+    ],
 };
 
-module.exports = { rule };
+export { rule };

package/lib/rules/BlockEndsWithBlankLine.js

@@ -1,6 +1,6 @@
 // Unused import
 
-const { getVariable } = require("../utils");
+import { getVariable } from "../utils.js";
 
 const rule = {
     scope: "file",
@@ -14,7 +14,7 @@ const rule = {
                 allLines.splice(lineNumber, 1);
             }
             return allLines;
-        }
+        },
     },
 
     tests: [
@@ -38,9 +38,9 @@ if (true) {
 if (false) {
     def b = 2
 }
-`
-        }
-    ]
+`,
+        },
+    ],
 };
 
-module.exports = { rule };
+export { rule };

package/lib/rules/BlockStartsWithBlankLine.js

@@ -1,6 +1,6 @@
 // Unused import
 
-const { getVariable } = require("../utils");
+import { getVariable } from "../utils.js";
 
 const rule = {
     scope: "file",
@@ -14,7 +14,7 @@ const rule = {
                 allLines.splice(lineNumber, 1);
             }
             return allLines;
-        }
+        },
     },
 
     tests: [
@@ -38,9 +38,9 @@ if (true) {
 if (false) {
     def b = 2
 }
-`
-        }
-    ]
+`,
+        },
+    ],
 };
 
-module.exports = { rule };
+export { rule };

package/lib/rules/BracesForClass.js

@@ -1,6 +1,6 @@
 // Braces for class
 
-const { moveOpeningBracket, findRangeBetweenStrings } = require("../utils");
+import { moveOpeningBracket, findRangeBetweenStrings } from "../utils.js";
 
 const rule = {
     scope: "file",
@@ -9,14 +9,14 @@ const rule = {
         type: "function",
         func: (_errLine, errItem, _evaluatedVars, allLines) => {
             return findRangeBetweenStrings(allLines, errItem, "class", "{");
-        }
+        },
     },
     fix: {
         label: "Move opening brace on the same line",
         type: "function",
         func: (allLines, variables) => {
             return moveOpeningBracket(allLines, variables);
-        }
+        },
     },
     tests: [
         {
@@ -30,7 +30,7 @@ public class lelamanul
 public class lelamanul {
     def a = 1
 }
-`
+`,
         },
         {
             sourceBefore: `
@@ -42,9 +42,9 @@ public class lelamanul
 public class lelamanul {
     def a = 1
 }
-`
-        }
-    ]
+`,
+        },
+    ],
 };
 
-module.exports = { rule };
+export { rule };