From 35a1d3f20547392b5177451a0138f7dcd6d4987e Mon Sep 17 00:00:00 2001 From: mrg Date: Mon, 14 Apr 2025 21:43:09 -0600 Subject: [PATCH 1/5] Add typos for CI, include typos.toml --- .github/workflows/main.yml | 9 +++++++++ typos.toml | 18 ++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 typos.toml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 03652b5551..3186c820b4 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -70,6 +70,15 @@ jobs: run: rustup update stable && rustup default stable && rustup component add rustfmt - run: cargo fmt --check + spelling: + name: Spell Check with Typos + runs-on: ubuntu-latest + steps: + - name: Checkout Actions Repository + uses: actions/checkout@v4 + - name: Spell Check repo + uses: crate-ci/typos@v1.31.1 + gui: name: GUI tests runs-on: ubuntu-latest diff --git a/typos.toml b/typos.toml new file mode 100644 index 0000000000..13fdd9c4fe --- /dev/null +++ b/typos.toml @@ -0,0 +1,18 @@ +[files] +extend-exclude = [ + "test_book/", + "*.css", + "tests/summary_md_files/the_book-2nd_edition.md", + "CHANGELOG.md", + "tests/parse_existing_summary_files.rs", + "src/front-end/fonts/fontawesome-webfont.svg", + "src/front-end/searcher/elasticlunr.min.js", + "src/front-end/playground_editor/ace.js", + "src/front-end/playground_editor/ace.js", + "src/front-end/js/highlight.js", + "src/front-end/js/book.js", + "src/preprocess/links.rs", + "src/preprocess/links.rs", + "src/book/book.rs", + "src/renderer/html_handlebars/hbs_renderer.rs", +] From 9c1155361a21afaf244625c0bd69c329511500c5 Mon Sep 17 00:00:00 2001 From: mrg Date: Mon, 21 Apr 2025 17:04:24 -0600 Subject: [PATCH 2/5] Add typos to CI --- typos.toml | 1 - 1 file changed, 1 deletion(-) diff --git a/typos.toml b/typos.toml index 13fdd9c4fe..f8649e4b91 100644 --- a/typos.toml +++ b/typos.toml @@ -12,7 +12,6 @@ extend-exclude = [ "src/front-end/js/highlight.js", "src/front-end/js/book.js", "src/preprocess/links.rs", - "src/preprocess/links.rs", "src/book/book.rs", "src/renderer/html_handlebars/hbs_renderer.rs", ] From 5f30428117efd7c6c3d2fbc3ad96a2d6d8c90a82 Mon Sep 17 00:00:00 2001 From: mrg Date: Mon, 21 Apr 2025 17:05:25 -0600 Subject: [PATCH 3/5] Add typos to CI --- typos.toml | 1 - 1 file changed, 1 deletion(-) diff --git a/typos.toml b/typos.toml index f8649e4b91..ca9439d2f6 100644 --- a/typos.toml +++ b/typos.toml @@ -8,7 +8,6 @@ extend-exclude = [ "src/front-end/fonts/fontawesome-webfont.svg", "src/front-end/searcher/elasticlunr.min.js", "src/front-end/playground_editor/ace.js", - "src/front-end/playground_editor/ace.js", "src/front-end/js/highlight.js", "src/front-end/js/book.js", "src/preprocess/links.rs", From 5c0485112b1c04646ae21404321025875f3549b9 Mon Sep 17 00:00:00 2001 From: mrg Date: Mon, 21 Apr 2025 17:16:00 -0600 Subject: [PATCH 4/5] Take out more files from typos.toml --- typos.toml | 2 -- 1 file changed, 2 deletions(-) diff --git a/typos.toml b/typos.toml index ca9439d2f6..3722ac6b0b 100644 --- a/typos.toml +++ b/typos.toml @@ -11,6 +11,4 @@ extend-exclude = [ "src/front-end/js/highlight.js", "src/front-end/js/book.js", "src/preprocess/links.rs", - "src/book/book.rs", - "src/renderer/html_handlebars/hbs_renderer.rs", ] From 4491eb44656bbd531d98f7a2ed8b30890de97a65 Mon Sep 17 00:00:00 2001 From: mrg Date: Mon, 21 Apr 2025 17:22:48 -0600 Subject: [PATCH 5/5] Add typos notes to CONTIBUTING.md --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a6d4afe11c..6b205466a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,6 +99,19 @@ Like formatting your code with `rustfmt`, running clippy regularly and before yo cargo clippy ``` +#### Finding typos with `typos-cli` + +[typos](https://github.com/crate-ci/typos) is a tool to check for typos in any of the repos files that are not whitelisted inside of `typos.toml`. It runs as a [GitHub Action](https://github.com/crate-ci/typos/blob/master/docs/github-action.md) as part of our CI. + +1. To install + ``` + cargo binstall -y typos + ``` +2. Running `typos` + ``` + typos + ``` + ### Change requirements Please consider the following when making a change: