Merge pull request #181 from influxdata/crepererum/spellcheck

chore: catch typos

Author: crepererum

.github/workflows/ci.yml

@@ -51,10 +51,10 @@ jobs:
       - name: Install `yamllint`
         run: pip install --requirement=.github/workflows/requirements.txt
 
-      - name: Install `cargo-deny` & `just`
+      - name: Install `cargo-deny` & `just` & 'typos'
         uses: taiki-e/install-action@44c6d64aa62cd779e873306675c7a58e86d6d532  # v2
         with:
-          tool: cargo-deny,just
+          tool: cargo-deny,just,typos
 
       - name: Install `tombi`
         uses: tombi-toml/setup-tombi@a9378ac9fe5c29df7d26263deacea4ac642af9c2  # v1

CONTRIBUTING.md

@@ -28,6 +28,9 @@ Install [Python] to set up the environment for the [Python] guest.
 ### Tombi
 Install [tombi] to format and lint [TOML] files.
 
+### Spellcheck
+Install [typos] to run an automatic spellcheck.
+
 
 ## Checks
 There is one "run everything" [just] recipe:
@@ -112,4 +115,5 @@ Then the [Python Standard Library] was not found or not bundled correctly. You m
 [rustup]: https://rustup.rs/
 [tombi]: https://tombi-toml.github.io/tombi
 [TOML]: https://toml.io/
+[typos]: https://github.com/crate-ci/typos
 [yamllint]: https://github.com/adrienverge/yamllint

Justfile

@@ -52,6 +52,12 @@ check-rust-deny:
 # run ALL Rust checks
 check-rust: check-rust-fmt check-rust-check check-rust-build check-rust-clippy check-rust-test check-rust-doc check-rust-bench check-rust-deny
 
+# check spelling
+check-spelling:
+    @echo ::group::check-spelling
+    typos
+    @echo ::endgroup::
+
 # check TOML formatting
 check-toml-fmt:
     @echo ::group::check-toml-fmt
@@ -74,7 +80,7 @@ check-yaml:
     @echo ::endgroup::
 
 # run ALL checks
-check: check-rust check-toml check-yaml
+check: check-rust check-spelling check-toml check-yaml
 
 # clean Rust build artifacts
 clean-rust:
@@ -106,6 +112,12 @@ fix-rust-fmt:
 # fix common Rust issues automatically
 fix-rust: fix-rust-clippy fix-rust-check fix-rust-fmt
 
+# fix typos
+fix-spellcheck:
+    @echo ::group::fix-rust-fmt
+    typos --write-changes
+    @echo ::endgroup::
+
 # fix TOML formatting
 fix-toml-fmt:
     @echo ::group::fix-toml-fmt
@@ -116,4 +128,4 @@ fix-toml-fmt:
 fix-toml: fix-toml-fmt
 
 # fix common issues automatically
-fix: fix-rust fix-toml
+fix: fix-spellcheck fix-rust fix-toml

guests/evil/src/fs.rs

@@ -1,4 +1,4 @@
-//! Payload that interact with the (virtual) file sytem.
+//! Payload that interact with the (virtual) file system.
 use std::{hash::Hash, sync::Arc};
 
 use arrow::{array::StringArray, datatypes::DataType};

guests/python/src/error.rs

