npm-groovy-lint 16.0.1 → 16.1.1

package/README.md

@@ -12,7 +12,8 @@
 [![Docker Pulls](https://img.shields.io/docker/pulls/nvuillam/npm-groovy-lint)](https://hub.docker.com/r/nvuillam/npm-groovy-lint)
 [![Docker Stars](https://img.shields.io/docker/stars/nvuillam/npm-groovy-lint)](https://hub.docker.com/r/nvuillam/npm-groovy-lint)
 [![License](https://img.shields.io/npm/l/npm-groovy-lint.svg)](https://github.com/nvuillam/npm-groovy-lint/blob/master/package.json)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)<!-- gh-dependents-info-used-by-start -->
+[![Generated by github-dependents-info](https://img.shields.io/static/v1?label=Used%20by&message=54&color=informational&logo=slickpic)](https://github.com/nvuillam/npm-groovy-lint/blob/main/docs/github-dependents-info.md)<!-- gh-dependents-info-used-by-end -->
 
 ## Groovy & Jenkinsfile Linter, Formatter and Auto-fixer
 
@@ -53,6 +54,7 @@ Any **question**, **problem** or **enhancement request** ? Ask [**here**](https:
 | --format                | Boolean | Format source code                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | --fix                   | Boolean | Automatically fix problems when possible<br/> See [Auto-fixable rules](#auto-fixable-rules)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 | -x<br/> --fixrules      | String  | Option for --fix argument: List of rule identifiers to fix (if not specified, all available fixes will be applied). See [Auto-fixable rules](#auto-fixable-rules) <br/> Examples:<br/> - `"SpaceBeforeClosingBrace,SpaceAfterClosingBrace,UnusedImport"`<br/> - `"Indentation"`<br/>                                                                                                                                                                                                                                                                                          |
+| --fixrulesexclude       | String  | Option for --fix argument: Comma-separated list of rule identifiers to exclude from fixes (if not specified, none are excluded). If used with --fixrules, exclusion is applied last (excluded rules cancel included rules). See [Auto-fixable rules](#auto-fixable-rules) <br/> Examples:<br/> - `"Indentation,IndentationClosingBraces,BracesForIfElse"`<br/> - `"UnnecessarySemicolon,SpaceAfterComma"`<br/>                                                                                                                                                                                                                         |
 | --nolintafter           | Boolean | When format or fix is called, a new lint is performed after the fixes to update the returned error list. If you just want the updated source code and do not care about the error logs, use this parameter to improve performances                                                                                                                                                                                                                                                                                                                                            |
 | -r<br/> --rulesets      | String  | [RuleSet file(s)](http://codenarc.github.io/CodeNarc/codenarc-creating-ruleset.html) to use for linting, if you do not want to use recommended rules or .groovylintrc.js defined rules.<br/>If list of comma separated strings corresponding to CodeNarc rules, a RuleSet file will be dynamically generated </br>  Examples:<br/> - `"./config/codenarc/RuleSet-Custom.groovy"`<br/> - `"./path/to/my/ruleset/files"`<br/>- `Indentation{"spacesPerIndentLevel":2,"severity":"warning"},UnnecessarySemicolon,UnnecessaryGString`                                             |
 | --rulesetsoverridetype  | String  | If list of rules sent in rulesets option, defines if they replace rules defined in .groovylintrc.json, or if they are appended<br/> Values: `replaceConfig` (default), `appendConfig`                                                                                                                                                                                                                                                                                                                                                                                         |
@@ -114,6 +116,18 @@ Any **question**, **problem** or **enhancement request** ? Ask [**here**](https:
     npm-groovy-lint --fix my/path/to/file.groovy my/path/to/file2.groovy
 ```
 
+- Fix files but exclude specific rules (useful for avoiding buggy indentation rules)
+
+```shell
+    npm-groovy-lint --fix --fixrulesexclude Indentation,IndentationClosingBraces,BracesForIfElse my/path/to/file.groovy
+```
+
+- Fix only specific rules
+
+```shell
+    npm-groovy-lint --fix --fixrules SpaceAfterComma,TrailingWhitespace,UnusedImport my/path/to/file.groovy
+```
+
 - Get formatted sources in stdout from stdin
 
 ```shell

package/lib/groovy-lint-fix.js

@@ -16,6 +16,7 @@ export class NpmGroovyLintFix {
     origin = "unknown";
     format = false;
     fixRules = null;
+    fixRulesExcluded = null;
     fixableErrors = {};
     fixedErrorsNumber = 0;
     fixedErrorsIds = [];
@@ -32,6 +33,10 @@ export class NpmGroovyLintFix {
         if (this.options.fixrules && this.options.fixrules !== "all") {
             this.fixRules = this.options.fixrules.split(",");
         }
+        // Load excluded fix rules
+        if (this.options.fixrulesexclude && this.options.fixrulesexclude !== "") {
+            this.fixRulesExcluded = this.options.fixrulesexclude.split(",").map(s => s.trim()).filter(Boolean);
+        }
         this.format = optionsIn.format === true;
         this.origin = optionsIn.origin || this.origin;
     }
@@ -71,11 +76,17 @@ export class NpmGroovyLintFix {
             this.fixableErrors[fileNm] = [];
             const fileErrors = this.updatedLintResult.files[fileNm].errors;
             for (const err of fileErrors) {
+                // Check if rule is allowed by include list
+                const allowedByInclude = this.fixRules == null || this.fixRules.includes(err.rule) || this.fixRules[0] === "TriggerTestError";
+                // Check if rule is excluded
+                const excluded = this.fixRulesExcluded && this.fixRulesExcluded.includes(err.rule);
+                
                 if (
                     (errorIds == null || errorIds.includes(err.id)) &&
                     this.npmGroovyLintRules[err.rule] != null &&
                     this.npmGroovyLintRules[err.rule].fix != null &&
-                    (this.fixRules == null || this.fixRules.includes(err.rule) || this.fixRules[0] === "TriggerTestError")
+                    allowedByInclude &&
+                    !excluded
                 ) {
                     // Add fixable error
                     const fixableError = {
@@ -95,6 +106,10 @@ export class NpmGroovyLintFix {
                     // Trigger other fixes if defined in the rule
                     if (this.npmGroovyLintRules[err.rule].triggers) {
                         for (const triggeredRuleName of this.npmGroovyLintRules[err.rule].triggers) {
+                            // Skip if triggered rule is excluded
+                            if (this.fixRulesExcluded && this.fixRulesExcluded.includes(triggeredRuleName)) {
+                                continue;
+                            }
                             const fixableErrorTriggered = {
                                 id: err.id + "_triggered",
                                 ruleName: triggeredRuleName,
@@ -119,6 +134,10 @@ export class NpmGroovyLintFix {
             if (this.format || this.fixRules == null) {
                 const formattingRulesToAlwaysRun = getFormattingRulesToAlwaysRun();
                 for (const formattingRuleName of formattingRulesToAlwaysRun) {
+                    // Skip if formatting rule is excluded
+                    if (this.fixRulesExcluded && this.fixRulesExcluded.includes(formattingRuleName)) {
+                        continue;
+                    }
                     const rule = this.npmGroovyLintRules[formattingRuleName];
                     const fixableErrorTriggered = {
                         id: "format_triggered",
@@ -173,6 +192,10 @@ export class NpmGroovyLintFix {
                 for (let i = 0; i < this.fixableErrors[fileNm].length; i++) {
                     // Do not use for-of as content can change during the loops
                     const fileFixableError = this.fixableErrors[fileNm][i];
+                    // Skip if rule is excluded
+                    if (this.fixRulesExcluded && this.fixRulesExcluded.includes(fileFixableError.ruleName)) {
+                        continue;
+                    }
                     if (this.fixRules != null && !this.fixRules.includes(fileFixableError.ruleName) && this.fixRules[0] !== "TriggerTestError") {
                         continue;
                     }

package/lib/groovy-lint.js

@@ -81,6 +81,7 @@ class NpmGroovyLint {
             {
                 verbose: optns.verbose || this.options.verbose,
                 fixrules: optns.fixrules || this.options.fixrules,
+                fixrulesexclude: optns.fixrulesexclude || this.options.fixrulesexclude,
                 source: optns.source || this.options.source,
                 save: this.tmpGroovyFileName ? false : true,
             },
@@ -311,6 +312,7 @@ class NpmGroovyLint {
                 this.fixer = new NpmGroovyLintFix(this.lintResult, {
                     format: this.options.format === true,
                     fixrules: this.options.fixrules,
+                    fixrulesexclude: this.options.fixrulesexclude,
                     source: this.options.source,
                     save: this.tmpGroovyFileName ? false : true,
                     origin: this.origin,
@@ -386,6 +388,16 @@ class NpmGroovyLint {
             fixRules.push(...filesAndRulesToProcess[file].fixrules);
         }
         fixRules = [...new Set(fixRules)]; // Remove duplicates
+        // If there are excluded rules, filter them out from the fixRules list
+        if (this.options.fixrulesexclude) {
+            const excludedRules = this.options.fixrulesexclude.split(",").map(s => s.trim()).filter(Boolean);
+            fixRules = fixRules.filter(rule => !excludedRules.includes(rule));
+        }
+        // If all rules were excluded, don't run fixAgainAfterFix
+        if (fixRules.length === 0) {
+            debug(`All triggered rules are excluded, skipping fixAgainAfterFix`);
+            return;
+        }
         if (this.options.source) {
             fixAgainOptions.source = this.lintResult.files[0].updatedSource;
         }

package/lib/options.js

@@ -74,6 +74,14 @@ export const optionsDefinition = optionator({
             description: "Option for --fix argument: List of rule identifiers to fix (if not specified, all available fixes will be applied)",
             example: ["SpaceBeforeClosingBrace,SpaceAfterClosingBrace,UnusedImport"],
         },
+        {
+            option: "fixrulesexclude",
+            type: "String",
+            default: "",
+            dependsOn: ["fix"],
+            description: "Option for --fix argument: Comma-separated list of rule identifiers to exclude from fixes (if not specified, none are excluded). Can be combined with --fixrules",
+            example: ["Indentation,IndentationClosingBraces", "UnnecessarySemicolon,SpaceAfterComma"],
+        },
         {
             option: "ignorepattern",
             alias: "i",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-groovy-lint",
-  "version": "16.0.1",
+  "version": "16.1.1",
   "description": "Lint, format and auto-fix your Groovy / Jenkinsfile / Gradle files",
   "exports": "./lib/groovy-lint.js",
   "type": "module",