diff --git a/.cspell.json b/.cspell.json new file mode 100644 index 0000000..3bd5b21 --- /dev/null +++ b/.cspell.json @@ -0,0 +1,13 @@ +{ + "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json", + "version": "0.2", + "dictionaryDefinitions": [ + { + "name": "project-words", + "path": "./project-words.txt", + "addWords": true + } + ], + "dictionaries": ["project-words"], + "ignorePaths": ["/target", "/project-words.txt"] +} \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9caf99a..5a6e41c 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 @@ -23,9 +23,12 @@ jobs: components: rustfmt - name: Check Formatting run: cargo fmt --all -- --check + - name: Check Spelling + run: npx -y cspell --no-progress --no-summary '**/*.rs' '**/*.md' 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/CHANGELOG.md b/CHANGELOG.md index 6b439e5..3e8405e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -40,7 +40,7 @@ ## 0.4.1 (2021-11-19) -* Added an impl of `HasRawWindowHandle` for `&T`, `Rc`, and `Arc`. The impls for `Rc` and `Arc` require the `alloc` feature. +* Added an impl of `HasRawWindowHandle` for `&T`, `Rc`, and `Arc`. The implementations for `Rc` and `Arc` require the `alloc` feature. ## 0.4.0 (2021-11-15) diff --git a/project-words.txt b/project-words.txt new file mode 100644 index 0000000..0e04b5d --- /dev/null +++ b/project-words.txt @@ -0,0 +1,27 @@ +Borrowable +GWLP +HINSTANCE +HWND +Osspial +Winit +Xlib +alloc +appkit +bindgen +docsrs +fltk +glfw +glutin +hwnd +icrate +macabi +madsmtm +objc +orbclient +repr +structs +tvos +visualid +watchos +wgpu +xros 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. ///