npm-groovy-lint 8.2.0 → 9.3.0

package/CHANGELOG.md

@@ -1,6 +1,29 @@
 # Changelog
 
-## [8.2.0] 2020-12-14
+## UNRELEASED
+
+## [9.3.0] 2021-12-29
+
+- Upgrade log4j dependencies because of [security issue](https://nvd.nist.gov/vuln/detail/CVE-2021-44832).
+
+## [9.2.0] 2021-12-23
+
+- Upgrade log4j dependencies because of (another) [security issue](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-45105) (#196)
+
+## [9.1.0] 2021-12-14
+
+- Upgrade log4j dependencies because of [security issue](https://unit42.paloaltonetworks.com/apache-log4j-vulnerability-cve-2021-44228/) (#194)
+
+## [9.0.0] 2021-09-30
+
+- Upgrade to [CodeNarc v2.2.0](https://github.com/CodeNarc/CodeNarc/releases/tag/v2.2.0)
+- Upgrade to [Groovy v3.0.9](https://groovy-lang.org/)
+- Reorganize sources test folder
+- Use java from 8 to 14 (install it if a later version is found)
+- Add timeouts in CI jobs
+- Add colors in error logs
+
+## [8.2.0] 2021-06-11
 
 - Upgrade dependencies advised by dependabot
 - Fix Mega-Linter errors found

package/README.md

@@ -16,6 +16,8 @@
 
 ## Groovy & Jenkinsfile Linter, Formatter and Auto-fixer
 
+_**New: The [article about the story of npm-groovy-lint](https://nicolas.vuillamy.fr/a-groovy-journey-to-open-source-during-covid-19-npm-groovy-lint-8d88c7eecebc), and why you should dive in open-source community !**_
+
 Based on [CodeNarc](http://codenarc.github.io/CodeNarc/) , this out of the box package allows to **track groovy errors** and **correct a part of them**
 
 - Use option **--format** to format & prettify source code
@@ -73,8 +75,9 @@ Any **question**, **problem** or **enhancement request** ? Ask [**here**](https:
 ```shell
     npm install -g npm-groovy-lint
 ```
-
-Node.js >= 12 is required to run this package. If you can't upgrade, you can use [nvm](https://github.com/nvm-sh/nvm) to have [different node versions on your computer](https://www.sitepoint.com/quick-tip-multiple-versions-node-nvm/)
+- If you have issues with v9, install previous version with `npm install -g npm-groovy-lint@8.2.0`
+- Node.js >= 12 is required to run this package. If you can't upgrade, you can use [nvm](https://github.com/nvm-sh/nvm) to have [different node versions on your computer](https://www.sitepoint.com/quick-tip-multiple-versions-node-nvm/)
+- If you do not have java (from 8 to 14) installed on your computer npm-groovy-lint will install them for you, so the first run may be long.
 
 ## Configuration
 
@@ -343,13 +346,13 @@ node {
 Run with default settings
 
 ```shell
-docker run -u "$(id -u):$(id -g)" -w=/tmp -v "$PWD":/tmp nvuillam/npm-groovy-lint
+docker run --rm -u "$(id -u):$(id -g)" -w=/tmp -v "$PWD":/tmp nvuillam/npm-groovy-lint
 ```
 
 Run with additional flags by simply appending them at after docker image name:
 
 ```shell
-docker run -u "$(id -u):$(id -g)" -w=/tmp -v "$PWD":/tmp nvuillam/npm-groovy-lint --failon warning --verbose
+docker run --rm -u "$(id -u):$(id -g)" -w=/tmp -v "$PWD":/tmp nvuillam/npm-groovy-lint --failon warning --verbose
 ```
 
 ### Other
@@ -367,7 +370,7 @@ Example
 ```
 
 ```javascript
-    const NpmGroovyLint = require("npm-groovy-lint/groovy-lint.js");
+    const NpmGroovyLint = require("npm-groovy-lint/lib/groovy-lint.js");
     const fse = require("fs-extra");
 
     const npmGroovyLintConfig = {

package/lib/.groovylintrc-all.json

@@ -39,6 +39,7 @@
         "basic.HardCodedWindowsRootDirectory": {},
         "basic.IntegerGetInteger": {},
         "basic.MultipleUnaryOperators": {},
+        "basic.ParameterAssignmentInFilterClosure": {},
         "basic.RandomDoubleCoercedToZero": {},
         "basic.RemoveAllOnSelf": {},
         "basic.ReturnFromFinallyBlock": {},
@@ -185,11 +186,15 @@
         "formatting.LineLength": {},
         "formatting.MissingBlankLineAfterImports": {},
         "formatting.MissingBlankLineAfterPackage": {},
+        "formatting.MissingBlankLineBeforeAnnotatedField": {},
         "formatting.SpaceAfterCatch": {},
         "formatting.SpaceAfterClosingBrace": {},
         "formatting.SpaceAfterComma": {},
         "formatting.SpaceAfterFor": {},
         "formatting.SpaceAfterIf": {},
+        "formatting.SpaceAfterMethodCallName": {},
+        "formatting.SpaceAfterMethodDeclarationName": {},
+        "formatting.SpaceAfterNotOperator": {},
         "formatting.SpaceAfterOpeningBrace": {},
         "formatting.SpaceAfterSemicolon": {},
         "formatting.SpaceAfterSwitch": {},
@@ -199,6 +204,7 @@
         "formatting.SpaceAroundOperator": {},
         "formatting.SpaceBeforeClosingBrace": {},
         "formatting.SpaceBeforeOpeningBrace": {},
+        "formatting.SpaceInsideParentheses": {},
         "formatting.TrailingWhitespace": {},
         "generic.IllegalClassMember": {},
         "generic.IllegalClassReference": {},

package/lib/codenarc-caller.js

@@ -6,6 +6,7 @@ const { JavaCaller } = require("java-caller");
 const optionsDefinition = require("./options");
 const { performance } = require("perf_hooks");
 const { getSourceLines } = require("./utils");
+const c = require("chalk");
 
 class CodeNarcCaller {
     "use strict";
@@ -27,16 +28,18 @@ class CodeNarcCaller {
     javaCallerOptions = {
         codeNarcServer: {
             minimumJavaVersion: 8,
+            maximumJavaVersion: 14,
             rootPath: __dirname,
             mainClass: "com.nvuillam.CodeNarcServer",
             classPath: "java/CodeNarcServer.jar:java/*"
         },
         codeNarcJava: {
             minimumJavaVersion: 8,
+            maximumJavaVersion: 14,
             rootPath: __dirname,
             mainClass: "org.codenarc.CodeNarc",
             classPath:
-                "java/CodeNarc-2.0.0.jar:java/groovy/lib/groovy-3.0.5.jar:java/groovy/lib/groovy-templates-3.0.5.jar:java/groovy/lib/groovy-xml-3.0.5.jar:java/groovy/lib/groovy-json-3.0.5.jar:java/groovy/lib/groovy-ant-3.0.5.jar:java/groovy/lib/ant-1.10.8.jar:java/groovy/lib/ant-launcher-1.10.8.jar:java/slf4j-api-1.7.9.jar:java/log4j-slf4j-impl-2.13.0.jar:java/log4j-api-2.13.0.jar:java/log4j-core-2.13.0.jar:java/gmetrics-1.1.jar:java/*"
+                "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/*"
         }
     };
 
@@ -103,10 +106,14 @@ class CodeNarcCaller {
                 };
             } else {
                 console.error(
-                    "CodeNarcServer unexpected error:\n" +
-                        JSON.stringify(e, null, 2) +
-                        "\n" +
-                        (e.response && e.response.data && e.response.data.errorDtl ? JSON.stringify(e.response.data.errorDtl, null, 2) : undefined)
+                    c.red(
+                        "CodeNarcServer unexpected error:\n" +
+                            JSON.stringify(e, null, 2) +
+                            "\n" +
+                            (e.response && e.response.data && e.response.data.errorDtl
+                                ? JSON.stringify(e.response.data.errorDtl, null, 2)
+                                : undefined)
+                    )
                 );
             }
             this.serverStatus = "error";
@@ -255,7 +262,8 @@ class CodeNarcCaller {
         const javaCallRes = await javaCaller.run(scriptArgs, { detached: true, waitForErrorMs: 500 });
 
         if ([666, 1].includes(javaCallRes.status)) {
-            console.error(`Unable to run java command: ${JSON.stringify(javaCallRes)}`);
+            console.error(c.red(`Unable to start CodeNarc server: ${JSON.stringify(javaCallRes)}`));
+            console.error(c.grey(JSON.stringify(scriptArgs)));
             this.serverStatus = "error";
             return false;
         }
@@ -296,7 +304,7 @@ class CodeNarcCaller {
         });
 
         if (this.serverStatus === "running") {
-            console.log(`GroovyLint: Started CodeNarc Server`);
+            console.log(c.green(`GroovyLint: Started CodeNarc Server`));
             return true;
         } else {
             return false;
@@ -312,7 +320,7 @@ class CodeNarcCaller {
         const errMsg = "GroovyLint: Unable to start CodeNarc Server. Use --noserver if you do not even want to try";
         debug(errMsg);
         debug(e.message);
-        console.error(errMsg);
+        console.error(c.grey(errMsg));
     }
 
     // Kill CodeNarc server by telling it to do so

package/lib/config.js

@@ -11,8 +11,8 @@ const defaultConfigLintFileName = ".groovylintrc-recommended.json";
 const allConfigLintFileName = ".groovylintrc-all.json";
 
 const NPM_GROOVY_LINT_CONSTANTS = {
-    CodeNarcVersion: "1.6.1",
-    GroovyVersion: "3.0.5"
+    CodeNarcVersion: "2.2.0",
+    GroovyVersion: "3.0.9"
 };
 
 const configLintFilenames = [