From f14cc6a042863e798f0013d91e266e169f53546c Mon Sep 17 00:00:00 2001 From: Bruce Mitchener Date: Mon, 20 May 2024 09:41:40 +0700 Subject: [PATCH] ci: Add typos check. A (mostly) blank `.typos.toml` is included to assist in discoverability should it be needed (since the text in CI refers to it). --- .github/workflows/ci.yml | 9 +++++++++ .typos.toml | 10 ++++++++++ 2 files changed, 19 insertions(+) create mode 100644 .typos.toml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 422d0dc..8f9b381 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -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 diff --git a/.typos.toml b/.typos.toml new file mode 100644 index 0000000..8368cc2 --- /dev/null +++ b/.typos.toml @@ -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]