Skip to content

Commit

Permalink
spellcheck CI
Browse files Browse the repository at this point in the history
  • Loading branch information
palday committed Nov 6, 2023
1 parent 1898674 commit 7c5cf65
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# adapted from https://github.com/JuliaDocs/Documenter.jl/blob/master/.github/workflows/SpellCheck.yml
# see docs at https://github.com/crate-ci/typos
name: Spell Check
on: [pull_request]

jobs:
typos-check:
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- name: Checkout Actions Repository
uses: actions/checkout@v4
- name: Check spelling
uses: crate-ci/typos@master
with:
config: _typos.toml
write_changes: true
- uses: reviewdog/action-suggester@v1
with:
tool_name: Typos
fail_on_error: true
20 changes: 20 additions & 0 deletions _typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# https://github.com/crate-ci/typos#false-positives
[default]

[default.extend-identifiers]
Lik = "Lik"
missings = "missings"

[default.extend-words]
Lik = "Lik"
missings = "missings"

[type.package_toml]
# Don't check spellings in these files
extend-glob = ["Manifest.toml", "Project.toml"]
check-file = false

[type.bib]
# contain lots of names, which are a great spot for false positives
extend-glob = ["*.bib"]
check-file = false

0 comments on commit 7c5cf65

Please sign in to comment.