codespell.yml

name: Codespell

on:
  push:
    branches: [ master, main, develop ]
  pull_request:
    branches: [ master, main, develop ]

permissions:
  contents: read

jobs:
  codespell:
    name: Check for spelling errors
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v5

      - name: Install Codespell
        run: python -m pip install --upgrade 'codespell[toml]'

      - name: Run Codespell
        run: |
          codespell \
            --skip="*.lock,*.json,*.map,*.yaml,*.yml,*.csv,*.bib,target,node_modules,.git,dist,venv,build,benchmarks,coverage" \
            --ignore-words-list="crate,ser,deser,upToDate,optIn,shouldBe,Bloc"
          # MONOREPO NOTE: Add multilingual stopwords to ignore-words-list if needed
          # Example: --ignore-words-list="crate,ser,deser,meu,oder,ist,alle" (Portuguese,German,etc)