Skip to content

Commit

Permalink
Add typos spell checker to CI (#20)
Browse files Browse the repository at this point in the history
# Objective

Prevent typos.

## Solution

Add the `typos` spell checker to CI.
  • Loading branch information
doonv authored Feb 28, 2024
1 parent b7cb13c commit 512917e
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,20 @@ jobs:
- name: Run cargo clippy
# TODO: Mark warnings as errors once all warnings are gone
# run: cargo clippy -- -D warnings
run: cargo clippy
run: cargo clippy

typos:
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v4
- name: Check for typos
uses: crate-ci/[email protected]
- name: Typos info
if: failure()
run: |
echo 'To fix typos, please run `typos -w`'
echo 'To check for a diff, run `typos`'
echo 'You can find typos here: https://crates.io/crates/typos'
echo 'if you use VSCode, you can also install `Typos Spell Checker'
echo 'You can find the extension here: https://marketplace.visualstudio.com/items?itemName=tekumara.typos-vscode'

0 comments on commit 512917e

Please sign in to comment.