Skip to content

Commit

Permalink
ci: add a typo checker based on typos
Browse files Browse the repository at this point in the history
  • Loading branch information
ccoVeille committed May 16, 2024
1 parent 04b36eb commit e283e8e
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .github/workflows/spellchecker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: spell checking
on: [pull_request]

jobs:
typos:
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- name: Checkout Actions Repository
uses: actions/checkout@v4
- name: typos-action
uses: crate-ci/[email protected]

11 changes: 11 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[default]
locale = "en-us"

[default.extend-words]
FROMM ="FROMM" # this one is intentionally written with a typo
unmarshaling ="unmarshaling" # this one is expected in golang

[files]
# excluded file
# go.sum and go.mod contains URLs with hash, they can provide false positive
extend-exclude = ["go.sum","go.mod"]

0 comments on commit e283e8e

Please sign in to comment.