From 83e578549d6abd37a1cb05c7e33be2e2cb8133b9 Mon Sep 17 00:00:00 2001 From: John Nunley Date: Tue, 12 Mar 2024 19:46:30 -0700 Subject: [PATCH] ci: Add spellcheck to CI In order to ensure that typos are not introduced in future commits, this commit adds a spellchecker to CI. See also: rust-windowing/winit#3557 Signed-off-by: John Nunley --- .github/workflows/ci.yml | 8 +++++++- src/lib.rs | 2 +- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 180d999..f4f5ee4 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -13,7 +13,7 @@ env: jobs: fmt: - name: Check Formatting + name: Tidy Code runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 @@ -21,11 +21,17 @@ jobs: with: rust-version: stable components: rustfmt + - uses: taiki-e/install-action@v2 + with: + tool: typos-cli - name: Check Formatting run: cargo fmt --all -- --check + - name: Run Typos + run: typos tests: name: Tests + needs: fmt # `raw-window-handle` only has `cfg` guards for Android, so we just run Ubuntu # and manually test Android runs-on: ubuntu-latest diff --git a/src/lib.rs b/src/lib.rs index ef3871b..558800a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -159,7 +159,7 @@ pub enum RawWindowHandle { /// /// ## Availability Hints /// This variant is present regardless of windowing backend and likely to be used with - /// EGL_MESA_platfrom_gbm or EGL_KHR_platfrom_gbm. + /// EGL_MESA_platform_gbm or EGL_KHR_platform_gbm. Gbm(GbmWindowHandle), /// A raw window handle for Win32. ///