format.yml

name: Format

on:
  pull_request:
    branches: [master]
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  format:
    runs-on: ubuntu-latest
    permissions:
      issues: write
      pull-requests: write
    steps:
      - uses: actions/checkout@v7
      - name: Install volta, Node.js
        uses: volta-cli/action@v5
      - uses: pnpm/action-setup@v6
        with:
          cache: true
      - name: Fix pnpm node-gyp permissions
        run: find "$PNPM_HOME" -path '*/node-gyp/gyp/gyp_main.py' -exec chmod +x {} \;
      # NOTE(erri120): fontconfig required by font-scanner required by theme-switcher
      - name: Install fontconfig
        run: sudo apt-get update && sudo apt-get install -y libfontconfig1-dev
      - run: pnpm install
        env:
          VORTEX_ELECTRON_REBUILD: "skip"
      - name: Check formatting
        run: pnpm run format:check
      - name: Comment on PR
        if: failure() && github.event_name == 'pull_request'
        uses: actions/github-script@v9
        with:
          script: |
            const BOT_MARKER = '<!-- ci-format-check -->';
            const { data: comments } = await github.rest.issues.listComments({
              owner: context.repo.owner,
              repo: context.repo.repo,
              issue_number: context.issue.number,
            });
            const existing = comments.find(c => c.body.includes(BOT_MARKER));
            const runUrl = `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`;
            const body = [
              BOT_MARKER,
              '## ❌ Code is not formatted',
              '',
              'To fix this:',
              '',
              '1. **Set up the pre-commit hook** (prevents future issues):',
              '   ```shell',
              '   pnpm run prepare',
              '   ```',
              '   This auto-formats staged files on every commit. (You will never see this error again)',
              '',
              '2. **Format all files manually**:',
              '   ```shell',
              '   pnpm run format',
              '   ```',
              '',
              `Then commit the formatting changes. [View logs](${runUrl})`,
            ].join('\n');
            if (existing) {
              await github.rest.issues.updateComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                comment_id: existing.id,
                body: body,
              });
            } else {
              await github.rest.issues.createComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: context.issue.number,
                body: body,
              });
            }