feature: add ansible-lint auto-fix on save capability (#2151)

Author: Jkhall81

package.json

@@ -331,6 +331,13 @@
             "scope": "resource",
             "type": "string"
           },
+          "ansible.validation.lint.autoFixOnSave": {
+            "default": false,
+            "markdownDescription": "Specifies whether `ansible-lint --fix` should run automatically when you save a file. [Learn more](https://ansible.readthedocs.io/projects/lint/autofix/)",
+            "order": 4,
+            "scope": "resource",
+            "type": "boolean"
+          },
           "ansible.validation.lint.enabled": {
             "default": true,
             "markdownDescription": "Enables `ansible-lint`. If disabled only `ansible-playbook --syntax-check` will run. Requires `#ansible.validation.enabled#` to be enabled.",

packages/ansible-language-server/src/interfaces/extensionSettings.ts

@@ -44,7 +44,12 @@ export interface ExtensionSettings extends ExtensionSettingsType {
   };
   validation: {
     enabled: boolean;
-    lint: { enabled: boolean; path: string; arguments: string };
+    lint: {
+      enabled: boolean;
+      path: string;
+      arguments: string;
+      autoFixOnSave: boolean;
+    };
   };
   executionEnvironment: {
     enabled: boolean;
@@ -156,5 +161,9 @@ interface ValidationSettingsWithDescription extends SettingsEntry {
       default: string;
       description: string;
     };
+    autoFixOnSave: {
+      default: boolean;
+      description: string;
+    };
   };
 }

packages/ansible-language-server/src/services/ansibleLint.ts

@@ -73,6 +73,10 @@ export class AnsibleLint {
     this._ansibleLintConfigFilePath = ansibleLintConfigPath;
     linterArguments = `${linterArguments} --offline --nocolor -f codeclimate`;
 
+    if (settings.validation.lint.autoFixOnSave) {
+      linterArguments = `${linterArguments} --fix`;
+    }
+
     const docPath = URI.parse(textDocument.uri).path;
     mountPaths.add(path.dirname(docPath));
 

packages/ansible-language-server/src/services/settingsManager.ts

@@ -110,6 +110,11 @@ export class SettingsManager {
           description:
             "Optional command line arguments to be appended to ansible-lint invocation",
         },
+        autoFixOnSave: {
+          default: false,
+          description:
+            "Specifies whether `ansible-lint --fix` should run automatically when you save a file.",
+        },
       },
     },
   };