npm-groovy-lint 9.4.1 → 10.0.1

package/lib/.groovylintrc-format.json

@@ -29,6 +29,7 @@
     "formatting.SpaceAfterComma": {},
     "formatting.SpaceAfterFor": {},
     "formatting.SpaceAfterIf": {},
+    "formatting.SpaceAfterMethodCallName": {},
     "formatting.SpaceAfterOpeningBrace": {},
     "formatting.SpaceAfterSemicolon": {},
     "formatting.SpaceAfterSwitch": {},
@@ -38,6 +39,7 @@
     "formatting.SpaceAroundOperator": {},
     "formatting.SpaceBeforeClosingBrace": {},
     "formatting.SpaceBeforeOpeningBrace": {},
+    "formatting.SpaceInsideParentheses": {},
     "formatting.TrailingWhitespace": {},
     "unnecessary.UnnecessaryGString": {},
     "unnecessary.UnnecessarySemicolon": {}

package/lib/codenarc-caller.js

@@ -39,7 +39,7 @@ class CodeNarcCaller {
             rootPath: __dirname,
             mainClass: "org.codenarc.CodeNarc",
             classPath:
-                "java/CodeNarc-2.2.0.jar:java/groovy/lib/groovy-3.0.9.jar:java/groovy/lib/groovy-templates-3.0.9.jar:java/groovy/lib/groovy-xml-3.0.9.jar:java/groovy/lib/groovy-json-3.0.9.jar:java/groovy/lib/groovy-ant-3.0.9.jar:java/groovy/lib/ant-1.10.11.jar:java/groovy/lib/ant-launcher-1.10.11.jar:java/slf4j-api-1.7.9.jar:java/log4j-slf4j-impl-2.17.1.jar:java/log4j-api-2.17.1.jar:java/log4j-core-2.17.1.jar:java/gmetrics-1.1.jar:java/*"
+                "java/CodeNarc-3.1.0.jar:java/groovy/lib/groovy-3.0.9.jar:java/groovy/lib/groovy-templates-3.0.9.jar:java/groovy/lib/groovy-xml-3.0.9.jar:java/groovy/lib/groovy-json-3.0.9.jar:java/groovy/lib/groovy-ant-3.0.9.jar:java/groovy/lib/ant-1.10.11.jar:java/groovy/lib/ant-launcher-1.10.11.jar:java/slf4j-api-1.7.9.jar:java/log4j-slf4j-impl-2.18.0.jar:java/log4j-api-2.18.0.jar:java/log4j-core-2.18.0.jar:java/GMetrics-2.1.0.jar:java/*"
         }
     };
 
@@ -60,7 +60,10 @@ class CodeNarcCaller {
         // 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(':"', ":");
+                codeNarcArg = codeNarcArg
+                    .replace('="', "=")
+                    .replace(':"', ":")
+                    .replace(/ /g, "%20");
                 codeNarcArg = codeNarcArg.substring(0, codeNarcArg.length - 1);
             }
             return codeNarcArg;
@@ -76,7 +79,8 @@ class CodeNarcCaller {
                 codeNarcIncludes: this.execOpts.codeNarcIncludes,
                 codeNarcExcludes: this.execOpts.codeNarcExcludes,
                 parse: this.options.parse !== false && this.execOpts.onlyCodeNarc === false ? true : false,
-                file: this.execOpts.groovyFileName ? this.execOpts.groovyFileName : null,
+                file: this.execOpts.groovyFileName || null,
+                fileList: this.execOpts.inputFileList || null,
                 requestKey: this.execOpts.requestKey || null
             },
             timeout: 600000

package/lib/codenarc-factory.js

@@ -18,6 +18,8 @@ const npmGroovyLintRules = getNpmGroovyLintRules();
 const CODENARC_TMP_FILENAME_BASE = "codeNarcTmpDir_";
 const CODENARC_WWW_BASE = "https://codenarc.github.io/CodeNarc";
 
