.woodpecker/.validate.yaml

@@ -14,6 +14,13 @@ steps:
     # Not ready to block PR on fail
     failure: ignore
 
+  - name: lint - spellcheck
+    image: rust:1.86
+    commands: |
+      apt update && apt install -y libclang-dev hunspell
+      cargo install --locked cargo-spellcheck
+      cargo spellcheck
+
   - name: lint - dependencies
     image: rust:1.86
     commands: |

Cargo.toml

@@ -7,6 +7,9 @@ license = "AGPL-3.0-or-later"
 [features]
 default = []
 
+[package.metadata.spellcheck]
+config = "./spellcheck.toml"
+
 [dependencies]
 # Errors
 anyhow = "1.0.75"

README.md

@@ -14,8 +14,8 @@ reinvent the wheel. This solution provides:
 - [Open-source protocol](https://spec.matrix.org/v1.9/).
 - Features expected for a messaging solution in 2024 (multi-devices management, emojis, integrations, redaction,
   spaces, ...).
-- Multi-platforms clients (Android, iOS and Webclient).
-- SDK available for each platform and a new Rust sdk supporting all the previously listed platforms.
+- Multi-platforms clients (Android, iOS and web-client).
+- SDK available for each platform and a new Rust SDK supporting all the previously listed platforms.
 - Conference stack ([Element Call](https://github.com/element-hq/element-call)).
 - End-to-end encryption.
 - Federation management.
@@ -28,16 +28,16 @@ API)](https://spec.matrix.org/v1.9/client-server-api/) protocol.
 
 Even if the Rust SDK is still in beta, it seems to be the future one (cf. [Element X - experience the future of
 Element!](https://element.io/blog/element-x-experience-the-future-of-element/)) and a good choice for someone starting a
-new client... from my point of vue.
+new client... from my point of view.
 
-The SDK choosen, a Rust (to avoid to use the bindings provided by the matrix-rust-sdk and mostly because I want to
+The SDK chosen, a Rust (to avoid to use the bindings provided by the matrix-rust-sdk and mostly because I want to
 learn Rust) graphical library should be selected. The [Dioxus](https://dioxuslabs.com/) one seems to do the job:
 
 - React-inspired library for Rust.
-- Multi-platforms (use of Webview or WGPU-enabled renderers).
+- Multi-platforms (use of Web-view or WGPU-enabled renderers).
 
 # TODO
 
 - [ ] Test dioxus-radio.
 - [ ] Design system ?
-- [ ] Implement MSN messenger features using Matrix.org sdk...
+- [ ] Implement MSN messenger features using Matrix.org SDK...

spellcheck.dic

@@ -0,0 +1,6 @@
+5
+Dioxus
+MSN
+renderers
+SDK
+TODO

spellcheck.toml

@@ -0,0 +1,10 @@
+# Also take into account developer comments
+dev_comments = false
+
+# Skip the README.md file as defined in the cargo manifest
+skip_readme = false
+
+[Hunspell]
+lang = "en_US"
+search_dirs = [ "." ]
+extra_dictionaries = [ "./spellcheck.dic" ]