spellcheck.yml

name: Spell Check .md
on:
  workflow_call:

env:
  JSON_FILE: spell-check.json
  DICTIONARY_FILE: .github/dictionary.txt

jobs:
  spellcheck:
    name: Check Spelling
    runs-on: ubuntu-latest
    if: ${{ github.event.workflow_run && github.event.workflow_run.conclusion == 'success' || 1 }}
    steps:
      - uses: actions/checkout@v3
      - name: Get Changed Files
        id: changed-files
        uses: tj-actions/changed-files@v29.0.2
        with:
          base_sha: ${{ github.event.pull_request.base.sha }}
          files: |
            **/*.md
      - name: Get File Input
        id: files
        run: |
          if ${{ github.event_name == 'push' || github.event_name == 'pull_request' }}; then
              echo "::set-output name=files::${{ steps.changed-files.outputs.all_changed_files }}"
          else
              echo "::set-output name=files::**/*.md"
          fi
          echo "${{ steps.files.outputs.files }}"

      - name: Check for Dictionary
        id: check_files
        uses: andstor/file-existence-action@v1
        with:
          files: ".github/dictionary.txt"
      - name: Create Dictionary
        if: steps.check_files.outputs.files_exists == 'false'
        run: touch ".github/dictionary.txt"

      - name: Run spellchecker-cli
        id: spellchecker-cli
        if: ${{ steps.files.outputs.files }}
        continue-on-error: true
        run: |
          npx -y spellchecker-cli --files ${{ steps.files.outputs.files }} \
            --dictionaries $DICTIONARY_FILE \
            --ignore "[.0-9]+([Kk][Bb]|[Mm][Bb]|[Gg][Bb])" \
            --ignore "\b[Ff][0-9]+('?s)?\b" \
            --ignore "\b[Qq][0-4]\b" \
            --ignore "\b[Vv][.0-9]\b" \
            --ignore "\b[Vv]?(\d+\.)?(\d+\.)?(\*|\d+)\b" \
            --plugins spell indefinite-article repeated-words syntax-mentions syntax-urls \
            --reports $JSON_FILE

      - name: Upload JSON Artifact
        uses: actions/upload-artifact@v3
        if: ${{ steps.spellchecker-cli.conclusion == 'success' }}
        with:
          path: ${{ env.JSON_FILE }}
      - name: Create Output
        uses: austenstone/spellchecker-cli-action-summary@main
        with:
          files-changed: ${{ steps.changed-files.outputs.all_changed_files }}