npm-groovy-lint 10.0.0 → 10.0.3

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## UNRELEASED
 
+## [10.0.3] 2022-08-15
+
+- Do not output results summary in console logs when output is json or sarif
+- Add test methods for SARIF called by CLI
+
+## [10.0.2] 2022-08-15
+
+- Fix error when absolute files sent as positional arguments on a linux system ([#232](https://github.com/nvuillam/npm-groovy-lint/issues/232))
+- Improve performances by calculating the longest command directory to send as base path to CodeNarc
+
+## [10.0.1] 2022-08-14
+
+- Fix error when files sent as positional arguments ([#232](https://github.com/nvuillam/npm-groovy-lint/issues/232))
+
 ## [10.0.0] 2022-08-13
 
 - Core

package/lib/codenarc-factory.js

@@ -2,6 +2,7 @@
 "use strict";
 
 const debug = require("debug")("npm-groovy-lint");
+const commondir = require("commondir");
 const fs = require("fs-extra");
 const os = require("os");
 const path = require("path");
@@ -55,8 +56,11 @@ async function prepareCodeNarcCall(options) {
 
     // Define base directory
     const baseBefore = (cnPath !== "." && cnPath.startsWith("/")) || cnPath.includes(":/") || cnPath.includes(":\\") ? "" : process.cwd() + "/";
-    result.codeNarcBaseDir = cnPath !== "." ? baseBefore + cnPath.replace(/^"(.*)"$/, "$1") : process.cwd();
-    result.codeNarcBaseDir = path.resolve(result.codeNarcBaseDir);
+    const codeNarcBaseDir = positionalArgs.length > 0 ?
+        (await getCodeNarcBaseDirFromFiles(positionalArgs)) :
+        cnPath !== "." ? baseBefore + cnPath.replace(/^"(.*)"$/, "$1") :
+            process.cwd();
+    result.codeNarcBaseDir = path.resolve(codeNarcBaseDir);
     result.codenarcArgs.push(`-basedir=${result.codeNarcBaseDir}`);
 
     // Create ruleSet groovy file if necessary
@@ -90,16 +94,18 @@ async function prepareCodeNarcCall(options) {
                 if (directoryExists(resolvedPath)) {
                     finalPattern = "**/" + path.normalize(pathname.replace(/[/\\]$/u, "")).replace(/\\/gu, "/") + filePatterns;
                 }
-                // Absolute or cwd - relative path file
-                if (fs.existsSync(finalPattern)) {
-                    const relativePath = path.relative(process.cwd(), finalPattern).replace(/\\/gu, "/");
-                    fileList.push(relativePath);
+                // 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, "/");
                 }
-                // 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);
+                // 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
@@ -173,6 +179,25 @@ async function prepareCodeNarcCall(options) {
     return result;
 }
 
+// Calculate longest base dir by analyzing the list of files
+async function getCodeNarcBaseDirFromFiles(positionalArgs) {
+    // All arguments are not files
+    if (!positionalArgs.every(fileOrDirOrPattern => fs.existsSync(fileOrDirOrPattern) || directoryExists(fileOrDirOrPattern))) {
+        return process.cwd()
+    }
+    const folders = positionalArgs.map((fileOrDir) => {
+        // Dir
+        if (directoryExists(fileOrDir)) {
+            return path.resolve(fileOrDir);
+        }
+        // File dir
+        const fileAbsolute = path.resolve(fileOrDir);
+        return path.dirname(fileAbsolute);
+    });
+    const baseDirFromFiles = commondir(folders);
+    return baseDirFromFiles
+}
+
 // Parse XML result file as js object
 async function parseCodeNarcResult(options, codeNarcBaseDir, codeNarcJsonResult, tmpGroovyFileName, parseErrors) {
     if (!codeNarcJsonResult || !codeNarcJsonResult.codeNarc || !codeNarcJsonResult.packages) {

package/lib/groovy-lint.js

@@ -459,12 +459,12 @@ class NpmGroovyLint {
             this.options.failon && this.options.failon !== "none"
                 ? this.options.failon
                 : this.options.failonerror
-                ? "error"
-                : this.options.failonwarning
-                ? "warning"
-                : this.options.failoninfo
-                ? "info"
-                : "none";
+                    ? "error"
+                    : this.options.failonwarning
+                        ? "warning"
+                        : this.options.failoninfo
+                            ? "info"
+                            : "none";
         if (failureLevel === "none") {
             return;
         }
@@ -475,21 +475,27 @@ class NpmGroovyLint {
 
         // Fail on error
         if (failureLevel === "error" && errorNb > 0) {
-            console.error(`Failure: ${this.lintResult.summary.totalFoundErrorNumber} error(s) have been found`);
+            if (!["json", "sarif"].includes(this.outputType)) {
+                console.error(`Failure: ${this.lintResult.summary.totalFoundErrorNumber} error(s) have been found`);
+            }
             this.status = 1;
         }
         // Fail on warning
         else if (failureLevel === "warning" && (errorNb > 0 || warningNb > 0)) {
-            console.error(
-                `Failure: ${this.lintResult.summary.totalFoundErrorNumber} error(s) have been found \n ${this.lintResult.summary.totalFoundWarningNumber} warning(s) have been found`
-            );
+            if (!["json", "sarif"].includes(this.outputType)) {
+                console.error(
+                    `Failure: ${this.lintResult.summary.totalFoundErrorNumber} error(s) have been found \n ${this.lintResult.summary.totalFoundWarningNumber} warning(s) have been found`
+                );
+            }
             this.status = 1;
         }
         // Fail on info
         else if (failureLevel === "info" && (errorNb > 0 || warningNb > 0 || infoNb > 0)) {
-            console.error(
-                `Failure: ${this.lintResult.summary.totalFoundErrorNumber} error(s) have been found \n ${this.lintResult.summary.totalFoundWarningNumber} warning(s) have been found \n ${this.lintResult.summary.totalFoundInfoNumber} info(s) have been found`
-            );
+            if (!["json", "sarif"].includes(this.outputType)) {
+                console.error(
+                    `Failure: ${this.lintResult.summary.totalFoundErrorNumber} error(s) have been found \n ${this.lintResult.summary.totalFoundWarningNumber} warning(s) have been found \n ${this.lintResult.summary.totalFoundInfoNumber} info(s) have been found`
+                );
+            }
             this.status = 1;
         }
     }

package/lib/index.js

@@ -13,6 +13,10 @@ const linter = new NpmGroovyLint(process.argv, { origin: "index" });
         process.exitCode = linter.status;
     } catch (err) {
         console.error("Unexpected error: " + err.message + "\n" + err.stack);
-        process.exitCode = 1;
+        process.exitCode = 2;
+        // Quit if called by CLI and not as a module
+        if (require.main === module) {
+            process.exit();
+        }
     }
 })();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-groovy-lint",
-  "version": "10.0.0",
+  "version": "10.0.3",
   "description": "Lint, format and auto-fix your Groovy / Jenkinsfile / Gradle files",
   "main": "index.js",
   "scripts": {
@@ -49,6 +49,7 @@
     "axios": "^0.21.1",
     "chalk": "^4.1.2",
     "cli-progress": "^3.10.0",
+    "commondir": "^1.0.1",
     "debug": "^4.1.1",
     "decode-html": "^2.0.0",
     "find-java-home": "^1.1.0",