feat: add XML format via prettier (#474)

* feat: add XML format via prettier

* fixes

---------

Co-authored-by: Alex Eagle <[email protected]>

Author: b0inbot

README.md

@@ -51,6 +51,7 @@ Linters which are not language-specific:
 | TSX                    | [Prettier]            | [ESLint]                         |
 | TypeScript             | [Prettier]            | [ESLint]                         |
 | YAML                   | [yamlfmt]             |                                  |
+| XML                    | [prettier/plugin-xml] |                                  |
 
 [prettier]: https://prettier.io
 [google-java-format]: https://github.com/google/google-java-format
@@ -68,6 +69,7 @@ Linters which are not language-specific:
 [ktlint]: https://github.com/pinterest/ktlint
 [buildifier]: https://github.com/keith/buildifier-prebuilt
 [prettier-plugin-sql]: https://github.com/un-ts/prettier
+[prettier/plugin-xml]: https://github.com/prettier/plugin-xml
 [gofmt]: https://pkg.go.dev/cmd/gofmt
 [gofumpt]: https://github.com/mvdan/gofumpt
 [jsonnetfmt]: https://github.com/google/go-jsonnet

docs/format.md

@@ -9,6 +9,7 @@
     "eslint": "^9.16.0",
     "prettier": "^2.8.7",
     "prettier-plugin-sql": "^0.14.0",
+    "@prettier/plugin-xml": "^0.10.0",
     "stylelint": "^16",
     "stylelint-config-standard": "^36.0.1",
     "typescript": "4.9.5",

example/package.json

@@ -0,0 +1,4 @@
+<hello>
+<world>
+  todo</world>
+</hello>

example/src/hello.xml

@@ -93,6 +93,7 @@ format_multirun(
     swift = ":swiftformat",
     terraform = "@aspect_rules_lint//format:terraform",
     visibility = ["//:__subpackages__"],
+    xml = ":prettier",
     yaml = "@aspect_rules_lint//format:yamlfmt",
 )
 

example/tools/format/BUILD.bazel

@@ -142,6 +142,9 @@ function ls-files {
       'TypeScript') patterns=('*.ts' '*.cts' '*.mts') ;;
       'Vue') patterns=('*.vue') ;;
       'YAML') patterns=('*.yml' '*.yaml' '.clang-format' '.clang-tidy' '.gemrc') ;;
+      # Note: https://github.com/github-linguist/linguist/blob/559a6426942abcae16b6d6b328147476432bf6cb/lib/linguist/languages.yml#L7767-L7882
+      # has a giant list of patterns. We arbitrarily choose some "common" ones.
+      'XML') patterns=('*.xml' '*.xsd') ;;
 
       # Note: terraform fmt cannot handle all HCL files such as .terraform.lock
       # "Only .tf and .tfvars files can be processed with terraform fmt"

format/private/format.sh

@@ -26,6 +26,7 @@ TOOLS = {
     "Cuda": "clang-format",
     "YAML": "yamlfmt",
     "Rust": "rustfmt",
+    "XML": "prettier",
 }
 
 # Provided to make install more convenient

format/private/formatter_binary.bzl

@@ -57,5 +57,6 @@ format_multirun(
     swift = ":mock_swiftformat.sh",
     # TODO: this attribute should be renamed to hcl
     terraform = ":mock_terraform-fmt.sh",
+    xml = ":mock_prettier.sh",
     yaml = ":mock_yamlfmt.sh",
 )

format/test/BUILD.bazel

@@ -40,6 +40,13 @@ bats_load_library "bats-assert"
     assert_output --partial "+ prettier --write .bcr/README.md CONTRIBUTING.md README.md"
 }
 
+@test "should run prettier on XML" {
+    run bazel run //format/test:format_XML_with_prettier
+    assert_success
+
+    assert_output --partial "+ prettier --write example/checkstyle-suppressions.xml"
+}
+
 @test "should run prettier on CSS" {
     run bazel run //format/test:format_CSS_with_prettier
     assert_success