+const defaultFilesPattern = ["*.groovy", "*.gvy", "Jenkinsfile", "*.gradle", "*.nf"];
+
 // Convert NPM-groovy-lint into codeNarc arguments
 // Create temporary files if necessary
 async function prepareCodeNarcCall(options) {
@@ -25,6 +27,7 @@ async function prepareCodeNarcCall(options) {
 
     let cnPath = options.path;
     let cnFiles = options.files;
+    const positionalArgs = options._ || [];
 
     // If source option, create a temporary Groovy file
     if (options.source) {
@@ -59,9 +62,6 @@ async function prepareCodeNarcCall(options) {
     // Create ruleSet groovy file if necessary
     options.rulesets = await buildRuleSets(options);
 
-    // Build ruleSet & file CodeNarc arguments
-    let defaultFilesPattern = "**/*.groovy,**/*.gvy,**/Jenkinsfile,**/*.gradle,**/*.nf";
-
     // RuleSets codeNarc args
     if (options.rulesets && options.rulesets.startsWith("{")) {
         // JSON format
@@ -72,32 +72,76 @@ async function prepareCodeNarcCall(options) {
         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 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;
+                }
+                // Absolute or cwd - relative path file
+                if (fs.existsSync(finalPattern)) {
+                    const absolutePath = path.resolve(finalPattern).replace(/\\/gu, "/");
+                    const relativePath = path.relative(process.cwd(), path.resolve(finalPattern)).replace(/\\/gu, "/");
+                    fileList.push(absolutePath);
+                    finalPattern = "**/" + path.normalize(relativePath.replace(/[/\\]$/u, "")).replace(/\\/gu, "/");
+                }
+                // Relative with codeNardBaseDir
+                else if (fs.existsSync(path.join(result.codeNarcBaseDir, finalPattern))) {
+                    const relativePath = path.relative(process.cwd(), path.join(result.codeNarcBaseDir, finalPattern)).replace(/\\/gu, "/");
+                    fileList.push(relativePath);
+                    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;
+    }
     // Matching files pattern(s)
-    if (cnFiles) {
+    else if (cnFiles) {
         const normalizedCnFiles = cnFiles.replace(/^"(.*)"$/, "$1");
-        result.codenarcArgs.push(`-includes=${normalizedCnFiles}`);
+        result.codenarcArgs.push(`-includes="${normalizedCnFiles}"`);
         result.codeNarcIncludes = normalizedCnFiles;
     } else {
         // If files not sent, use defaultFilesPattern, guessed from options.rulesets value
-        result.codenarcArgs.push(`-includes=${defaultFilesPattern}`);
-        result.codeNarcIncludes = defaultFilesPattern;
+        result.codenarcArgs.push(`-includes="${filePatterns}"`);
+        result.codeNarcIncludes = filePatterns;
     }
 
     // Ignore pattern
     if (options.ignorepattern) {
-        result.codenarcArgs.push(`-excludes=${options.ignorepattern}`);
+        result.codenarcArgs.push(`-excludes="${options.ignorepattern}"`);
         result.codeNarcExcludes = options.ignorepattern;
     }
 
     // Output
     result.output = options.output.replace(/^"(.*)"$/, "$1");
-    if (["txt", "json", "sarif", "none"].includes(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.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())) {
@@ -253,7 +297,7 @@ async function parseCodeNarcResult(options, codeNarcBaseDir, codeNarcJsonResult,
                             const evaluatedVars = evaluateVariables(errRule.variables, errItem.msg, { verbose: options.verbose });
                             const errLine = allLines[errItem.line - 1];
                             const range = evaluateRange(errItem, errRule, evaluatedVars, errLine, allLines, { verbose: options.verbose });
-                            if (range) {
+                            if (range && range.start.character > -1) {
                                 errItem.range = range;
                             }
                         }
@@ -347,6 +391,10 @@ async function buildRuleSets(options) {
                         ? ruleOptions
                         : ruleFromConfig;
             const ruleDef = buildCodeNarcRule(ruleName, mergedRuleConfig);
+            // If rule has been sent as argument, enable it by default
+            if (ruleDef.enabled === false) {
+                ruleDef.enabled = true;
+            }
             return ruleDef;
         });
     }
@@ -385,6 +433,10 @@ async function buildRuleSets(options) {
         delete rule.ruleName;
         ruleSetJson[ruleName] = rule;
     }
+    // Remove UnnecessarySubstring as it is no longer in CodeNarc v3
+    if (ruleSetJson["UnnecessarySubstring"] != null) {
+        delete ruleSetJson["UnnecessarySubstring"];
+    }
     return JSON.stringify(ruleSetJson);
 }
 
@@ -428,4 +480,15 @@ async function manageDeleteTmpFiles(tmpGroovyFileName) {
     }
 }
 
+function directoryExists(resolvedPath) {
+    try {
+        return fs.statSync(resolvedPath).isDirectory();
+    } catch (error) {
+        if (error && (error.code === "ENOENT" || error.code === "ENOTDIR")) {
+            return false;
+        }
+        throw error;
+    }
+}
+
 module.exports = { prepareCodeNarcCall, parseCodeNarcResult, manageDeleteTmpFiles };