action-codespell

This GitHub action runs codespell with reviewdog.

It is based on action-misspell from haya14busa. While misspell might be faster, it hasn't been updated for some time and also the word-list is compiled in making it quite unflexible.

Inputs

`github_token`

Required. Must be in form of github_token: ${{ secrets.github_token }}'. Defaults to ${{ github.token }}

`level`

Optional. Report level for reviewdog [info,warning,error]. It's same as -level flag of reviewdog.

`reporter`

Optional. Reporter of reviewdog command [github-pr-check,github-pr-review]. It's same as -reporter flag of reviewdog.

Configuration

The codespell action can be configured with two files in the main repository:

.codespell_skip contains one path or pattern per line (paths starting with ./) which will be skipped during the check.
-codespell_exclude contains source lines which will not be checked.
.codespell_ignore contains words which will be ignored by codespell. File must contain 1 word per line. Words are case sensitive based on how they are written in the dictionary file.

Example usage

name: reviewdog
on: [pull_request]
jobs:
  codespell:
    name: runner / codespell
    runs-on: ubuntu-latest
    steps:
      - name: Check out code.
        uses: actions/checkout@v1
      - name: codespell
        uses: plettich/action-codespell@master
        with:
          github_token: ${{ secrets.github_token }}

TODO

update word list
add words to ignore during check
add own wordlist (exclusive or additional)

nalajcie/action-codespell