Allow formatting xml files when cli_lint_mode is file

oxsecurity · Jan 10, 2023 · 97e27bf · 97e27bf
1 parent 1d74fa0
commit 97e27bf
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 1 deletion.
diff --git a/.automation/test/xml/xml_bad_1.xml → .automation/test/xml/bad/xml_bad_1.xml b/.automation/test/xml/xml_bad_1.xml → .automation/test/xml/bad/xml_bad_1.xml
diff --git a/.automation/test/xml/bad/xml_bad_2.xml b/.automation/test/xml/bad/xml_bad_2.xml
@@ -0,0 +1,6 @@
+<note>
+  <to>Tove</to>
+  <from>Jani<from>
+  <heading>Reminder</heading>
+  <body>Don't forget me this weekend!</body>
+<note>
diff --git a/.automation/test/xml/xml_good_1.xml → .automation/test/xml/good/xml_good_1.xml b/.automation/test/xml/xml_good_1.xml → .automation/test/xml/good/xml_good_1.xml
diff --git a/.automation/test/xml/good/xml_good_2.xml b/.automation/test/xml/good/xml_good_2.xml
@@ -0,0 +1,6 @@
+<note>
+  <to>Tove</to>
+  <from>Jani</from>
+  <heading>Reminder</heading>
+  <body>Don't forget me this weekend!</body>
+</note>
diff --git a/megalinter/descriptors/xml.megalinter-descriptor.yml b/megalinter/descriptors/xml.megalinter-descriptor.yml
@@ -8,15 +8,25 @@ file_extensions:
   - ".xml"
 linters:
   # XML LINT
-  - linter_name: xmllint
+  - class: XmlLintLinter
+    linter_name: xmllint
+    variables:
+      - name: XML_XMLLINT_AUTOFORMAT
+        default_value: "false"
+        description: If set to `true`, it will reformat and reindent the output
+      - name: XML_XMLLINT_INDENT
+        default_value: "  "
+        description: The number of indentation spaces when `XML_XMLLINT_AUTOFORMAT` is `true`
     linter_url: http://xmlsoft.org/xmllint.html
     linter_rules_url: http://xmlsoft.org/xmllint.html#diagnostics
     version_extract_regex: "(?<=libxml version )\\d+(\\d+)+"
     cli_lint_mode: list_of_files
+    cli_lint_fix_arg_name: "--format"
     cli_help_arg_name: "--help"
     help_command_return_code: 1
     examples:
       - "xmllint myfile.xml"
+      - "xmllint --format myfile.xml --output myfile.xml"
     install:
       apk:
         - libc-dev

diff --git a/megalinter/linters/XmlLintLinter.py b/megalinter/linters/XmlLintLinter.py
@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+"""
+Use XmlLint to lint xml files
+http://xmlsoft.org/xmllint.html
+"""
+import os
+
+from megalinter import Linter, config
+
+
+class XmlLintLinter(Linter):
+    # Build the CLI command to call to lint a file
+    def build_lint_command(self, file=None):
+        cmd = super().build_lint_command(file)
+
+        if (
+            self.apply_fixes is True
+            and self.cli_lint_fix_arg_name is not None
+            and config.get("XML_XMLLINT_AUTOFORMAT", "false") == "true"
+        ):
+            if self.cli_lint_mode == "file":
+                os.environ["XMLLINT_INDENT"] = config.get("XML_XMLLINT_INDENT", "  ")
+
+                cmd += f" {self.cli_lint_fix_arg_name} --output {file}"
+            else:
+                raise KeyError(
+                    f"You can not apply_fixes with cli_lint_mode {self.cli_lint_mode}"
+                )
+        return cmd