Add reusable HTML formatting workflow

Author: elasticdog

.github/workflows/check-html.yml

@@ -0,0 +1,37 @@
+name: check html
+
+on:
+  workflow_call:
+    inputs:
+      files:
+        type: string
+        default: "**/*.html"
+      prettier_version:
+        type: string
+        default: "latest"
+
+jobs:
+  format:
+    name: format
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10
+        with:
+          persist-credentials: false
+
+      - name: Check HTML file formatting
+        env:
+          INPUTS_PRETTIER_VERSION: ${{ inputs.prettier_version }}
+          INPUTS_FILES: ${{ inputs.files }}
+        run: |
+          set -euo pipefail
+
+          # Split INPUTS_FILES into an array (space-separated)
+          IFS=' ' read -r -a files <<<"$INPUTS_FILES"
+
+          npx --yes "prettier@${INPUTS_PRETTIER_VERSION}" \
+            --check \
+            --debug-check \
+            --color \
+            -- "${files[@]}"

.github/workflows/detect-changed-files.yml

@@ -19,6 +19,10 @@ on:
         value: ${{ jobs.filter_changes.outputs.github_actions }}
       github_actions_files:
         value: ${{ jobs.filter_changes.outputs.github_actions_files }}
+      html:
+        value: ${{ jobs.filter_changes.outputs.html }}
+      html_files:
+        value: ${{ jobs.filter_changes.outputs.html_files }}
       markdown:
         value: ${{ jobs.filter_changes.outputs.markdown }}
       markdown_files:
@@ -47,6 +51,8 @@ jobs:
       flutter_files: ${{ steps.filter.outputs.flutter_files }}
       github_actions: ${{ steps.filter.outputs.github_actions }}
       github_actions_files: ${{ steps.filter.outputs.github_actions_files }}
+      html: ${{ steps.filter.outputs.html }}
+      html_files: ${{ steps.filter.outputs.html_files }}
       markdown: ${{ steps.filter.outputs.markdown }}
       markdown_files: ${{ steps.filter.outputs.markdown_files }}
       rust: ${{ steps.filter.outputs.rust }}
@@ -77,6 +83,8 @@ jobs:
             github_actions:
               - added|modified: .github/workflows/*.yml
               - added|modified: .github/workflows/*.yaml
+            html:
+              - added|modified: '**/*.html'
             markdown:
               - added|modified: '**/*.md'
             rust:
@@ -96,6 +104,8 @@ jobs:
           FLUTTER_FILES: ${{ steps.filter.outputs.flutter_files }}
           GH_ACTIONS: ${{ steps.filter.outputs.github_actions }}
           GH_ACTIONS_FILES: ${{ steps.filter.outputs.github_actions_files }}
+          HTML: ${{ steps.filter.outputs.html }}
+          HTML_FILES: ${{ steps.filter.outputs.html_files }}
           MARKDOWN: ${{ steps.filter.outputs.markdown }}
           MARKDOWN_FILES: ${{ steps.filter.outputs.markdown_files }}
           RUST: ${{ steps.filter.outputs.rust }}
@@ -137,6 +147,7 @@ jobs:
           emit_category "CSS" "${CSS}" "${CSS_FILES}"
           emit_category "Flutter" "${FLUTTER}" "${FLUTTER_FILES}"
           emit_category "GitHub Actions" "${GH_ACTIONS}" "${GH_ACTIONS_FILES}"
+          emit_category "HTML" "${HTML}" "${HTML_FILES}"
           emit_category "Markdown" "${MARKDOWN}" "${MARKDOWN_FILES}"
           emit_category "Rust" "${RUST}" "${RUST_FILES}"
           emit_category "Zig" "${ZIG}" "${ZIG_FILES}"

README.md

@@ -46,6 +46,7 @@ General-purpose workflows intended for use by any repository:
 
 - `detect-changed-files.yml` – Expose paths-filter outputs for conditional jobs
 - `check-github-actions.yml` – Lint workflows via actionlint
+- `check-html.yml` – Format and lint HTML via Prettier
 - `check-markdown.yml` – Format and lint Markdown via Prettier
 - `check-shell.yml` – Format and lint shell scripts
 - `check-spelling.yml` – Spellcheck via typos

docs/common.md

@@ -40,6 +40,7 @@ For each filter name listed below:
 | `css`               | CSS changes                                 |
 | `flutter`           | Dart / pubspec / analysis options changes   |
 | `github_actions`    | Workflow changes under `.github/workflows/` |
+| `html`              | HTML changes                                |
 | `markdown`          | Markdown changes                            |
 | `rust`              | Rust / Cargo changes                        |
 | `zig`               | Zig / zon changes                           |
@@ -78,6 +79,36 @@ Lints GitHub Actions workflow files using
 
 ---
 
+## check-html.yml
+
+Checks HTML formatting using [Prettier](https://prettier.io/).
+
+**Inputs**
+
+| Name               | Required | Default     |
+| ------------------ | -------- | ----------- |
+| `files`            | false    | `**/*.html` |
+| `prettier_version` | false    | `latest`    |
+
+**Typical usage with changed files**
+
+```yml
+jobs:
+  detect_changed_files:
+    permissions:
+      pull-requests: read
+    uses: EarthmanMuons/reusable-workflows/.github/workflows/detect-changed-files.yml@main
+
+  check_html:
+    needs: detect_changed_files
+    if: needs.detect_changed_files.outputs.html == 'true'
+    uses: EarthmanMuons/reusable-workflows/.github/workflows/check-html.yml@main
+    with:
+      files: ${{ needs.detect_changed_files.outputs.html_files }}
+```
+
+---
+
 ## check-markdown.yml
 
 Checks Markdown formatting using [Prettier](https://prettier.io/).