npm-groovy-lint 14.6.0 → 14.6.1-beta202408252305.0

package/lib/filter.js

@@ -1,5 +1,4 @@
 // Filter errors
-"use strict";
 
 // Parse source to list parts where errors must be ignored
 function collectDisabledBlocks(allLines) {
@@ -15,10 +14,10 @@ function collectDisabledBlocks(allLines) {
         else if (line.includes("groovylint-enable")) {
             const enabledRules = parseGroovyLintComment("groovylint-enable", line);
             const matchingIndex = disabledBlocks.findIndex(
-                disabledBlock =>
+                (disabledBlock) =>
                     disabledBlock.endLine == null &&
                     lineNb >= disabledBlock.startLine &&
-                    disabledBlock.rules.sort().toString() == enabledRules.sort().toString()
+                    disabledBlock.rules.sort().toString() == enabledRules.sort().toString(),
             );
             if (matchingIndex > -1) {
                 disabledBlocks[matchingIndex].endLine = lineNb;
@@ -29,7 +28,7 @@ function collectDisabledBlocks(allLines) {
         lineNb++;
     }
     // Set last line pos as endLine for the groovylint-disable not matched with a groovylint-enable
-    return disabledBlocks.map(disabledBlock => {
+    return disabledBlocks.map((disabledBlock) => {
         if (disabledBlock.endLine == null) {
             disabledBlock.endLine = allLines.length;
         }
@@ -44,7 +43,7 @@ function isFilteredError(errItem, allLines, disabledBlocks) {
 
     // matches groovylint-disable blocks
     const matchingDisabledBlocks = disabledBlocks.filter(
-        disabledBlock => disabledBlock.startLine <= linePos && disabledBlock.endLine >= linePos && checkMatch(disabledBlock.rules, ruleName)
+        (disabledBlock) => disabledBlock.startLine <= linePos && disabledBlock.endLine >= linePos && checkMatch(disabledBlock.rules, ruleName),
     );
     if (matchingDisabledBlocks.length > 0) {
         return true;
@@ -68,11 +67,9 @@ function isFilteredError(errItem, allLines, disabledBlocks) {
 // ex: "// groovylint-disable" will return "all"
 function parseGroovyLintComment(type, line) {
     if (line.includes(type)) {
-        const typeDetail = cleanFromCommentMarks(line)
-            .replace(type, "")
-            .trim();
+        const typeDetail = cleanFromCommentMarks(line).replace(type, "").trim();
         if (typeDetail) {
-            const errors = typeDetail.split(",").map(errType => errType.trim());
+            const errors = typeDetail.split(",").map((errType) => errType.trim());
             return errors;
         }
         return ["all"];
@@ -90,11 +87,7 @@ function cleanFromCommentMarks(str) {
     if (str.indexOf("//")) {
         str = str.substring(str.indexOf("//"));
     }
-    return str
-        .replace("/*", "")
-        .replace("//", "")
-        .replace("*/", "")
-        .trim();
+    return str.replace("/*", "").replace("//", "").replace("*/", "").trim();
 }
 
-module.exports = { collectDisabledBlocks, isFilteredError };
+export { collectDisabledBlocks, isFilteredError };

package/lib/groovy-lint-fix.js

@@ -1,15 +1,14 @@
 // Imports
-const fse = require("fs-extra");
-const cliProgress = require("cli-progress");
-const debug = require("debug")("npm-groovy-lint");
-const trace = require("debug")("npm-groovy-lint-trace");
-const os = require("os");
-const { getNpmGroovyLintRules, getFormattingRulesToAlwaysRun } = require("./groovy-lint-rules.js");
-const { evaluateVariables, getSourceLines } = require("./utils.js");
-
-class NpmGroovyLintFix {
-    "use strict";
+import fs from "fs-extra";
+import * as cliProgress from "cli-progress";
+import Debug from "debug";
+const debug = Debug("npm-groovy-lint");
+const trace = Debug("npm-groovy-lint-trace");
+import * as os from "os";
+import { getNpmGroovyLintRules, getFormattingRulesToAlwaysRun } from "./groovy-lint-rules.js";
+import { evaluateVariables, getSourceLines } from "./utils.js";
 
+export class NpmGroovyLintFix {
     options = {};
 
     updatedLintResult;
@@ -30,7 +29,6 @@ class NpmGroovyLintFix {
         this.options = optionsIn;
         this.verbose = optionsIn.verbose || false;
         // Load available fix rules
-        this.npmGroovyLintRules = this.options.groovyLintRulesOverride ? require(this.options.groovyLintRulesOverride) : getNpmGroovyLintRules();
         if (this.options.fixrules && this.options.fixrules !== "all") {
             this.fixRules = this.options.fixrules.split(",");
         }
@@ -41,13 +39,15 @@ class NpmGroovyLintFix {
     // Fix errors using codenarc result and groovy lint rules
     async run(optns = { errorIds: null, propagate: false }) {
         debug(`<<<<<< NpmGroovyLintFix.run START >>>>>>`);
+        const npmGroovyLintRules = await getNpmGroovyLintRules();
+        this.npmGroovyLintRules = this.options.groovyLintRulesOverride ? await import(this.options.groovyLintRulesOverride) : npmGroovyLintRules;
         // Start progress bar
         this.bar = new cliProgress.SingleBar(
             {
                 format: "GroovyLint [{bar}] Fixing {file}",
-                clearOnComplete: true
+                clearOnComplete: true,
             },
-            cliProgress.Presets.shades_classic
+            cliProgress.Presets.shades_classic,
         );
         this.bar.start(Object.keys(this.updatedLintResult.files).length, 0, { file: "..." });
 
@@ -88,8 +88,8 @@ class NpmGroovyLintFix {
                             this.npmGroovyLintRules[err.rule],
                             this.options.rules && this.options.rules[err.rule] && typeof this.options.rules[err.rule] === "object"
                                 ? { config: this.options.rules[err.rule] }
-                                : { config: {} }
-                        )
+                                : { config: {} },
+                        ),
                     };
                     this.addFixableError(fileNm, fixableError);
                     // Trigger other fixes if defined in the rule
@@ -107,8 +107,8 @@ class NpmGroovyLintFix {
                                         this.options.rules[triggeredRuleName] &&
                                         typeof this.options.rules[triggeredRuleName] === "object"
                                         ? { config: this.options.rules[triggeredRuleName] }
-                                        : { config: {} }
-                                )
+                                        : { config: {} },
+                                ),
                             };
                             this.addFixableError(fileNm, fixableErrorTriggered);
                         }
@@ -125,7 +125,7 @@ class NpmGroovyLintFix {
                         ruleName: formattingRuleName,
                         lineNb: 0,
                         msg: `${formattingRuleName} triggered by format request`,
-                        rule: rule
+                        rule: rule,
                     };
                     this.addFixableError(fileNm, fixableErrorTriggered);
                 }
@@ -144,7 +144,7 @@ class NpmGroovyLintFix {
         if (
             fixableError.rule.scope === "file" &&
             !fixableError.rule.unitary === true &&
-            this.fixableErrors[fileNm].filter(matchFixableError => matchFixableError.ruleName === fixableError.ruleName).length > 0
+            this.fixableErrors[fileNm].filter((matchFixableError) => matchFixableError.ruleName === fixableError.ruleName).length > 0
         ) {
             return;
         }
@@ -164,7 +164,7 @@ class NpmGroovyLintFix {
     async fixErrors() {
         // Process files in parallel
         await Promise.all(
-            Object.keys(this.fixableErrors).map(async fileNm => {
+            Object.keys(this.fixableErrors).map(async (fileNm) => {
                 // Read file
                 let allLines = await getSourceLines(this.options.source, fileNm);
 
@@ -207,9 +207,9 @@ class NpmGroovyLintFix {
                         fileFixableError.id,
                         {
                             fixed: fixSuccess === true,
-                            triggersAgainAfterFix: fileFixableError.rule.triggersAgainAfterFix
+                            triggersAgainAfterFix: fileFixableError.rule.triggersAgainAfterFix,
                         },
-                        fileFixableError.rule.fixesSameErrorOnSameLine
+                        fileFixableError.rule.fixesSameErrorOnSameLine,
                     );
                     fixedInFileNb = fixedInFileNb + fixedNb;
                 }
@@ -217,9 +217,9 @@ class NpmGroovyLintFix {
                 this.updatedLintResult.files[fileNm].updatedSource = newSources;
                 // Write new file content if it has been updated
                 if (this.options.save && fixedInFileNb > 0) {
-                    fse.writeFileSync(fileNm, newSources);
+                    fs.writeFileSync(fileNm, newSources);
                 }
-            })
+            }),
         );
     }
 
@@ -235,9 +235,9 @@ class NpmGroovyLintFix {
                 fixableError.id,
                 {
                     fixed: false,
-                    triggersAgainAfterFix: fixableError.rule.triggersAgainAfterFix
+                    triggersAgainAfterFix: fixableError.rule.triggersAgainAfterFix,
                 },
-                fixableError.rule.fixesSameErrorOnSameLine
+                fixableError.rule.fixesSameErrorOnSameLine,
             );
             return lineOrAllLines;
         }
@@ -296,7 +296,7 @@ class NpmGroovyLintFix {
 
     // Update lint result of an identified error
     updateLintResult(fileNm, errId, errDataToSet, fixesSameErrorOnSameLine = false) {
-        const errIndex = this.updatedLintResult.files[fileNm].errors.findIndex(error => error.id === errId);
+        const errIndex = this.updatedLintResult.files[fileNm].errors.findIndex((error) => error.id === errId);
         // Update error in lint result {mostly fixed: true}
         // It not in list of errors, it means it's from a triggered error
         let error = {};
@@ -305,7 +305,7 @@ class NpmGroovyLintFix {
             Object.assign(error, errDataToSet);
             // If same error has been fixed on the same line, mark failed fix and success as it has been corrected by a previous fix
             if (fixesSameErrorOnSameLine && errDataToSet.fixed === false) {
-                const sameLineSameRuleFixedErrors = this.updatedLintResult.files[fileNm].errors.filter(err => {
+                const sameLineSameRuleFixedErrors = this.updatedLintResult.files[fileNm].errors.filter((err) => {
                     return err.line === error.line && err.rule === error.rule && err.fixed === true && err.id !== error.id;
                 });
                 if (sameLineSameRuleFixedErrors.length > 0) {
@@ -330,7 +330,7 @@ class NpmGroovyLintFix {
         if (lengthDiff === 0) {
             return;
         }
-        this.fixableErrors[fileNm] = this.fixableErrors[fileNm].map(fixableError => {
+        this.fixableErrors[fileNm] = this.fixableErrors[fileNm].map((fixableError) => {
             // Only update line number & range for next lines
             if (fixableError.lineNb > lineNb) {
                 fixableError.lineNb = fixableError.lineNb + lengthDiff;
@@ -338,12 +338,12 @@ class NpmGroovyLintFix {
                     fixableError.range = {
                         start: {
                             line: fixableError.range.start.line + lengthDiff,
-                            character: fixableError.range.start.character
+                            character: fixableError.range.start.character,
                         },
                         end: {
                             line: fixableError.range.end.line + lengthDiff,
-                            character: fixableError.range.end.character
-                        }
+                            character: fixableError.range.end.character,
+                        },
                     };
                 }
             }
@@ -351,5 +351,3 @@ class NpmGroovyLintFix {
         });
     }
 }
-
-module.exports = NpmGroovyLintFix;

package/lib/groovy-lint-rules.js

@@ -83,13 +83,14 @@ str = "lelamanul"
         ]
     }
 
-    module.exports = { rule }
+    export default  { rule }
 
 */
 
-"use strict";
-
-const fse = require("fs-extra");
+import fs from "fs-extra";
+const { readdirSync } = fs;
+import * as path from "path";
+import { fileURLToPath } from "url";
 
 // If you add a new global rule with a fix function, it's very important to think about their order.
 // Rules modifying the number of lines must arrive last !
@@ -151,25 +152,26 @@ const rulesFixPriorityOrder = [
     "IndentationClosingBraces",
     "IndentationComments",
     "ConsecutiveBlankLines",
-    "FileEndsWithoutNewline"
+    "FileEndsWithoutNewline",
 ];
 
 // CodeNarc formatting fix rules are triggered after CodeNarc returns violations
 // Non-CodeNarc formatting fix rules (existing only in npm-groovy-lint) must be run always
 const formatRulesToAlwaysRun = ["IndentationClosingBraces", "IndentationComments"];
 
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const RULES_FOLDER = __dirname + "/rules";
 
-function getNpmGroovyLintRules(optns = { loadTests: false }) {
-    const ruleFiles = fse.readdirSync(RULES_FOLDER);
+export async function getNpmGroovyLintRules(optns = { loadTests: false }) {
+    const ruleFiles = readdirSync(RULES_FOLDER);
     const npmGroovyLintRules = {};
     for (const file of ruleFiles) {
         const ruleName = file.replace(".js", "");
         // Remove require cache if tests must be returned (other calls delete them in the cache)
         if (optns && optns.loadTests === true) {
-            delete require.cache[require.resolve(`${RULES_FOLDER}/${file}`)];
+            // delete require.cache[require.resolve(`${RULES_FOLDER}/${file}`)]; Not ESM compliant
         }
-        const { rule } = require(`${RULES_FOLDER}/${file}`);
+        const { rule } = await import("./rules/" + file);
         if (rule.disabled) {
             continue;
         }
@@ -187,8 +189,6 @@ function getNpmGroovyLintRules(optns = { loadTests: false }) {
     return npmGroovyLintRules;
 }
 
-function getFormattingRulesToAlwaysRun() {
+export function getFormattingRulesToAlwaysRun() {
     return formatRulesToAlwaysRun;
 }
-
-module.exports = { getNpmGroovyLintRules, getFormattingRulesToAlwaysRun };

package/lib/groovy-lint.js

@@ -1,22 +1,21 @@
 // Imports
-const debug = require("debug")("npm-groovy-lint");
-const trace = require("debug")("npm-groovy-lint-trace");
-const fs = require("fs-extra");
-const os = require("os");
-const path = require("path");
-const performance = require("perf_hooks").performance;
-
-const NpmGroovyLintFix = require("./groovy-lint-fix");
-const CodeNarcCaller = require("./codenarc-caller");
-const { prepareCodeNarcCall, parseCodeNarcResult } = require("./codenarc-factory");
-const { NPM_GROOVY_LINT_CONSTANTS, loadConfig, getConfigFileName } = require("./config.js");
-const optionsDefinition = require("./options");
-const { computeStats, processOutput } = require("./output.js");
-const { getNpmGroovyLintVersion, getSourceLines, isErrorInLogLevelScope } = require("./utils");
+import Debug from "debug";
+const debug = Debug("npm-groovy-lint");
+const trace = Debug("npm-groovy-lint-trace");
+import fs from "fs-extra";
+import * as os from "os";
+import * as path from "path";
+import { performance } from "node:perf_hooks";
+import { NpmGroovyLintFix } from "./groovy-lint-fix.js";
+
+import { CodeNarcCaller } from "./codenarc-caller.js";
+import { prepareCodeNarcCall, parseCodeNarcResult } from "./codenarc-factory.js";
+import { NPM_GROOVY_LINT_CONSTANTS, loadConfig, getConfigFileName } from "./config.js";
+import { optionsDefinition } from "./options.js";
+import { computeStats, processOutput } from "./output.js";
+import { getNpmGroovyLintVersion, getSourceLines, isErrorInLogLevelScope } from "./utils.js";
 
 class NpmGroovyLint {
-    "use strict";
-
     options = {}; // NpmGroovyLint options
     args = []; // Command line arguments
 
@@ -83,9 +82,9 @@ class NpmGroovyLint {
                 verbose: optns.verbose || this.options.verbose,
                 fixrules: optns.fixrules || this.options.fixrules,
                 source: optns.source || this.options.source,
-                save: this.tmpGroovyFileName ? false : true
+                save: this.tmpGroovyFileName ? false : true,
             },
-            { origin: "externalCallToFix" }
+            { origin: "externalCallToFix" },
         );
         await this.fixer.run({ errorIds: errorIds, propagate: true });
         this.lintResult = this.fixer.updatedLintResult;
@@ -139,8 +138,8 @@ class NpmGroovyLint {
         if (Array.isArray(this.args) && this.args.includes("--codenarcargs")) {
             this.codenarcArgs = this.args
                 .slice(2)
-                .filter(userArg => userArg !== "--codenarcargs") // Strip codenarcargs.
-                .map(userArg => userArg.replace(/^-(\w+)="(.*)"$/, "-$1=$2").replace(/^-(\w+)='(.*)'$/, "-$1=$2")); // Strip quotes around values which CodeNarc doesn't support.
+                .filter((userArg) => userArg !== "--codenarcargs") // Strip codenarcargs.
+                .map((userArg) => userArg.replace(/^-(\w+)="(.*)"$/, "-$1=$2").replace(/^-(\w+)='(.*)'$/, "-$1=$2")); // Strip quotes around values which CodeNarc doesn't support.
             this.onlyCodeNarc = true;
             return true;
         }
@@ -159,7 +158,7 @@ class NpmGroovyLint {
                 const configProperties = await loadConfig(
                     this.options.config || this.options.path,
                     this.options.format ? "format" : "lint",
-                    this.options.sourcefilepath || this.options.path
+                    this.options.sourcefilepath || this.options.path,
                 );
                 for (const configProp of Object.keys(configProperties)) {
                     if (this.options[configProp] == null) {
@@ -180,7 +179,7 @@ class NpmGroovyLint {
                 this.status = 2;
                 this.error = {
                     msg: `Parse options error: ${err.message}`,
-                    stack: err.stack
+                    stack: err.stack,
                 };
                 console.error(this.error.msg);
                 return false;
@@ -190,7 +189,7 @@ class NpmGroovyLint {
                 if (!isErrorInLogLevelScope(this.options.failon, this.options.loglevel)) {
                     this.status = 2;
                     this.error = {
-                        msg: `failon option (${this.options.failon}) must be > loglevel option (${this.options.loglevel})`
+                        msg: `failon option (${this.options.failon}) must be > loglevel option (${this.options.loglevel})`,
                     };
                     console.error(this.error.msg);
                     return false;
@@ -209,7 +208,7 @@ class NpmGroovyLint {
         if (this.options.killserver) {
             const startPerf = performance.now();
             const codeNarcCaller = new CodeNarcCaller(this.codenarcArgs, this.serverStatus, this.args, this.options, {
-                groovyFileName: this.tmpGroovyFileName
+                groovyFileName: this.tmpGroovyFileName,
             });
             this.outputString = await codeNarcCaller.killCodeNarcServer();
             console.info(this.outputString);
@@ -270,7 +269,7 @@ class NpmGroovyLint {
             codeNarcIncludes: this.codeNarcIncludes,
             codeNarcExcludes: this.codeNarcExcludes,
             onlyCodeNarc: this.onlyCodeNarc,
-            inputFileList: this.inputFileList
+            inputFileList: this.inputFileList,
         });
         if (!this.options.noserver) {
             serverCallResult = await codeNarcCaller.callCodeNarcServer();
@@ -305,7 +304,7 @@ class NpmGroovyLint {
                 this.codeNarcBaseDir,
                 this.codeNarcJsonResult,
                 this.tmpGroovyFileName,
-                this.parseErrors
+                this.parseErrors,
             );
             // Fix all found errors if requested
             if (this.options.fix || this.options.format) {
@@ -316,7 +315,7 @@ class NpmGroovyLint {
                     save: this.tmpGroovyFileName ? false : true,
                     origin: this.origin,
                     rules: this.options.rules,
-                    verbose: this.options.verbose
+                    verbose: this.options.verbose,
                 });
                 await this.fixer.run();
                 this.lintResult = this.fixer.updatedLintResult;
@@ -369,7 +368,7 @@ class NpmGroovyLint {
         trace(`Fix is done, lint again with options ${JSON.stringify(lintAgainOptions)}`);
         const newLinter = new NpmGroovyLint(lintAgainOptions, {
             parseOptions: false,
-            origin: "lintAgainAfterFix"
+            origin: "lintAgainAfterFix",
         });
         // Run linter
         await newLinter.run();
@@ -395,8 +394,8 @@ class NpmGroovyLint {
         delete fixAgainOptions.rules;
         delete fixAgainOptions.overriddenRules;
         fixAgainOptions.rulesets = Object.keys(this.options.rules)
-            .filter(ruleName => fixRules.includes(ruleName))
-            .map(ruleName => `${ruleName}${JSON.stringify(this.options.rules[ruleName])}`)
+            .filter((ruleName) => fixRules.includes(ruleName))
+            .map((ruleName) => `${ruleName}${JSON.stringify(this.options.rules[ruleName])}`)
             .join(",");
         fixAgainOptions.fix = true;
         fixAgainOptions.fixrules = fixRules.join(",");
@@ -416,7 +415,7 @@ class NpmGroovyLint {
         for (const afterFixResFileNm of Object.keys(lintResAfterFix.files)) {
             // Append fixed errors to errors found via control lint (post fix)
             const afterFixFileErrors = lintResAfterFix.files[afterFixResFileNm].errors;
-            const fixedErrors = afterFixFileErrors.filter(err => err.fixed === true);
+            const fixedErrors = afterFixFileErrors.filter((err) => err.fixed === true);
             const controlFileErrors =
                 lintResControl.files && lintResControl.files[afterFixResFileNm] ? lintResControl.files[afterFixResFileNm].errors || [] : [];
             const mergedFileErrors = controlFileErrors.concat(fixedErrors);
@@ -469,7 +468,7 @@ class NpmGroovyLint {
                 origin: this.origin,
                 elapse: parseInt(performance.now() - startPerf),
                 options: optionsLog,
-                args: this.codenarcArgs
+                args: this.codenarcArgs,
             });
         }
     }
@@ -484,12 +483,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;
         }
@@ -513,7 +512,7 @@ class NpmGroovyLint {
         else if (failureLevel === "warning" && (errorNb > 0 || warningNb > 0)) {
             if (!["json", "sarif", "stdout"].includes(this.outputType)) {
                 console.error(
-                    `Failure: ${this.lintResult.summary.totalRemainingErrorNumber} error(s) have been found \n ${this.lintResult.summary.totalRemainingWarningNumber} warning(s) have been found`
+                    `Failure: ${this.lintResult.summary.totalRemainingErrorNumber} error(s) have been found \n ${this.lintResult.summary.totalRemainingWarningNumber} warning(s) have been found`,
                 );
             }
             this.status = 1;
@@ -522,7 +521,7 @@ class NpmGroovyLint {
         else if (failureLevel === "info" && (errorNb > 0 || warningNb > 0 || infoNb > 0)) {
             if (!["json", "sarif", "stdout"].includes(this.outputType)) {
                 console.error(
-                    `Failure: ${this.lintResult.summary.totalRemainingErrorNumber} error(s) have been found \n ${this.lintResult.summary.totalRemainingWarningNumber} warning(s) have been found \n ${this.lintResult.summary.totalRemainingInfoNumber} info(s) have been found`
+                    `Failure: ${this.lintResult.summary.totalRemainingErrorNumber} error(s) have been found \n ${this.lintResult.summary.totalRemainingWarningNumber} warning(s) have been found \n ${this.lintResult.summary.totalRemainingInfoNumber} info(s) have been found`,
                 );
             }
             this.status = 1;
@@ -530,4 +529,4 @@ class NpmGroovyLint {
     }
 }
 
-module.exports = NpmGroovyLint;
+export default NpmGroovyLint;

package/lib/index.js

@@ -1,7 +1,7 @@
 #! /usr/bin/env node
-"use strict";
 
-const NpmGroovyLint = require("./groovy-lint.js");
+import NpmGroovyLint from "./groovy-lint.js";
+import { pathToFileURL } from "url";
 
 // Create linter/formatter/fixer with arguments
 const linter = new NpmGroovyLint(process.argv, { origin: "index" });
@@ -15,7 +15,7 @@ const linter = new NpmGroovyLint(process.argv, { origin: "index" });
         console.error("Unexpected error: " + err.message + "\n" + err.stack);
         process.exitCode = 2;
         // Quit if called by CLI and not as a module
-        if (require.main === module) {
+        if (import.meta.url === pathToFileURL(process.argv[1]).href) {
             process.exit();
         }
     }