Skip to content

Commit

Permalink
ci: Add typos check. (#32)
Browse files Browse the repository at this point in the history
A (mostly) blank `.typos.toml` is included to assist in discoverability
should it be needed (since the text in CI refers to it).
  • Loading branch information
waywardmonkeys authored May 20, 2024
1 parent 8ff056e commit fdafb9c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -246,3 +246,12 @@ jobs:
# We test documentation using nightly to match docs.rs. This prevents potential breakages
- name: cargo doc
run: cargo doc --workspace --locked --all-features --no-deps --document-private-items -Zunstable-options -Zrustdoc-scrape-examples

# If this fails, consider changing your text or adding something to .typos.toml
typos:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: check typos
uses: crate-ci/typos@v1.21.0
10 changes: 10 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# See the configuration reference at
# https://github.com/crate-ci/typos/blob/master/docs/reference.md

# Corrections take the form of a key/value pair. The key is the incorrect word
# and the value is the correct word. If the key and value are the same, the
# word is treated as always correct. If the value is an empty string, the word
# is treated as always incorrect.

# Match Inside a Word - Case Insensitive
[default.extend-words]

0 comments on commit fdafb9c

Please sign in to comment.