npm-groovy-lint 10.0.3 → 11.0.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## UNRELEASED
 
+## [11.0.0] 2022-10-07
+
+- **BREAKING CHANGE**:`--failon` is now `ìnfo` by default, meaning exit code will be `1` if there is at least an info issue found. To have previous behaviour, use `--failon none`.
+- Display all files in console log only if `--verbose` is used ([#243](https://github.com/nvuillam/npm-groovy-lint/issues/243))
+
+## [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

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

@@ -136,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")

package/lib/config.js

@@ -239,7 +239,7 @@ async function loadYAMLConfigFile(filePath) {
     try {
         // empty YAML file can be null, so always use
         const fileContent = await readFile(filePath);
-        return yaml.safeLoad(fileContent) || {};
+        return yaml.load(fileContent) || {};
     } catch (e) {
         debug(`Error reading YAML file: ${filePath}`);
         e.message = `Cannot read config file: ${filePath}\nError: ${e.message}`;

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 = {
@@ -455,6 +467,10 @@ class NpmGroovyLint {
 
     // Exit with code 1 if failon, failonerror, failonwarning or failoninfo is set
     manageReturnCode() {
+        if (this.status > 1) {
+            // There has been a fatal error before, so there are no results
+            return ;
+        }
         const failureLevel =
             this.options.failon && this.options.failon !== "none"
                 ? this.options.failon
@@ -468,6 +484,10 @@ class NpmGroovyLint {
         if (failureLevel === "none") {
             return;
         }
+        if (this.lintResult.summary == null) {
+            // Special case like --codenarcargs (should not be used in thee future)
+            return;
+        }
 
         const errorNb = this.lintResult.summary.totalFoundErrorNumber;
         const warningNb = this.lintResult.summary.totalFoundWarningNumber;
@@ -475,14 +495,14 @@ class NpmGroovyLint {
 
         // Fail on error
         if (failureLevel === "error" && errorNb > 0) {
-            if (!["json", "sarif"].includes(this.outputType)) {
+            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)) {
-            if (!["json", "sarif"].includes(this.outputType)) {
+            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`
                 );
@@ -491,7 +511,7 @@ class NpmGroovyLint {
         }
         // Fail on info
         else if (failureLevel === "info" && (errorNb > 0 || warningNb > 0 || infoNb > 0)) {
-            if (!["json", "sarif"].includes(this.outputType)) {
+            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`
                 );

package/lib/options.js

@@ -139,7 +139,7 @@ module.exports = optionator({
             option: "failon",
             type: "String",
             enum: ["error", "warning", "info", "none"],
-            default: "none",
+            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"]

package/lib/output.js

@@ -108,11 +108,13 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
         // Errors
         for (const fileNm of Object.keys(lintResult.files)) {
             const fileErrors = lintResult.files[fileNm].errors;
-            outputString += c.underline(fileNm) + "\n";
+            let fileOutputString = c.underline(fileNm) + "\n";
+            let showFileInOutput = false ;
             for (const err of fileErrors) {
                 if (!isErrorInLogLevelScope(err.severity, options.loglevel)) {
                     continue;
                 }
+                showFileInOutput = true ;
                 let color = "grey";
                 switch (err.severity) {
                     case "error":
@@ -135,7 +137,7 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
                     }
                 }
                 // Build error output line
-                outputString +=
+                fileOutputString +=
                     "  " +
                     err.line.toString().padEnd(4, " ") +
                     "  " +
@@ -146,7 +148,10 @@ async function processOutput(outputType, output, lintResult, options, fixer = nu
                     err.rule.padEnd(24, " ") +
                     "\n";
             }
-            outputString += "\n";
+            fileOutputString += "\n";
+            if (showFileInOutput || options.verbose) {
+                outputString += fileOutputString ;
+            }
         }
         outputString += "\nnpm-groovy-lint results in " + c.bold(lintResult.summary.totalFilesLinted) + " linted files:";
 
@@ -205,7 +210,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 +226,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.3",
+  "version": "11.0.0",
   "description": "Lint, format and auto-fix your Groovy / Jenkinsfile / Gradle files",
   "main": "index.js",
   "scripts": {