npm-groovy-lint 12.2.1-beta202311260926.0 → 13.0.0

package/lib/analytics.js

@@ -189,7 +189,9 @@ async function buildFileStatsEvents(linterEvent, data) {
 
 async function getFileStats(file) {
     const fileStatEventProps = {};
-    const source = await fse.readFile(file);
+    const source = await fse.readFile(file).catch(err => {
+        throw new Error(`Unable to read stats: ${err}`); // Ensure that we have a stack trace.
+    });
     const sourceLines = await getSourceLines(source);
     fileStatEventProps.fileId = crypto
         .createHash("sha1")

package/lib/codenarc-caller.js

@@ -59,24 +59,12 @@ class CodeNarcCaller {
     async callCodeNarcServer(startServerTried = false) {
         // If use of --codenarcargs, get default values for CodeNarcServer host & port
         const requestUri = this.getCodeNarcServerUri() + "/request";
-        // Remove "" around values because they won't get thru system command line parser
-        const codeNarcArgsForServer = this.codenarcArgs.map(codeNarcArg => {
-            if (codeNarcArg.includes('="') || codeNarcArg.includes(':"')) {
-                codeNarcArg = codeNarcArg
-                    .replace('="', "=")
-                    .replace(':"', ":")
-                    .replace(/ /g, "%20");
-                codeNarcArg = codeNarcArg.substring(0, codeNarcArg.length - 1);
-            }
-            return codeNarcArg;
-        });
         // Call CodeNarc server
-        const codeNarcArgsString = codeNarcArgsForServer.join(" ");
         const axiosConfig = {
             method: "post",
             url: requestUri,
             data: {
-                codeNarcArgs: codeNarcArgsString,
+                codeNarcArgs: this.codenarcArgs,
                 codeNarcBaseDir: this.execOpts.codeNarcBaseDir,
                 codeNarcIncludes: this.execOpts.codeNarcIncludes,
                 codeNarcExcludes: this.execOpts.codeNarcExcludes,
@@ -212,7 +200,7 @@ class CodeNarcCaller {
         javaCallerOpts.javaExecutable = this.javaExecutable;
         javaCallerOpts.additionalJavaArgs = this.additionalJavaArgs;
         const javaCaller = new JavaCaller(javaCallerOpts);
-        const javaResult = await javaCaller.run(scriptArgs, { detached: false });
+        const javaResult = await javaCaller.run(scriptArgs, { detached: false, windowsVerbatimArguments: false });
 
         clearInterval(this.barTimer);
         this.bar.stop();

package/lib/codenarc-factory.js

@@ -26,42 +26,48 @@ const defaultFilesPattern = ["*.groovy", "*.gvy", "Jenkinsfile", "*.gradle", "*.
 async function prepareCodeNarcCall(options) {
     const result = { codenarcArgs: [] };
 
+    // Protect against regressions in argument parsing.
+    for (const [key, value] of Object.entries(options)) {
+        if (typeof value === "string" && value.match(/^['"]/)) {
+            throw new Error(`CodeNarc doesn't supported options found ${key} = ${value}`);
+        }
+    }
+
     let cnPath = options.path;
-    let cnFiles = options.files;
+    let cnFiles = options.file;
     const positionalArgs = options._ || [];
 
     // If source option, create a temporary Groovy file
     if (options.source) {
         cnPath = path.resolve(os.tmpdir() + "/npm-groovy-lint");
-        await fs.ensureDir(cnPath, { mode: "0777" });
+        await fs.ensureDir(cnPath, { mode: "0777" }); // await is needed, ignore editor warning.
         // File path is sent (recommended): use it to create temp file name
         if (options.sourcefilepath) {
             const pathParse = path.parse(options.sourcefilepath);
             cnPath = cnPath + "/codeNarcTmpDir_" + Math.random();
-            await fs.ensureDir(cnPath, { mode: "0777" });
+            await fs.ensureDir(cnPath, { mode: "0777" }); // await is needed, ignore editor warning.
             const pathBase = pathParse.base.replace(/ /g, "_");
             result.tmpGroovyFileName = path.resolve(cnPath + "/" + pathBase);
-            cnFiles = "**/" + pathBase;
+            cnFiles = ["**/" + pathBase];
         }
         // Use default random file name
         else {
             const tmpFileNm = CODENARC_TMP_FILENAME_BASE + Math.random() + ".groovy";
             result.tmpGroovyFileName = path.resolve(cnPath + "/" + tmpFileNm);
-            cnFiles = "**/" + tmpFileNm;
+            cnFiles = ["**/" + tmpFileNm];
         }
 
-        await fs.writeFile(result.tmpGroovyFileName, normalizeNewLines(options.source));
+        await fs.writeFile(result.tmpGroovyFileName, normalizeNewLines(options.source)).catch(err => {
+            throw new Error(`Unable to write temp file: ${err}`); // Ensure we have a stack trace.
+        });
+
         debug(`CREATE GROOVY temp file ${result.tmpGroovyFileName} with input source, as CodeNarc requires physical files`);
     }
 
     // Define base directory
     const baseBefore = (cnPath !== "." && cnPath.startsWith("/")) || cnPath.includes(":/") || cnPath.includes(":\\") ? "" : process.cwd() + "/";
     const codeNarcBaseDir =
-        positionalArgs.length > 0
-            ? await getCodeNarcBaseDirFromFiles(positionalArgs)
-            : cnPath !== "."
-            ? baseBefore + cnPath.replace(/^"(.*)"$/, "$1")
-            : process.cwd();
+        positionalArgs.length > 0 ? await getCodeNarcBaseDirFromFiles(positionalArgs) : cnPath !== "." ? baseBefore + cnPath : process.cwd();
     result.codeNarcBaseDir = path.resolve(codeNarcBaseDir);
     result.codenarcArgs.push(`-basedir=${result.codeNarcBaseDir}`);
 
@@ -74,69 +80,66 @@ async function prepareCodeNarcCall(options) {
         result.codenarcArgs.push(`-ruleset=${encodeURIComponent(options.rulesets)}`);
     } else {
         // File list format
-        const rulesetFileArgs = options.rulesets.startsWith("file:") ? options.rulesets : `file:${options.rulesets.replace(/^"(.*)"$/, "$1")}`;
+        const rulesetFileArgs = options.rulesets.startsWith("file:") ? options.rulesets : `file:${options.rulesets}`;
         result.codenarcArgs.push(`-rulesetfiles=${rulesetFileArgs}`);
     }
 
-    // Default file patterns
-    let filePatterns = defaultFilesPattern.map(filePattern => `**/${filePattern}`).join(",");
-
     // Build codenarc arguments from eslint-like formatted positional arguments
     if (positionalArgs.length > 0) {
-        if (options.ext && options.ext.length > 0) {
-            filePatterns = `/**/*.{` + options.extensions.map(ext => ext.replace(/^\./u, "")) + "}";
+        const filePatterns =
+            options.ext && options.ext.length > 0
+                ? // Convert extensions with or without leading slash into an ant pattern.
+                  options.ext.map(ext => ext.replace(/^\.?/u, "*."))
+                : defaultFilesPattern;
+        const sourceFiles = [];
+        const includes = [];
+        positionalArgs.filter(Boolean).forEach(pathname => {
+            const absolutePath = path.resolve(".", pathname);
+            const relativePath = path.relative(codeNarcBaseDir, absolutePath);
+            if (directoryExists(absolutePath)) {
+                // Directory: convert into ant patterns.
+                const patternBase = antPath(relativePath) + "**/";
+                includes.push(...filePatterns.map(filePattern => patternBase + filePattern));
+            } else if (fs.existsSync(absolutePath)) {
+                // File: add to file / patterns list.
+                const file = antPath(relativePath);
+                includes.push(file);
+                sourceFiles.push(absolutePath);
+            } else {
+                // Ant pattern.
+                includes.push(antPath(path.normalize(pathname)));
+            }
+        });
+
+        if (includes.length > 0) {
+            result.codenarcArgs.push(`-includes=${includes.join(",")}`);
+        } else if (sourceFiles.length > 0) {
+            // Source files override patterns, so only use if we have no patterns.
+            result.codenarcArgs.push(`-sourcefiles=${sourceFiles.join(",")}`);
         }
-        const fileList = [];
-        const patternsFinal = positionalArgs
-            .filter(Boolean)
-            .map(pathname => {
-                let finalPattern = path.normalize(pathname).replace(/\\/gu, "/");
-                // Directory: convert into ant pattern
-                const resolvedPath = path.resolve(cnPath, pathname);
-                if (directoryExists(resolvedPath)) {
-                    finalPattern = "**/" + path.normalize(pathname.replace(/[/\\]$/u, "")).replace(/\\/gu, "/") + filePatterns;
-                }
-                // Relative with codeNarcBaseDir
-                else if (fs.existsSync(path.join(result.codeNarcBaseDir, finalPattern))) {
-                    const absolutePath = path.resolve(finalPattern).replace(/\\/gu, "/");
-                    fileList.push(absolutePath);
-                    const relativePath = finalPattern.replace(/\\/gu, "/");
-                    finalPattern = "**/" + path.normalize(relativePath.replace(/[/\\]$/u, "")).replace(/\\/gu, "/");
-                }
-                // Absolute or cwd - relative path file
-                else if (fs.existsSync(finalPattern)) {
-                    const absolutePath = path.resolve(finalPattern).replace(/\\/gu, "/");
-                    fileList.push(absolutePath);
-                    const relativePath = path.relative(result.codeNarcBaseDir, path.resolve(finalPattern)).replace(/\\/gu, "/");
-                    finalPattern = "**/" + path.normalize(relativePath.replace(/[/\\]$/u, "")).replace(/\\/gu, "/");
-                }
-                // Directory or ant pattern
-                return finalPattern;
-            })
-            .join(",");
-        result.codenarcArgs.push(`-includes="${patternsFinal}"`);
-        result.codeNarcIncludes = patternsFinal;
-        result.inputFileList = fileList;
+
+        result.codeNarcIncludes = includes;
+        result.inputFileList = sourceFiles;
     }
     // Matching files pattern(s)
     else if (cnFiles) {
-        const normalizedCnFiles = cnFiles.replace(/^"(.*)"$/, "$1");
-        result.codenarcArgs.push(`-includes="${normalizedCnFiles}"`);
-        result.codeNarcIncludes = normalizedCnFiles;
+        result.codenarcArgs.push(`-includes=${cnFiles.join(",")}`);
+        result.codeNarcIncludes = cnFiles;
     } else {
         // If files not sent, use defaultFilesPattern, guessed from options.rulesets value
-        result.codenarcArgs.push(`-includes="${filePatterns}"`);
+        const filePatterns = defaultFilesPattern.map(filePattern => `**/${filePattern}`);
+        result.codenarcArgs.push(`-includes=${filePatterns.join(",")}`);
         result.codeNarcIncludes = filePatterns;
     }
 
     // Ignore pattern
     if (options.ignorepattern) {
-        result.codenarcArgs.push(`-excludes="${options.ignorepattern}"`);
-        result.codeNarcExcludes = options.ignorepattern;
+        result.codenarcArgs.push(`-excludes=${options.ignorepattern}`);
+        result.codeNarcExcludes = options.ignorepattern.split(",");
     }
 
     // Output
-    result.output = options.output.replace(/^"(.*)"$/, "$1");
+    result.output = options.output;
     if (
         ["txt", "json", "sarif", "none", "stdout"].includes(result.output) ||
         result.output.endsWith(".txt") ||
@@ -181,6 +184,16 @@ async function prepareCodeNarcCall(options) {
     return result;
 }
 
+/**
+ * Converts a path with forward slashes to backslashes.
+ *
+ * @param {string} path The path to convert
+ * @returns The converted path
+ */
+function antPath(path) {
+    return path.replace(/\\/gu, "/");
+}
+
 // Calculate longest base dir by analyzing the list of files
 async function getCodeNarcBaseDirFromFiles(positionalArgs) {
     // All arguments are not files
@@ -504,15 +517,6 @@ function getCodeNarcPriorityCode(ruleFromConfig) {
     return null;
 }
 
-async function manageDeleteTmpFiles(tmpGroovyFileName) {
-    // Remove temporary groovy file created for source argument if provided
-    if (tmpGroovyFileName) {
-        await fs.remove(tmpGroovyFileName);
-        debug(`Removed temp file ${tmpGroovyFileName} as it is not longer used`);
-        tmpGroovyFileName = null;
-    }
-}
-
 function directoryExists(resolvedPath) {
     try {
         return fs.statSync(resolvedPath).isDirectory();
@@ -524,4 +528,4 @@ function directoryExists(resolvedPath) {
     }
 }
 
-module.exports = { prepareCodeNarcCall, parseCodeNarcResult, manageDeleteTmpFiles };
+module.exports = { prepareCodeNarcCall, parseCodeNarcResult };

package/lib/example/fake_node_modules/samplefolder/ToIgnore.groovy

@@ -1 +1 @@
-println 'This file should not be linted if --ignorepattern is **/node_modules/**' ;
+println 'This file should not be linted if --ignorepattern is **/fake_node_modules/**' ;

package/lib/groovy-lint.js

@@ -7,7 +7,7 @@ const performance = require("perf_hooks").performance;
 
 const NpmGroovyLintFix = require("./groovy-lint-fix");
 const CodeNarcCaller = require("./codenarc-caller");
-const { prepareCodeNarcCall, parseCodeNarcResult, manageDeleteTmpFiles } = require("./codenarc-factory");
+const { prepareCodeNarcCall, parseCodeNarcResult } = require("./codenarc-factory");
 const { NPM_GROOVY_LINT_CONSTANTS, loadConfig, getConfigFileName } = require("./config.js");
 const optionsDefinition = require("./options");
 const { computeStats, processOutput } = require("./output.js");
@@ -98,7 +98,19 @@ class NpmGroovyLint {
         this.lintResult = computeStats(this.lintResult);
         this.outputString = await processOutput(this.outputType, this.output, this.lintResult, this.options, this.fixer);
         // Delete Tmp file if existing
-        manageDeleteTmpFiles(this.tmpGroovyFileName);
+        await this.manageDeleteTmpFiles();
+    }
+
+    // Delete tmp file if needed.
+    async manageDeleteTmpFiles() {
+        if (!this.tmpGroovyFileName) {
+            return;
+        }
+
+        await fs.remove(this.tmpGroovyFileName);
+        console.log(`GroovyLint: Removed temp file ${this.tmpGroovyFileName} as it is not longer used`);
+        debug(`Removed temp file ${this.tmpGroovyFileName} as it is not longer used`);
+        this.tmpGroovyFileName = null;
     }
 
     // Returns the full path of the configuration file
@@ -119,10 +131,12 @@ class NpmGroovyLint {
     async preProcess() {
         // Reset status so we don't get stale results.
         this.status = 0;
-
         // Manage when the user wants to use only codenarc args
         if (Array.isArray(this.args) && this.args.includes("--codenarcargs")) {
-            this.codenarcArgs = this.args.slice(2).filter(userArg => userArg !== "--codenarcargs");
+            this.codenarcArgs = this.args
+                .slice(2)
+                .filter(userArg => userArg !== "--codenarcargs") // Strip codenarcargs.
+                .map(userArg => userArg.replace(/^-(\w+)="(.*)"$/, "-$1=$2").replace(/^-(\w+)='(.*)'$/, "-$1=$2")); // Strip quotes around values which CodeNarc doesn't support.
             this.onlyCodeNarc = true;
             return true;
         }
@@ -132,6 +146,12 @@ class NpmGroovyLint {
         if (this.parseOptions) {
             try {
                 this.options = optionsDefinition.parse(this.args);
+                // Strip quotes around values which CodeNarc doesn't support.
+                for (const [key, value] of Object.entries(this.options)) {
+                    if (typeof value === "string") {
+                        this.options[key] = value.replace(/^"(.*)"$/, "$1").replace(/^'(.*)'$/, "$1");
+                    }
+                }
                 const configProperties = await loadConfig(
                     this.options.config || this.options.path,
                     this.options.format ? "format" : "lint",
@@ -330,7 +350,7 @@ class NpmGroovyLint {
             }
         }
 
-        manageDeleteTmpFiles(this.tmpGroovyFileName);
+        await this.manageDeleteTmpFiles();
 
         // Manage return code in case failonerror, failonwarning or failoninfo is called
         this.manageReturnCode();

package/lib/utils.js

@@ -255,7 +255,11 @@ function getOutOfBracesStrings(str, exclude = []) {
 
 // Split source lines to analyse
 async function getSourceLines(source, fileNm) {
-    let fileContent = source || (await fse.readFile(fileNm));
+    let fileContent =
+        source ||
+        (await fse.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);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-groovy-lint",
-  "version": "12.2.1-beta202311260926.0",
+  "version": "13.0.0",
   "description": "Lint, format and auto-fix your Groovy / Jenkinsfile / Gradle files",
   "main": "index.js",
   "scripts": {
@@ -48,7 +48,7 @@
   "dependencies": {
     "amplitude": "^5.1.6",
     "ansi-colors": "^4.1.1",
-    "axios": "^1.6.0",
+    "axios": "^1.6.2",
     "chalk": "^4.1.2",
     "cli-progress": "^3.12.0",
     "commondir": "^1.0.1",
@@ -107,5 +107,8 @@
       "html"
     ],
     "all": true
+  },
+  "overrides": {
+    "axios": "^1.6.2"
   }
 }