@@ -58,7 +58,7 @@ pub(crate) trait PyErrExt {
     /// try:
     ///     my_fn(...)
     /// except Exception as e:
-    ///     raise Excpetion("foo") from e
+    ///     raise Exception("foo") from e
     /// ```
     ///
     ///

guests/python/src/inspect.rs

@@ -31,7 +31,7 @@ impl<'a, 'py> FromPyObject<'a, 'py> for PythonType {
         // https://docs.python.org/3/library/datetime.html
         let mod_datetime = py.import(intern!(py, "datetime"))?;
         let type_date = mod_datetime.getattr(intern!(py, "date"))?;
-        let type_dateime = mod_datetime.getattr(intern!(py, "datetime"))?;
+        let type_datetime = mod_datetime.getattr(intern!(py, "datetime"))?;
         let type_time = mod_datetime.getattr(intern!(py, "time"))?;
         let type_timedelta = mod_datetime.getattr(intern!(py, "timedelta"))?;
 
@@ -45,7 +45,7 @@ impl<'a, 'py> FromPyObject<'a, 'py> for PythonType {
             Ok(Self::Bytes)
         } else if ob.is(type_date) {
             Ok(Self::Date)
-        } else if ob.is(type_dateime) {
+        } else if ob.is(type_datetime) {
             Ok(Self::DateTime)
         } else if ob.is(type_float) {
             Ok(Self::Float)
@@ -107,7 +107,7 @@ impl<'a, 'py> FromPyObject<'a, 'py> for PythonNullableType {
 
             if args.len() != 1 {
                 return Err(PyErr::new::<PyTypeError, _>(format!(
-                    "only unions of form `T | None` are suppored, but got a union of {} distinct none-NULL types",
+                    "only unions of form `T | None` are supported, but got a union of {} distinct none-NULL types",
                     args.len()
                 )));
             }
@@ -156,7 +156,7 @@ impl<'a, 'py> FromPyObject<'a, 'py> for PythonFnSignature {
                 let kind_name = kind_name.to_str()?;
                 if (kind_name != "POSITIONAL_OR_KEYWORD") && (kind_name != "POSITIONAL_ONLY") {
                     return Err(PyErr::new::<PyTypeError, _>(
-                        format!("only paramters of kind `POSITIONAL_OR_KEYWORD` and `POSITIONAL_ONLY` are supported, got {kind_name}")
+                        format!("only parameters of kind `POSITIONAL_OR_KEYWORD` and `POSITIONAL_ONLY` are supported, got {kind_name}")
                     ));
                 }
 

guests/python/src/lib.rs

@@ -272,7 +272,7 @@ fn root() -> Option<Vec<u8>> {
 /// and will result in a "no-op"
 ///
 /// # Panic
-/// This assumes that the root file system contains the [Python Standard Library] or that the Python interpeter can
+/// This assumes that the root file system contains the [Python Standard Library] or that the Python interpreter can
 /// find it somewhere else (e.g. when executed outside of a WASM context).
 ///
 /// Otherwise this will likely panic and you find the following printed to stderr:

host/tests/integration_tests/python/argument_forms.rs

@@ -194,7 +194,7 @@ def foo(*x: int) -> int:
         @r"
     scalar_udfs
     caused by
-    Error during planning: TypeError: only paramters of kind `POSITIONAL_OR_KEYWORD` and `POSITIONAL_ONLY` are supported, got VAR_POSITIONAL
+    Error during planning: TypeError: only parameters of kind `POSITIONAL_OR_KEYWORD` and `POSITIONAL_ONLY` are supported, got VAR_POSITIONAL
 
     The above exception was the direct cause of the following exception:
 
@@ -216,7 +216,7 @@ def foo(*, x: int) -> int:
         @r"
     scalar_udfs
     caused by
-    Error during planning: TypeError: only paramters of kind `POSITIONAL_OR_KEYWORD` and `POSITIONAL_ONLY` are supported, got KEYWORD_ONLY
+    Error during planning: TypeError: only parameters of kind `POSITIONAL_OR_KEYWORD` and `POSITIONAL_ONLY` are supported, got KEYWORD_ONLY
 
     The above exception was the direct cause of the following exception:
 
@@ -238,7 +238,7 @@ def foo(**x: int) -> int:
         @r"
     scalar_udfs
     caused by
-    Error during planning: TypeError: only paramters of kind `POSITIONAL_OR_KEYWORD` and `POSITIONAL_ONLY` are supported, got VAR_KEYWORD
+    Error during planning: TypeError: only parameters of kind `POSITIONAL_OR_KEYWORD` and `POSITIONAL_ONLY` are supported, got VAR_KEYWORD
 
     The above exception was the direct cause of the following exception:
 

host/tests/integration_tests/python/inspection/errors.rs

@@ -80,7 +80,7 @@ def add_one(x: int | str) -> int:
         @r"
     scalar_udfs
     caused by
-    Error during planning: TypeError: only unions of form `T | None` are suppored, but got a union of 2 distinct none-NULL types
+    Error during planning: TypeError: only unions of form `T | None` are supported, but got a union of 2 distinct none-NULL types
 
     The above exception was the direct cause of the following exception:
 
@@ -105,7 +105,7 @@ def add_one(x: int | str | None) -> int:
         @r"
     scalar_udfs
     caused by
-    Error during planning: TypeError: only unions of form `T | None` are suppored, but got a union of 2 distinct none-NULL types
+    Error during planning: TypeError: only unions of form `T | None` are supported, but got a union of 2 distinct none-NULL types
 
     The above exception was the direct cause of the following exception:
 
@@ -130,7 +130,7 @@ def add_one(x: int | str | int) -> int:
         @r"
     scalar_udfs
     caused by
-    Error during planning: TypeError: only unions of form `T | None` are suppored, but got a union of 2 distinct none-NULL types
+    Error during planning: TypeError: only unions of form `T | None` are supported, but got a union of 2 distinct none-NULL types
 
     The above exception was the direct cause of the following exception:
 
@@ -155,7 +155,7 @@ def add_one(x: int | None | str | int) -> int:
         @r"
     scalar_udfs
     caused by
-    Error during planning: TypeError: only unions of form `T | None` are suppored, but got a union of 2 distinct none-NULL types
+    Error during planning: TypeError: only unions of form `T | None` are supported, but got a union of 2 distinct none-NULL types
 
     The above exception was the direct cause of the following exception:
 
@@ -180,7 +180,7 @@ def add_one(x: int | str | float) -> int:
         @r"
     scalar_udfs
     caused by
-    Error during planning: TypeError: only unions of form `T | None` are suppored, but got a union of 3 distinct none-NULL types
+    Error during planning: TypeError: only unions of form `T | None` are supported, but got a union of 3 distinct none-NULL types
 
     The above exception was the direct cause of the following exception:
 

typos.toml

@@ -0,0 +1,2 @@
+[default]
+locale = "en-us"