Add spell checking to CI (#1492)

* Add spell checking to CI

* Fix a bunch of typos with `typos -w`

* Manually fix some more typos

* document how to run typos locally

* fix doclink

Author: emilk

.github/workflows/typos.yml

@@ -0,0 +1,16 @@
+# https://github.com/crate-ci/typos
+# Add exceptions to _typos.toml
+
+name: Spell Check
+on: [pull_request]
+
+jobs:
+  run:
+    name: Spell Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v2
+
+      - name: Check spelling of entire workspace
+        uses: crate-ci/typos@master

_typos.toml

@@ -0,0 +1,6 @@
+# https://github.com/crate-ci/typos
+# install:  cargo install typos-cli
+# run:      typos
+
+[default.extend-words]
+lod = "lod" # level-of-detail

ci_docker/publish.sh

@@ -1,6 +1,6 @@
 VERSION=0.5 # Bump on each new version. Remember to update the version in the Dockerfile too.
 
-# The build needs to run from top of repo to access the requirments.txt
+# The build needs to run from top of repo to access the requirements.txt
 cd `git rev-parse --show-toplevel`
 
 # Pull :latest so we have the correct cache

clippy.toml

@@ -19,9 +19,9 @@ disallowed-methods = [
   "std::env::temp_dir", # Use the tempdir crate instead
 
   # Disabled because of https://github.com/rust-lang/rust-clippy/issues/10406
-  #   "std::time::Instant::now",      # use `instant` crate instead for wasm/web compatability
-  "std::time::Duration::elapsed", # use `instant` crate instead for wasm/web compatability
-  "std::time::SystemTime::now",   # use `instant` or `time` crates instead for wasm/web compatability
+  #   "std::time::Instant::now",      # use `instant` crate instead for wasm/web compatibility
+  "std::time::Duration::elapsed", # use `instant` crate instead for wasm/web compatibility
+  "std::time::SystemTime::now",   # use `instant` or `time` crates instead for wasm/web compatibility
 
   "std::thread::spawn", # Use `std::thread::Builder` and name the thread
 

crates/re_analytics/Cargo.toml

@@ -36,7 +36,7 @@ uuid = { version = "1.1", features = ["serde", "v4", "js"] }
 directories-next = "2"
 ureq = { version = "2.6", features = [
   "json",
-] } # TODO(emilk): use ehttp for web supprt
+] } # TODO(emilk): use ehttp for web support
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 web-sys = { version = "0.3.58", features = ["Storage"] }

crates/re_analytics/src/pipeline_native.rs

@@ -298,7 +298,7 @@ fn flush_events(
                 match serde_json::from_str::<Event>(&event_str) {
                     Ok(event) => Some(event),
                     Err(err) => {
-                        // NOTE: This is effectively where we detect posssible half-writes.
+                        // NOTE: This is effectively where we detect possible half-writes.
                         error!(%err, %analytics_id, %session_id,
                             "couldn't deserialize event from analytics data file: dropping it");
                         None

crates/re_arrow_store/src/store.rs

@@ -1222,7 +1222,7 @@ pub struct ComponentTable {
     /// Component buckets are append-only, they can never be written to in an out of order
     /// fashion.
     /// As such, a double-ended queue covers all our needs:
-    /// - poping from the front for garbage collection
+    /// - popping from the front for garbage collection
     /// - pushing to the back for insertions
     /// - binary search for queries
     pub(crate) buckets: VecDeque<ComponentBucket>,

crates/re_arrow_store/src/store_write.rs

@@ -656,7 +656,7 @@ impl IndexBucket {
             indices,
         } = &mut *guard;
 
-        // append time to primary index and update time range approriately
+        // append time to primary index and update time range appropriately
         times.push(time.as_i64());
         *time_range = TimeRange::new(time_range.min.min(time), time_range.max.max(time));
 
@@ -1220,7 +1220,7 @@ impl ComponentBucket {
 
         debug_assert!(
             !self.archived,
-            "achiving an already archived bucket, something is likely wrong"
+            "archiving an already archived bucket, something is likely wrong"
         );
 
         // Chunk compaction

crates/re_arrow_store/tests/data_store.rs

@@ -153,7 +153,7 @@ fn all_components() {
 
         let components_b = &[
             ColorRGBA::name(), // added by us, timeless
-            Rect2D::name(),    // ⚠ inherited before the buckets got splitted apart!
+            Rect2D::name(),    // ⚠ inherited before the buckets got split apart!
             Point2D::name(),   // added by us
             cluster_key,       // always here
             MsgId::name(),     // automatically appended by MsgBundle

crates/re_build_info/src/buid_info.rs crates/re_build_info/src/build_info.rscrates/re_build_info/src/buid_info.rs renamed to crates/re_build_info/src/build_info.rs

@@ -1,6 +1,6 @@
 /// Information about the build of a Rust crate.
 ///
-/// Create this with [`crate::build_info`].
+/// Create this with [`crate::build_info!`].
 ///
 /// The `git_` fields are all empty on failure. Most likely git fails because we're not in a git repository
 /// to begin with, which happens because we've imported the published crate from crates.io.