npm-groovy-lint 9.4.0 → 10.0.0

package/lib/example/SampleFileSmall.groovy

@@ -3,14 +3,14 @@ import groovy.json.*
 import groovy.time.TimeCategory
 
 def returnCode = 0
-         Exception eThrow = null ;
-   try {
+Exception eThrow = null ;
+try {
     initialize(args) ;
 } catch (Exception e){
                  eThrow = e ;
     returnCode = 1
              }
-          if (eThrow == null){
+if (eThrow == null){
                       return 0 ;
 }
 else {

package/lib/example/SampleFileSmallFixed.txt

@@ -27,14 +27,14 @@ def initialize(args3) {   //
 
 class TestExecutor {
 
-    public TestExecutor( args2) {
+    public TestExecutor(args2) {
         this.testExternalGlobalProps()
     }
 
     public testExternalGlobalProps() {
-        Utils.printlnLog( '########## testExternalGlobalProps')
+        Utils.printlnLog('########## testExternalGlobalProps')
         def globalKeyName = new SecureRandom().with { (1..9).collect { (('a'..'z')).join()[ nextInt((('a'..'z')).join().length())] }.join() }
-        Utils.printlnLog( "Generated random key: ${globalKeyName}")
+        Utils.printlnLog("Generated random key: ${globalKeyName}")
         Utils.setExternalValue(globalKeyName , 'lelama' , 'nul')
         def storedValue = Utils.getExternalValue(globalKeyName , 'lelama')
         assert storedValue == 'nul' , 'Error in global prop key storage/ retrieval (1)'
@@ -43,7 +43,7 @@ class TestExecutor {
         assert storedValue2 == 'nul2' , 'Error in global prop key storage/ retrieval (2)'
         def storedValueBack = Utils.getExternalValue(globalKeyName , 'lelama')
         assert storedValueBack == 'nul' , 'Error in global prop key storage/ retrieval (3)'
-        Utils.printlnLog( Utils.getExternalValue(globalKeyName))
+        Utils.printlnLog(Utils.getExternalValue(globalKeyName))
     }
 
 }

package/lib/example/SampleFileSmallFormatted.txt

@@ -28,14 +28,14 @@ def initialize(args3) {   //
 
 class TestExecutor {
 
-    public TestExecutor( args2) {
+    public TestExecutor(args2) {
         this.testExternalGlobalProps()
     }
 
     public testExternalGlobalProps() {
-        Utils.printlnLog( '########## testExternalGlobalProps')
+        Utils.printlnLog('########## testExternalGlobalProps')
         def globalKeyName = new Random().with { (1..9).collect { (('a'..'z')).join()[ nextInt((('a'..'z')).join().length())] }.join() }
-        Utils.printlnLog( "Generated random key: ${globalKeyName}")
+        Utils.printlnLog("Generated random key: ${globalKeyName}")
         Utils.setExternalValue(globalKeyName , 'lelama' , 'nul')
         def storedValue = Utils.getExternalValue(globalKeyName , 'lelama')
         assert storedValue == 'nul' , 'Error in global prop key storage/ retrieval (1)'
@@ -44,7 +44,7 @@ class TestExecutor {
         assert storedValue2 == 'nul2' , 'Error in global prop key storage/ retrieval (2)'
         def storedValueBack = Utils.getExternalValue(globalKeyName , 'lelama')
         assert storedValueBack == 'nul' , 'Error in global prop key storage/ retrieval (3)'
-        Utils.printlnLog( Utils.getExternalValue(globalKeyName))
+        Utils.printlnLog(Utils.getExternalValue(globalKeyName))
     }
 
 }

package/lib/groovy-lint-rules.js

@@ -105,6 +105,7 @@ const rulesFixPriorityOrder = [
     "SpaceBeforeOpeningBrace",
     "SpaceAfterOpeningBrace",
     "SpaceAfterCatch",
+    "SpaceAfterMethodCallName",
     "SpaceAfterSwitch",
     "SpaceAfterWhile",
     "SpaceAroundOperator",
@@ -114,6 +115,7 @@ const rulesFixPriorityOrder = [
     "SpaceAfterIf",
     "SpaceAfterSwitch",
     "SpaceBeforeClosingBrace",
+    "SpaceInsideParentheses",
     "UnnecessaryDefInFieldDeclaration",
     "UnnecessaryDefInMethodDeclaration",
     "UnnecessaryDefInVariableDeclaration",

package/lib/groovy-lint.js

@@ -10,7 +10,7 @@ const { NPM_GROOVY_LINT_CONSTANTS, loadConfig, getConfigFileName } = require("./
 const optionsDefinition = require("./options");
 const { computeStats, processOutput } = require("./output.js");
 const { recordAnonymousEvent } = require("./analytics.js");
-const { getSourceLines, isErrorInLogLevelScope } = require("./utils");
+const { getNpmGroovyLintVersion, getSourceLines, isErrorInLogLevelScope } = require("./utils");
 
 class NpmGroovyLint {
     "use strict";
@@ -33,6 +33,7 @@ class NpmGroovyLint {
     codeNarcStdErr;
     codeNarcJsonResult;
     fileList;
+    inputFileList;
     parseErrors = [];
 
     // npm-groovy-lint
@@ -161,7 +162,7 @@ class NpmGroovyLint {
         }
 
         // Manage anonymous stats
-        if (["initialCall", "index"].includes(this.origin) && this.options.insight !== false) {
+        if (["initialCall", "index"].includes(this.origin) && this.options.insight === true) {
             this.startElapse = performance.now();
         }
 
@@ -179,16 +180,7 @@ class NpmGroovyLint {
 
         // Show version
         if (this.options.version) {
-            let v = process.env.npm_package_version;
-            if (!v) {
-                try {
-                    const FindPackageJson = require("find-package-json");
-                    const finder = FindPackageJson(__dirname);
-                    v = finder.next().value.version;
-                } catch {
-                    v = "error";
-                }
-            }
+            const v = getNpmGroovyLintVersion();
 
             const codeNarcVersionLinter = await new NpmGroovyLint([process.execPath, "", "--codenarcargs", "-version"], {}).run();
             const codeNarcVersionLines = [(await getSourceLines(codeNarcVersionLinter.codeNarcStdOut))[0]];
@@ -238,7 +230,8 @@ class NpmGroovyLint {
             codeNarcBaseDir: this.codeNarcBaseDir,
             codeNarcIncludes: this.codeNarcIncludes,
             codeNarcExcludes: this.codeNarcExcludes,
-            onlyCodeNarc: this.onlyCodeNarc
+            onlyCodeNarc: this.onlyCodeNarc,
+            inputFileList: this.inputFileList
         });
         if (!this.options.noserver) {
             serverCallResult = await codeNarcCaller.callCodeNarcServer();
@@ -304,7 +297,7 @@ class NpmGroovyLint {
         }
 
         // Manage anonymous usage stats (except if current lint has been cancelled by a duplicate call)
-        if (this.startElapse && this.options.insight !== false && this.status !== 9) {
+        if (this.startElapse && this.options.insight === true && this.status !== 9) {
             const elapsedTimeMs = parseInt(performance.now() - this.startElapse);
             const callerKey = this.origin === "index" ? "cli" : "module";
             const actionKey = this.options.format ? "format" : this.options.fix ? "fix" : "lint";

package/lib/options.js

@@ -24,19 +24,9 @@ module.exports = optionator({
     },
     options: [
         {
-            option: "path",
-            alias: "p",
-            type: "path::String",
-            default: ".",
-            description: "Directory containing the files to lint (default: current directory)",
-            example: ["./path/to/my/groovy/files"]
-        },
-        {
-            option: "files",
-            alias: "f",
-            type: "String",
-            description: "Comma-separated list of Ant-style file patterns specifying files that must be included",
-            example: ["**/Jenkinsfile", "**/*.groovy", "**/*.gradle"]
+            option: "ext",
+            type: "[String]",
+            description: "Specify Groovy file extensions"
         },
         {
             option: "source",
@@ -120,7 +110,16 @@ module.exports = optionator({
             type: "String",
             default: "txt",
             description: "Output format (txt,json,sarif,html,xml), or path to a file with one of these extensions",
-            example: ["txt", "json", "sarif", "./logs/myLintResults.txt", "./logs/myLintResults.json","./logs/myLintResults.sarif", "./logs/myLintResults.html", "./logs/myLintResults.xml"]
+            example: [
+                "txt",
+                "json",
+                "sarif",
+                "./logs/myLintResults.txt",
+                "./logs/myLintResults.json",
+                "./logs/myLintResults.sarif",
+                "./logs/myLintResults.html",
+                "./logs/myLintResults.xml"
+            ]
         },
         {
             option: "loglevel",
@@ -221,8 +220,9 @@ module.exports = optionator({
         {
             option: "insight",
             type: "Boolean",
+            default: false,
             description:
-                "npm-groovy-lint collects anonymous usage statistics using package https://www.npmjs.com/package/insight. If you do not want to share them, use --no-insight option"
+                "npm-groovy-lint collects anonymous usage statistics using package https://www.npmjs.com/package/insight. If you want to enable them, use --insight option"
         },
         {
             option: "help",
@@ -235,6 +235,21 @@ module.exports = optionator({
             alias: "v",
             type: "Boolean",
             description: "Show version"
+        },
+        {
+            option: "path",
+            alias: "p",
+            type: "path::String",
+            default: ".",
+            description: "(DEPRECATED) Directory containing the files to lint (default: current directory)",
+            example: ["./path/to/my/groovy/files"]
+        },
+        {
+            option: "files",
+            alias: "f",
+            type: "String",
+            description: "(DEPRECATED) Comma-separated list of Ant-style file patterns specifying files that must be included",
+            example: ["**/Jenkinsfile", "**/*.groovy", "**/*.gradle"]
         }
     ],
     mutuallyExclusive: [

package/lib/output.js

@@ -3,7 +3,7 @@ const c = require("ansi-colors");
 const fse = require("fs-extra");
 const { SarifBuilder, SarifRunBuilder, SarifResultBuilder, SarifRuleBuilder } = require("node-sarif-builder");
 const path = require("path");
-const { isErrorInLogLevelScope } = require("./utils");
+const { isErrorInLogLevelScope, getNpmGroovyLintVersion } = require("./utils");
 
 // Compute statistics for output
 function computeStats(lintResult) {
@@ -227,7 +227,8 @@ function buildSarifResult(lintResult) {
     const sarifBuilder = new SarifBuilder();
     // SARIF Run builder
     const sarifRunBuilder = new SarifRunBuilder().initSimple({
-        name: "npm-groovy-lint",
+        toolDriverName: "npm-groovy-lint",
+        toolDriverVersion: getNpmGroovyLintVersion(),
         url: "https://nvuillam.github.io/npm-groovy-lint/"
     });
     // SARIF rules
@@ -249,11 +250,9 @@ function buildSarifResult(lintResult) {
                 level: err.severity === "info" ? "note" : err.severity, // Other values can be "warning" or "error"
                 messageText: err.msg,
                 ruleId: err.rule,
-                fileUri: process.env.SARIF_URI_ABSOLUTE
-                    ? "file:///" + fileNm.replace(/\\/g, "/")
-                    : path.relative(process.cwd(), fileNm)
+                fileUri: process.env.SARIF_URI_ABSOLUTE ? "file:///" + fileNm.replace(/\\/g, "/") : path.relative(process.cwd(), fileNm)
             };
-            if (err.range) {
+            if (err && err.range && err.range.start && (err.range.start.line === 0 || err.range.start.line > 0)) {
                 sarifResultInit.startLine = fixLine(err.range.start.line);
                 sarifResultInit.startColumn = fixCol(err.range.start.character);
                 sarifResultInit.endLine = fixLine(err.range.end.line);

package/lib/rules/DuplicateNumberLiteral.js

@@ -0,0 +1,21 @@
+// Duplicate number literal
+
+const { getVariableRange } = require("../utils");
+
+const rule = {
+    variables: [
+        {
+            name: "NUMBER_LITERAL",
+            regex: /Duplicate Number Literal: (.*)/,
+            regexPos: 1
+        }
+    ],
+    range: {
+        type: "function",
+        func: (errLine, errItem, evaluatedVars) => {
+            return getVariableRange(errLine, evaluatedVars, "NUMBER_LITERAL", errItem);
+        }
+    }
+};
+
+module.exports = { rule };

package/lib/rules/DuplicateStringLiteral.js

@@ -0,0 +1,21 @@
+// Duplicate string literal
+
+const { getVariableRange } = require("../utils");
+
+const rule = {
+    variables: [
+        {
+            name: "STRING_LITERAL",
+            regex: /Duplicate String Literal: (.*)/,
+            regexPos: 1
+        }
+    ],
+    range: {
+        type: "function",
+        func: (errLine, errItem, evaluatedVars) => {
+            return getVariableRange(errLine, evaluatedVars, "STRING_LITERAL", errItem);
+        }
+    }
+};
+
+module.exports = { rule };

package/lib/rules/MethodParameterTypeRequired.js

@@ -0,0 +1,21 @@
+// Too many methods in a class
+
+const { getVariableRange } = require("../utils");
+
+const rule = {
+    variables: [
+        {
+            name: "METHODNAME",
+            regex: /"(.*)" parameter of "(.*)" method is dynamically typed/,
+            regexPos: 1
+        }
+    ],
+    range: {
+        type: "function",
+        func: (errLine, errItem, evaluatedVars) => {
+            return getVariableRange(errLine, evaluatedVars, "METHODNAME", errItem);
+        }
+    }
+};
+
+module.exports = { rule };

package/lib/rules/MethodReturnTypeRequired.js

@@ -0,0 +1,21 @@
+// Too many methods in a class
+
+const { getVariableRange } = require("../utils");
+
+const rule = {
+    variables: [
+        {
+            name: "METHODNAME",
+            regex: /Method "(.*)" has a dynamic return type/,
+            regexPos: 1
+        }
+    ],
+    range: {
+        type: "function",
+        func: (errLine, errItem, evaluatedVars) => {
+            return getVariableRange(errLine, evaluatedVars, "METHODNAME", errItem);
+        }
+    }
+};
+
+module.exports = { rule };

package/lib/rules/MisorderedStaticImports.js

@@ -177,7 +177,7 @@ import after.all.does.it.work
 
 // The rest of the file below ...
 `
-        },
+        } /*,
         {
             sourceBefore: `
 // Blablabla grapes
@@ -230,7 +230,7 @@ import after.all.does.it.work
 
 // The rest of the file below ...
 `
-        }
+        } */
     ]
 };
 

package/lib/rules/NoDef.js

@@ -0,0 +1,14 @@
+// No use of def
+
+const { getStringRange } = require("../utils");
+
+const rule = {
+    range: {
+        type: "function",
+        func: (errLine, errItem) => {
+            return getStringRange(errLine, "def", errItem);
+        }
+    }
+};
+
+module.exports = { rule };

package/lib/rules/SimpleDateFormatMissingLocale.js

@@ -0,0 +1,14 @@
+// Simple Date Format missing locale
+
+const { getStringRange } = require("../utils");
+
+const rule = {
+    range: {
+        type: "function",
+        func: (errLine, errItem) => {
+            return getStringRange(errLine, "new SimpleDateFormat", errItem);
+        }
+    }
+};
+
+module.exports = { rule };

package/lib/rules/SpaceAfterMethodCallName.js

@@ -0,0 +1,30 @@
+// Space after method call name
+
+const { getStringRange } = require("../utils");
+
+const rule = {
+    range: {
+        type: "function",
+        func: (errLine, errItem) => {
+            return getStringRange(errLine, " (", errItem);
+        }
+    },
+    fix: {
+        label: "Remove space after method call name",
+        type: "replaceString",
+        before: " (",
+        after: "("
+    },
+    tests: [
+        {
+            sourceBefore: `
+Utils.printlnLog ('-----')
+`,
+            sourceAfter: `
+Utils.printlnLog('-----')
+`
+        }
+    ]
+};
+
+module.exports = { rule };

package/lib/rules/SpaceInsideParentheses.js

@@ -0,0 +1,73 @@
+// No space between parenthesis
+
+const { getStringRange } = require("../utils");
+
+const rule = {
+    fix: {
+        label: "Remove spaces inside parenthesis",
+        type: "function",
+        func: line => {
+            line = line.replace(/\( +/g, "(");
+            line = line.replace(/ +\)/g, ")");
+            return line;
+        }
+    },
+    tests: [
+        {
+            sourceBefore: `
+Utils.printlnLog( Utils.getExternalValue(globalKeyName))
+Utils.printlnLog(Utils.getExternalValue(globalKeyName) )
+Utils.printlnLog(Utils.getExternalValue(  globalKeyName) )
+`,
+            sourceAfter: `
+Utils.printlnLog(Utils.getExternalValue(globalKeyName))
+Utils.printlnLog(Utils.getExternalValue(globalKeyName))
+Utils.printlnLog(Utils.getExternalValue(globalKeyName))
+`
+        }
+    ],
+    range: {
+        type: "function",
+        func: (errLine, errItem) => {
+            let parenthesisRange = getStringRange(errLine, "( ", errItem);
+            if (parenthesisRange.start.character < 0) {
+                parenthesisRange = getStringRange(errLine, " )", errItem);
+            }
+            return parenthesisRange;
+        }
+    },
+    rangeTests: [
+        {
+            source: `
+def res = uuuurf( "yessss")
+`,
+            expectedRange: {
+                start: {
+                    line: 2,
+                    character: 16
+                },
+                end: {
+                    line: 2,
+                    character: 18
+                }
+            }
+        },
+        {
+            source: `
+def res = uuuurf("yessss" )
+`,
+            expectedRange: {
+                start: {
+                    line: 2,
+                    character: 25
+                },
+                end: {
+                    line: 2,
+                    character: 27
+                }
+            }
+        }
+    ]
+};
+
+module.exports = { rule };

package/lib/rules/UnnecessaryPublicModifier.js

@@ -0,0 +1,13 @@
+// Variable type required
+const { getStringRange } = require("../utils");
+
+const rule = {
+    range: {
+        type: "function",
+        func: (errLine, errItem) => {
+            return getStringRange(errLine, "public", errItem);
+        }
+    }
+};
+
+module.exports = { rule };

package/lib/rules/UnusedImport.js

@@ -1,6 +1,6 @@
 // Unused import
 
-const { getVariable } = require("../utils");
+const { getVariable, getVariableRange } = require("../utils");
 
 const rule = {
     scope: "file",
@@ -12,6 +12,12 @@ const rule = {
             regexPos: 1
         }
     ],
+    range: {
+        type: "function",
+        func: (errLine, errItem, evaluatedVars) => {
+            return getVariableRange(errLine, evaluatedVars, "CLASSNAME", errItem);
+        }
+    },
     fix: {
         label: "Remove unused import",
         type: "function",

package/lib/rules/VariableTypeRequired.js

@@ -0,0 +1,36 @@
+// Variable type required
+const { getVariableRange } = require("../utils");
+
+const rule = {
+    variables: [
+        {
+            name: "VARIABLE_NAME",
+            regex: /The type is not specified for variable "(.*)"/
+        }
+    ],
+    range: {
+        type: "function",
+        func: (errLine, errItem, evaluatedVars) => {
+            return getVariableRange(errLine, evaluatedVars, "VARIABLE_NAME", errItem);
+        }
+    },
+    rangeTests: [
+        {
+            source: `
+def returnCode = 0
+`,
+            expectedRange: {
+                start: {
+                    line: 2,
+                    character: 4
+                },
+                end: {
+                    line: 2,
+                    character: 14
+                }
+            }
+        }
+    ]
+};
+
+module.exports = { rule };

package/lib/utils.js

@@ -394,6 +394,20 @@ function splitMulti(str, tokens) {
     return str;
 }
 
+function getNpmGroovyLintVersion() {
+    let v = process.env.npm_package_version;
+    if (!v) {
+        try {
+            const FindPackageJson = require("find-package-json");
+            const finder = FindPackageJson(__dirname);
+            v = finder.next().value.version;
+        } catch {
+            v = "error";
+        }
+    }
+    return v;
+}
+
 module.exports = {
     addImport,
     addSpaceAfterChar,
@@ -405,6 +419,7 @@ module.exports = {
     findRangeBetweenStrings,
     getIndentLength,
     getLastStringRange,
+    getNpmGroovyLintVersion,
     getOutOfBracesStrings,
     getSourceLines,
     getStringRange,

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "npm-groovy-lint",
-  "version": "9.4.0",
+  "version": "10.0.0",
   "description": "Lint, format and auto-fix your Groovy / Jenkinsfile / Gradle files",
   "main": "index.js",
   "scripts": {
-    "lint:fix": "eslint **/*.js --fix && prettier --write \"./lib/**/*.{js,jsx,json}\" --tab-width 4 --print-width 150",
-    "groovy:run-server-from-source": "npm run dev:kill-server && groovy -cp \"lib/java/CodeNarc-2.2.0.jar;lib/java/groovy/lib/groovy-3.0.9.jar;lib/java/groovy/lib/groovy-templates-3.0.9.jar;lib/java/groovy/lib/groovy-xml-3.0.9.jar;lib/java/groovy/lib/groovy-json-3.0.9.jar;lib/java/groovy/lib/groovy-ant-3.0.9.jar;lib/java/groovy/lib/ant-1.10.11.jar;lib/java/groovy/lib/ant-launcher-1.10.11.jar;lib/java/slf4j-api-1.7.9.jar;lib/java/log4j-slf4j-impl-2.17.1.jar;lib/java/log4j-api-2.17.1.jar;lib/java/log4j-core-2.17.1.jar;lib/java/gmetrics-1.1.jar\" groovy/src/main/com/nvuillam/CodeNarcServer.groovy --server",
+    "lint:fix": "eslint **/*.js --fix && prettier --write \"./lib/**/*.{js,jsx}\" --tab-width 4 --print-width 150",
+    "groovy:run-server-from-source": "npm run dev:kill-server && groovy -cp \"lib/java/CodeNarc-3.1.0.jar;lib/java/groovy/lib/groovy-3.0.9.jar;lib/java/groovy/lib/groovy-templates-3.0.9.jar;lib/java/groovy/lib/groovy-xml-3.0.9.jar;lib/java/groovy/lib/groovy-json-3.0.9.jar;lib/java/groovy/lib/groovy-ant-3.0.9.jar;lib/java/groovy/lib/ant-1.10.11.jar;lib/java/groovy/lib/ant-launcher-1.10.11.jar;lib/java/slf4j-api-1.7.9.jar;lib/java/log4j-slf4j-impl-2.18.0.jar;lib/java/log4j-api-2.18.0.jar;lib/java/log4j-core-2.18.0.jar;lib/java/GMetrics-2.1.0.jar\" groovy/src/main/com/nvuillam/CodeNarcServer.groovy --server",
     "groovy:build": "npm run dev:kill-server && groovyc -cp \"./lib/java*\" --encoding utf-8 ./groovy/src/main/com/nvuillam/CodeNarcServer.groovy -d ./tmp && cd ./tmp && jar -cvfm ./../lib/java/CodeNarcServer.jar ./../MANIFEST.txt ./com/nvuillam/*.class && cd ..",
     "test": "npm run dev:kill-server && mocha \"test/**/*.test.js\"",
     "test:coverage": "nyc npm run test",
@@ -58,7 +58,8 @@
     "import-fresh": "^3.2.1",
     "ip": "^1.1.5",
     "java-caller": "^2.2.4",
-    "node-sarif-builder": "^1.0.0",
+    "js-yaml": "^4.1.0",
+    "node-sarif-builder": "^2.0.1",
     "optionator": "^0.8.3",
     "semver": "^7.1.3",
     "strip-json-comments": "^3.0.1",
@@ -69,11 +70,6 @@
     "@babel/eslint-parser": "^7.16.3",
     "diff": "^4.0.2",
     "eslint": "^8.2.0",
-    "eslint-config-standard": "^16.0.3",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^5.1.1",
-    "eslint-plugin-standard": "^5.0.0",
     "mocha": "^7.0.1",
     "nyc": "^15.1.0",
     "prettier": "^1.19.1",