npm-groovy-lint 9.5.0 → 10.0.2

package/CHANGELOG.md

@@ -2,13 +2,51 @@
 
 ## UNRELEASED
 
-- Add your updates here :)
+## [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
+  - Upgrade to [CodeNarc v3.1.0](https://github.com/CodeNarc/CodeNarc/blob/master/CHANGELOG.md#version-310----jun-2022)
+  - Accept list of directories / files as arguments (`--path` and `--files` become deprecated but are still usable)
+    - Examples
+      - Multiple files: `npm-groovy-lint path/to/file1.groovy path/to/file2.groovy`
+      - Directory: `npm groovy-lint path/to`
+      - Single file: `npm-groovy-lint Jenkinsfile`
+      - Ant pattern(s): `npm-groovy-lint path/to/**/*.groovy`
+  - Upgrade npm dependencies
+  - CI: Upgrade [MegaLinter](https://oxsecurity.github.io/megalinter/latest/) to v6
+  - Test classes for collecting error ranges
+
+- New error ranges rules
+  - DuplicateNumberLiteral
+  - DuplicateStringLiteral
+  - MethodParameterTypeRequired
+  - NoDef
+  - SimpleDateFormatMissingLocale
+  - SpaceInsideParenthesis
+  - UnnecessaryPublicModifier
+  - VariableTypeRequired
+
+- New fix rules
+  - SpaceAfterMethodCallName
+  - SpaceInsideParentheses
+
+- Bug Fixes
+  - Wrongly calculated ranges are no more returned
 
 ## [9.5.0] 2022-04-12
 
 - Disable Amplitude anonymous stats by default (use `--insight` to enable them)
 
-## [9.4.1] 2022-01-22
+## [9.4.1] 2022-01-12
 
 - Upgrade node-sarif-builder to 2.0.1 and send npm-groovy-lint version in SARIF logs
 - New range detection for rules:

package/README.md

@@ -40,13 +40,13 @@ Any **question**, **problem** or **enhancement request** ? Ask [**here**](https:
 ## Usage
 
 ```shell
-    npm-groovy-lint OPTIONS
+    npm-groovy-lint [OPTIONS] [FILES|PATH|PATTERN]
 ```
 
+See [examples](#example-calls)
+
 | Parameter               | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 |-------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| -p<br/> --path          | String  | Directory containing the files to lint<br/> Example: `./path/to/my/groovy/files`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
-| -f<br/> --files         | String  | 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"`                                                                                                                                                                                                                                                                                                      |
 | -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"`                                                                                                                                                                                                                                                                  |
 | -l<br/> --loglevel      | String  | Log level (error,warning or info)<br/>Default: info                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 | --failon                | String  | Defines the error level where CLI will fail (return code = 1). error,warning,info or none. Each failure level includes the more critical ones.                                                                                                                                                                                                                                                                                                                                                                                                                                |
@@ -69,6 +69,8 @@ Any **question**, **problem** or **enhancement request** ? Ask [**here**](https:
 | --codenarcargs          | String  | Use core CodeNarc arguments (all npm-groovy-lint arguments will be ignored)<br/> Doc: <http://codenarc.github.io/CodeNarc/codenarc-command-line.html><br/> Example: `npm-groovy-lint --codenarcargs -basedir="lib/example" -rulesetfiles="file:lib/example/RuleSet-Groovy.groovy" -maxPriority1Violations=0 -report="xml:ReportTestCodenarc.xml`                                                                                                                                                                                                                              |
 | -h<br/> --help          | Boolean | Show help (npm-groovy-lint -h OPTIONNAME to see option detail with examples)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
 | -v<br/> --version       | Boolean | Show npm-groovy-lint version (with CodeNarc version)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+| -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"`                                                                                                                                                                                                                                                                                         |
 
 ## Installation
 
@@ -145,6 +147,30 @@ 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

package/lib/.groovylintrc-all.json

@@ -380,7 +380,6 @@
     "unnecessary.UnnecessarySemicolon": {},
     "unnecessary.UnnecessarySetter": {},
     "unnecessary.UnnecessaryStringInstantiation": {},
-    "unnecessary.UnnecessarySubstring": {},
     "unnecessary.UnnecessaryTernaryExpression": {},
     "unnecessary.UnnecessaryToString": {},
     "unnecessary.UnnecessaryTransientModifier": {},

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

@@ -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");
@@ -18,6 +19,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 +28,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) {
@@ -52,16 +56,16 @@ 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
     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 +76,77 @@ 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;
+                }
+                // 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, "/");
+                }
+                // 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
+                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())) {
@@ -130,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) {
@@ -253,7 +321,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 +415,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 +457,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 +504,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 };