Add a swift-format check to run on PRs.

Based off the swift-nio ones.

Author: thomasvl

.github/workflows/build.yml

@@ -132,6 +132,32 @@ jobs:
     - name: Check for API breaking changes
       run: swift package diagnose-api-breaking-changes origin/main
 
+  format-check:
+    name: swift-format Check
+    # Only on pull requests
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    container:
+      # Use use the latest Swift release and that's the version of swift-format
+      # people should use.
+      image: swift:latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Mark the workspace as safe
+      # https://github.com/actions/checkout/issues/766
+      run: git config --global --add safe.directory ${GITHUB_WORKSPACE}
+    - name: Run format check
+      run:  |
+        set -eu
+        git ls-files -z '*.swift' | xargs -0 swift format format --parallel --in-place
+        GIT_PAGER='' git diff --exit-code '*.swift'
+    # Disabled as it produces multiple warnings at the moment.
+    # - name: Run format lint check
+    #   run:  |
+    #     set -eu
+    #     git ls-files -z '*.swift' | xargs -0 swift format lint --strict --parallel
+
   sanitizer_testing:
     runs-on: ubuntu-latest
     strategy: