Add typos check to CI, fix extant typos. (#87)

Author: waywardmonkeys

.github/workflows/ci.yml

@@ -228,3 +228,12 @@ jobs:
       # We test documentation using nightly to match docs.rs. This prevents potential breakages
       - name: cargo doc
         run: cargo doc --workspace --locked --all-features --no-deps --document-private-items -Zunstable-options -Zrustdoc-scrape-examples
+
+  # If this fails, consider changing your text or adding something to .typos.toml
+  typos:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: check typos
+        uses: crate-ci/typos@v1.23.2

.typos.toml

@@ -0,0 +1,26 @@
+# See the configuration reference at
+# https://github.com/crate-ci/typos/blob/master/docs/reference.md
+
+# Corrections take the form of a key/value pair. The key is the incorrect word
+# and the value is the correct word. If the key and value are the same, the
+# word is treated as always correct. If the value is an empty string, the word
+# is treated as always incorrect.
+
+# Match Identifier - Case Sensitive
+[default.extend-identifiers]
+Beng = "Beng"
+Maka = "Maka"
+ot = "ot"
+ot_a = "ot_a"
+ot_b = "ot_b"
+wdth = "wdth"
+
+# Match Inside a Word - Case Insensitive
+[default.extend-words]
+
+[files]
+# Include .github, .cargo, etc.
+ignore-hidden = false
+# /.git isn't in .gitignore, because git never tracks it.
+# Typos doesn't know that, though.
+extend-exclude = ["/.git"]

README.md

@@ -58,7 +58,7 @@ This includes applying ligatures, resolving emoji modifiers, but also much more
 Swash's implementation is faster but less complete and tested than Harfbuzz and Rustybuzz.
 
 Swash also implements font parsing, scaling, and hinting.
-This part of Swash is now superseeded by Skrifa: the implementation in Skrifa is directly descended from the one in Swash.
+This part of Swash is now superseded by Skrifa: the implementation in Skrifa is directly descended from the one in Swash.
 
 ### Parley
 

parley/src/layout/line/greedy.rs

@@ -118,7 +118,7 @@ impl<'a, B: Brush> BreakLines<'a, B> {
         }
     }
 
-    /// Reset state when a line has been comitted
+    /// Reset state when a line has been committed
     fn start_new_line(&mut self) -> Option<(f32, f32)> {
         self.state.items = self.lines.line_items.len();
         self.state.lines = self.lines.lines.len();
@@ -319,7 +319,7 @@ impl<'a, B: Brush> BreakLines<'a, B> {
                                 // println!("REVERT");
                                 // debug_assert!(prev.state.x != 0.0);
 
-                                // Q: Why do we revert the line state here, but only revert the indexes if the commit suceeds?
+                                // Q: Why do we revert the line state here, but only revert the indexes if the commit succeeds?
                                 self.state.line = prev.state;
                                 if try_commit_line!(BreakReason::Regular) {
                                     // Revert boundary state to prev state
@@ -495,7 +495,7 @@ impl<'a, B: Brush> BreakLines<'a, B> {
                             continue;
                         }
 
-                        // Compute the run's advance by summing the advances of it's constituant clusters
+                        // Compute the run's advance by summing the advances of it's constituent clusters
                         line_item.advance = self.layout.clusters[line_item.cluster_range.clone()]
                             .iter()
                             .map(|c| c.advance)