npm-groovy-lint 10.0.1 → 10.1.0

package/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 ## UNRELEASED
 
+## [10.1.0] 2022-08-15
+
+- Allow to send groovy sources as input from stdin
+- If `--format` or `--fix` option is used when source is sent as stdin, the result is output as stdout
+
+Example: `cat path/to/my/Jenkinsfile | npm-groovy-lint --format -`
+
+## [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))

package/README.md

@@ -43,8 +43,6 @@ Any **question**, **problem** or **enhancement request** ? Ask [**here**](https:
     npm-groovy-lint [OPTIONS] [FILES|PATH|PATTERN]
 ```
 
-See [examples](#example-calls)
-
 | Parameter               | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 |-------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | -o<br/> --output        | String  | Output format (txt,json,sarif,html,xml), or path to a file with one of these extensions<br/> Default: `txt`<br/> Examples:<br/> - `"txt"`<br/> - `"json"`<br/> - `"./logs/myLintResults.txt"`<br/> - `"./logs/myLintResults.sarif"`<br/> - `"./logs/myLintResults.html"`<br/> - `"./logs/myLintResults.xml"`                                                                                                                                                                                                                                                                  |
@@ -72,6 +70,68 @@ See [examples](#example-calls)
 | -p<br/> --path          | String  | (DEPRECATED) Directory containing the files to lint<br/> Example: `./path/to/my/groovy/files`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | -f<br/> --files         | String  | (DEPRECATED) Comma-separated list of Ant-style file patterns specifying files that must be included.<br/> Default: `"**/*.groovy,**/Jenkinsfile,**/*.gradle"`<br/>Examples:<br/> - `"**/Jenkinsfile"`<br/> - `"**/*.groovy"`<br/> - `"**/*.gradle"`<br/> - `"**/mySingleFile.groovy"`                                                                                                                                                                                                                                                                                         |
 
+### Example calls
+
+- Lint a file
+
+```shell
+    npm-groovy-lint path/to/my/groovy/file.groovy
+```
+
+- Lint multiple files
+
+```shell
+    npm-groovy-lint path/to/my/groovy/file.groovy path/to/my/groovy/file2.groovy path/to/my/groovy/file3.groovy
+```
+
+- Lint directory
+
+```shell
+    npm-groovy-lint path/to/my/groovy
+```
+
+- Lint pattern
+
+```shell
+    npm-groovy-lint path/to/my/groovy/*.groovy
+```
+
+- Lint groovy with JSON output
+
+```shell
+    npm-groovy-lint --output json
+```
+
+- Format files
+
+```shell
+    npm-groovy-lint --format my/path/to/file.groovy my/path/to/file2.groovy
+```
+
+- Format and fix files
+
+```shell
+    npm-groovy-lint --fix my/path/to/file.groovy my/path/to/file2.groovy
+```
+
+- Get formatted sources in stdout from stdin
+
+```shell
+    cat path/to/my/Jenkinsfile | npm-groovy-lint --format -
+```
+
+- Advanced config
+
+```shell
+    npm-groovy-lint --path "./path/to/my/groovy/files" --files "**/*.groovy" --config "./config/codenarc/.groovylintrcCustom.js" --loglevel warning --output txt
+```
+
+- Lint using core CodeNarc parameters and generate HTML report file
+
+```shell
+    npm-groovy-lint --codenarcargs -basedir="lib/example" -rulesetfiles="file:lib/example/RuleSet-Groovy.groovy" -title="TestTitleCodenarc" -maxPriority1Violations=0' -report="html:ReportTestCodenarc.html"
+```
+
 ## Installation
 
 ```shell
@@ -145,50 +205,6 @@ OR
 }
 ```
 
-## Example calls
-
-- Lint a file
-
-```shell
-    npm-groovy-lint path/to/my/groovy/file.groovy
-```
-
-- Lint multiple files
-
-```shell
-    npm-groovy-lint path/to/my/groovy/file.groovy path/to/my/groovy/file2.groovy path/to/my/groovy/file3.groovy
-```
-
-- Lint directory
-
-```shell
-    npm-groovy-lint path/to/my/groovy
-```
-
-- Lint pattern
-
-```shell
-    npm-groovy-lint path/to/my/groovy/*.groovy
-```
-
-- Lint groovy with JSON output
-
-```shell
-    npm-groovy-lint --output json
-```
-
-- Advanced config
-
-```shell
-    npm-groovy-lint --path "./path/to/my/groovy/files" --files "**/*.groovy" --config "./config/codenarc/.groovylintrcCustom.js" --loglevel warning --output txt
-```
-
-- Lint using core CodeNarc parameters and generate HTML report file
-
-```shell
-    npm-groovy-lint --codenarcargs -basedir="lib/example" -rulesetfiles="file:lib/example/RuleSet-Groovy.groovy" -title="TestTitleCodenarc" -maxPriority1Violations=0' -report="html:ReportTestCodenarc.html"
-```
-
 ## Disabling rules in source
 
 You can disable rules directly by adding comment in file, using [eslint style](https://eslint.org/docs/user-guide/configuring#disabling-rules-with-inline-comments)

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,17 +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)) {
+                // Relative with codeNarcBaseDir
+                else if (fs.existsSync(path.join(result.codeNarcBaseDir, finalPattern))) {
                     const absolutePath = path.resolve(finalPattern).replace(/\\/gu, "/");
-                    const relativePath = path.relative(process.cwd(), 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
@@ -131,7 +136,7 @@ async function prepareCodeNarcCall(options) {
     // Output
     result.output = options.output.replace(/^"(.*)"$/, "$1");
     if (
-        ["txt", "json", "sarif", "none"].includes(result.output) ||
+        ["txt", "json", "sarif", "none", "stdout"].includes(result.output) ||
         result.output.endsWith(".txt") ||
         result.output.endsWith(".sarif") ||
         result.output.endsWith(".json")
@@ -174,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

@@ -1,5 +1,6 @@
 // Imports
 const debug = require("debug")("npm-groovy-lint");
+const fs = require("fs-extra");
 const os = require("os");
 const performance = require("perf_hooks").performance;
 
@@ -137,6 +138,17 @@ class NpmGroovyLint {
                         this.options[configProp] = configProperties[configProp];
                     }
                 }
+                // Try to catch input from stdin. if found, use it as groovy source
+                if (this.options._ && this.options._[0] === '-') {
+                    const stdInData = fs.readFileSync(0, 'utf-8');
+                    this.options.source = stdInData;
+                    this.options._ = [];
+                    this.options.sourcefilepath = this.options.sourcefilepath || process.cwd();
+                    if (this.options.format || this.options.fix) {
+                        this.options.output = 'stdout';
+                    }
+                }
+
             } catch (err) {
                 this.status = 2;
                 this.error = {
@@ -459,12 +471,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 +487,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", "stdout"].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", "stdout"].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", "stdout"].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/output.js

@@ -205,7 +205,9 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
             outputString = JSON.stringify(lintResult);
             console.log(outputString);
         }
-    } else if (outputType === "sarif") {
+    }
+    // SARIF results
+    else if (outputType === "sarif") {
         const sarifJsonString = buildSarifResult(lintResult);
         // SARIF file
         if (output.endsWith(".sarif")) {
@@ -219,6 +221,10 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
             console.log(sarifJsonString);
         }
     }
+    // stdout result for format / fix with source sent as stdin
+    else if (outputType === "stdout") {
+        console.log(lintResult.files[0].updatedSource);
+    }
     return outputString;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-groovy-lint",
-  "version": "10.0.1",
+  "version": "10.1.0",
   "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",