Add typos workflow (#1153)

* Add typos workflow

* Fix remaining typos manually

Author: Hofer-Julian

.github/workflows/typos.yml

@@ -0,0 +1,15 @@
+name: CI
+on:
+  pull_request:
+  push:
+    branches:
+      - "master"
+jobs:
+  typos:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v3
+      - name: Check spelling
+        uses: crate-ci/typos@master

.typos.toml

@@ -0,0 +1,16 @@
+[files]
+extend-exclude = ["auto", "sys", "gobject-sys", "*.svg"]
+
+[default.extend-words]
+# Ignore false-positives
+gir = "gir"
+mak = "mak"
+anid = "anid"
+lamda = "lamda"
+inout = "inout"
+relm = "relm"
+ba = "ba"
+ue = "ue"
+ot = "ot"
+siz = "siz"
+vai = "vai"

examples/gio_task/main.rs

@@ -31,7 +31,7 @@ fn main() {
     main_loop.run();
 }
 
-// This function mimicks what the C code using the exported async/finish API would do. It first defines a
+// This function mimics what the C code using the exported async/finish API would do. It first defines a
 // callback of type GAsyncResult that internally calls get_file_size_finish to retrieve the Task
 // result, and simply prints it out. Then it invokes the my_file_size_get_file_size_async method, passing the
 // callback to it as parameter.

gio/Gir.toml

@@ -398,7 +398,7 @@ manual_traits = ["CancellableExtManual"]
     ignore = true
     [[object.function]]
     name = "source_new"
-    # Only for use with other souce implementations
+    # Only for use with other source implementations
     ignore = true
     [[object.signal]]
     name = "cancelled"
@@ -491,7 +491,7 @@ generate_builder = true
 
     [[object.function]]
     name = "read_line_utf8"
-    #redudant length returned
+    #redundant length returned
     manual = true
 
     [[object.function]]
@@ -1022,11 +1022,11 @@ name = "Gio.MenuAttributeIter"
 status = "generate"
     [[object.function]]
     name = "get_name"
-    # Users shoud use `next` (automatically renamed from `get_next`).
+    # Users should use `next` (automatically renamed from `get_next`).
     ignore= true
     [[object.function]]
     name = "get_value"
-    # Users shoud use `next` (automatically renamed from `get_next`).
+    # Users should use `next` (automatically renamed from `get_next`).
     ignore= true
     [[object.function]]
     name = "next"
@@ -1040,11 +1040,11 @@ name = "Gio.MenuLinkIter"
 status = "generate"
     [[object.function]]
     name = "get_name"
-    # Users shoud use `next` (automatically renamed from `get_next`).
+    # Users should use `next` (automatically renamed from `get_next`).
     ignore= true
     [[object.function]]
     name = "get_value"
-    # Users shoud use `next` (automatically renamed from `get_next`).
+    # Users should use `next` (automatically renamed from `get_next`).
     ignore= true
     [[object.function]]
     name = "next"

glib-macros/src/downgrade_derive/fields.rs

@@ -66,8 +66,8 @@ pub struct DowngradeStructParts {
 /// let Named { ref x, ref y } = <expression>;
 ///
 /// match <expression> {
-///     Choise::This (ref _0, ref _1) => ... ,
-///     Choise::That { ref x, ref y } => ... ,
+///     Choice::This (ref _0, ref _1) => ... ,
+///     Choice::That { ref x, ref y } => ... ,
 /// }
 /// ```
 ///

glib-macros/src/lib.rs

@@ -545,7 +545,7 @@ pub fn error_domain_derive(input: TokenStream) -> TokenStream {
 
 /// Derive macro for defining a [`BoxedType`]`::type_` function and
 /// the [`glib::Value`] traits. Optionally, the type can be marked as
-/// `nullable` to get an implemention of `glib::value::ToValueOptional`.
+/// `nullable` to get an implementation of `glib::value::ToValueOptional`.
 ///
 /// # Example
 ///
@@ -574,7 +574,7 @@ pub fn boxed_derive(input: TokenStream) -> TokenStream {
 
 /// Derive macro for defining a [`SharedType`]`::get_type` function and
 /// the [`glib::Value`] traits. Optionally, the type can be marked as
-/// `nullable` to get an implemention of `glib::value::ToValueOptional`.
+/// `nullable` to get an implementation of `glib::value::ToValueOptional`.
 ///
 /// # Example
 ///

glib-macros/src/properties.rs

@@ -288,7 +288,7 @@ impl PropDesc {
         });
         let ty = ty.unwrap_or_else(|| field_ty.clone());
 
-        // Now that everything is set and safe, return the final proprety description
+        // Now that everything is set and safe, return the final property description
         Ok(Self {
             attrs_span,
             field_ident,

glib/Gir.toml

@@ -89,7 +89,7 @@ status = "generate"
     ignore = true # needs manual wrappers to make their usage nicer
     [[object.function]]
     pattern = "compute_.*_for_string"
-    ignore = true # needs manual wrapper to avoid an unecessary copy of the string
+    ignore = true # needs manual wrapper to avoid an unnecessary copy of the string
     [[object.function]]
     pattern = "(idle_remove_by_data|qsort_with_data)"
     ignore = true # Unsafe functions

glib/src/gobject/binding_group.rs

@@ -188,7 +188,7 @@ impl<'a> BindingGroupBuilder<'a> {
             let _ = Box::from_raw(data as *mut (TransformFn, TransformFn, String, ParamSpec));
         }
 
-        let mut _source_propery_name_cstr = None;
+        let mut _source_property_name_cstr = None;
         let source_property_name = if let Some(source) = self.group.source() {
             let source_property = source.find_property(self.source_property).ok_or_else(|| {
                 bool_error!(
@@ -198,13 +198,13 @@ impl<'a> BindingGroupBuilder<'a> {
                 )
             })?;
 
-            // This is NUL-termianted from the C side
+            // This is NUL-terminated from the C side
             source_property.name().as_ptr()
         } else {
             // This is a Rust &str and needs to be NUL-terminated first
-            let source_propery_name = std::ffi::CString::new(self.source_property).unwrap();
-            let source_property_name_ptr = source_propery_name.as_ptr() as *const u8;
-            _source_propery_name_cstr = Some(source_propery_name);
+            let source_property_name = std::ffi::CString::new(self.source_property).unwrap();
+            let source_property_name_ptr = source_property_name.as_ptr() as *const u8;
+            _source_property_name_cstr = Some(source_property_name);
 
             source_property_name_ptr
         };

glib/src/log.rs

@@ -378,7 +378,7 @@ impl<'a> LogField<'a> {
     // rustdoc-stripper-ignore-next
     /// Creates a field with an empty value and `data` as a user data key. Fields created with this
     /// function are ignored by the default log writer. These fields are used to pass custom data
-    /// into a writer function set with [`log_set_writer_func`], where it can be retreived using
+    /// into a writer function set with [`log_set_writer_func`], where it can be retrieved using
     /// [`Self::user_data`].
     ///
     /// The passed `usize` can be used by the log writer as a key into a static data structure.
@@ -395,7 +395,7 @@ impl<'a> LogField<'a> {
         )
     }
     // rustdoc-stripper-ignore-next
-    /// Retreives the field key.
+    /// Retrieves the field key.
     pub fn key(&self) -> &str {
         unsafe { std::ffi::CStr::from_ptr(self.0.key as *const _) }
             .to_str()