ci: fix a few typos and add check

Kijewski · Kijewski · commit 80427e9e52d5 · 2024-08-30T16:13:39.000+02:00
This PR adds `_typos.toml`, which lets `typos` ignore generated data.
Some filler texts are "fixed", too. It does not matter what the actual
text is.
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -179,3 +179,9 @@ jobs:
         working-directory: fuzzing
         env:
           RUSTFLAGS: '-Ctarget-feature=-crt-static'
+
+  Typos:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: crate-ci/typos@v1
diff --git a/_typos.toml b/_typos.toml
@@ -0,0 +1,23 @@
+[default]
+locale = "en-us"
+
+[files]
+extend-exclude = [
+    # generated files
+    "book/ethicalads-theme.css",
+    "fuzzing/fuzz/artifacts/",
+    "fuzzing/fuzz/corpus/",
+    "target/",
+    # too many false positives
+    "testing/tests/gen_ws_tests.py",
+]
+
+[default.extend-words]
+# French words
+exemple = "exemple"
+existant = "existant"
+# fillter words
+Ba = "Ba"
+fo = "fo"
+Fo = "Fo"
+sur = "sur"
diff --git a/book/src/configuration.md b/book/src/configuration.md
@@ -54,7 +54,7 @@ Hello
 To be noted, if one of the trimmed characters is a newline, then the only
 character remaining will be a newline.
 
-If you want this to be the default behaviour, you can set `whitespace` to
+If you want this to be the default behavior, you can set `whitespace` to
 `"minimize"`.
 
 To be noted: you can also configure `whitespace` directly into the `template`
diff --git a/book/src/template_syntax.md b/book/src/template_syntax.md
@@ -196,7 +196,7 @@ struct MyTemplate {
 
 However, since we'll need to define this function every time we create an
 instance of `MyTemplate`, it's probably not the most ideal way to associate
-some behaviour for our template.
+some behavior for our template.
 
 ### Static functions
 
diff --git a/examples/actix-web-app/src/main.rs b/examples/actix-web-app/src/main.rs
@@ -55,7 +55,7 @@ enum Error {
 ///
 /// The same type is used by actix-web as part of the URL, and in rinja to select what content to
 /// show, and also as an HTML attribute in `<html lang=`. To make it possible to use the same type
-/// for three diffent use cases, we use a few derive macros:
+/// for three different use cases, we use a few derive macros:
 ///
 ///  * `Default` to have a default/fallback language.
 ///  * `Debug` is not strictly needed, but it might aid debugging.
@@ -105,7 +105,7 @@ async fn not_found_handler(req: HttpRequest) -> Result<impl Responder> {
     }
 }
 
-/// The is first page your user hits does not contain language infomation, so we redirect them
+/// The is first page your user hits does not contain language information, so we redirect them
 /// to a URL that does contain the default language.
 #[get("/")]
 async fn start_handler(req: HttpRequest) -> Result<impl Responder> {
@@ -139,7 +139,7 @@ async fn index_handler(
     // `{% if lang !=`, the former to select the text of a specific language, e.g. in the `<title>`;
     // and the latter to display references to all other available languages except the currently
     // selected one.
-    // The field `name` will contain the value of the query paramater of the same name.
+    // The field `name` will contain the value of the query parameter of the same name.
     // In `IndexHandlerQuery` we annotated the field with `#[serde(default)]`, so if the value is
     // absent, an empty string is selected by default, which is visible to the user an empty
     // `<input type="text" />` element.
diff --git a/rinja/benches/escape.rs b/rinja/benches/escape.rs
@@ -13,7 +13,7 @@ fn escaping(b: &mut criterion::Bencher<'_>) {
     Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris consequat tellus sit
     amet ornare fermentum. Etiam nec erat ante. In at metus a orci mollis scelerisque.
     Sed eget ultrices turpis, at sollicitudin erat. Integer hendrerit nec magna quis
-    venenatis. Vivamus non dolor hendrerit, vulputate velit sed, varius nunc. Quisque
+    venenatis. Vivamus non dolor hendrerit, vulputate velit sed, various nunc. Quisque
     in pharetra mi. Sed ullamcorper nibh malesuada commodo porttitor. Ut scelerisque
     sodales felis quis dignissim. Morbi aliquam finibus justo, sit amet consectetur
     mauris efficitur sit amet. Donec posuere turpis felis, eu lacinia magna accumsan
@@ -34,12 +34,12 @@ fn escaping(b: &mut criterion::Bencher<'_>) {
     facilisis sed nibh. Aenean auctor magna sem, id rutrum metus convallis quis. Nullam non arcu
     dictum, lobortis erat quis, rhoncus est. Suspendisse venenatis, mi sed venenatis vehicula,
     tortor dolor egestas lectus, et efficitur turpis odio non augue. Integer velit sapien, dictum
-    non egestas vitae, hendrerit sed quam. Phasellus a nunc eu erat varius imperdiet. Etiam id
+    non egestas vitae, hendrerit sed quam. Phasellus a nunc eu erat various imperdiet. Etiam id
     sollicitudin turpis, vitae molestie orci. Quisque ornare magna quis metus rhoncus commodo.
     Phasellus non mauris velit.
 </p>
 <p>
-    Etiam dictum tellus ipsum, nec varius quam ornare vel. Cras vehicula diam nec sollicitudin
+    Etiam dictum tellus ipsum, nec various quam ornare vel. Cras vehicula diam nec sollicitudin
     ultricies. Pellentesque rhoncus sagittis nisl id facilisis. Nunc viverra convallis risus ut
     luctus. Aliquam vestibulum <b>efficitur massa</b>, id tempus nisi posuere a. Aliquam scelerisque
     elit justo. Nullam a ante felis. Cras vitae lorem eu nisi feugiat hendrerit. Maecenas vitae
diff --git a/rinja/benches/to-json.rs b/rinja/benches/to-json.rs
@@ -72,7 +72,7 @@ const STRING_LONG: &str = r#"
 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris consequat tellus sit
 amet ornare fermentum. Etiam nec erat ante. In at metus a orci mollis scelerisque.
 Sed eget ultrices turpis, at sollicitudin erat. Integer hendrerit nec magna quis
-venenatis. Vivamus non dolor hendrerit, vulputate velit sed, varius nunc. Quisque
+venenatis. Vivamus non dolor hendrerit, vulputate velit sed, various nunc. Quisque
 in pharetra mi. Sed ullamcorper nibh malesuada commodo porttitor. Ut scelerisque
 sodales felis quis dignissim. Morbi aliquam finibus justo, sit amet consectetur
 mauris efficitur sit amet. Donec posuere turpis felis, eu lacinia magna accumsan
@@ -93,12 +93,12 @@ ac risus vitae sem molestie ullamcorper. Curabitur ligula augue, sollicitudin qu
 facilisis sed nibh. Aenean auctor magna sem, id rutrum metus convallis quis. Nullam non arcu
 dictum, lobortis erat quis, rhoncus est. Suspendisse venenatis, mi sed venenatis vehicula,
 tortor dolor egestas lectus, et efficitur turpis odio non augue. Integer velit sapien, dictum
-non egestas vitae, hendrerit sed quam. Phasellus a nunc eu erat varius imperdiet. Etiam id
+non egestas vitae, hendrerit sed quam. Phasellus a nunc eu erat various imperdiet. Etiam id
 sollicitudin turpis, vitae molestie orci. Quisque ornare magna quis metus rhoncus commodo.
 Phasellus non mauris velit.
 </p>
 <p>
-Etiam dictum tellus ipsum, nec varius quam ornare vel. Cras vehicula diam nec sollicitudin
+Etiam dictum tellus ipsum, nec various quam ornare vel. Cras vehicula diam nec sollicitudin
 ultricies. Pellentesque rhoncus sagittis nisl id facilisis. Nunc viverra convallis risus ut
 luctus. Aliquam vestibulum <b>efficitur massa</b>, id tempus nisi posuere a. Aliquam scelerisque
 elit justo. Nullam a ante felis. Cras vitae lorem eu nisi feugiat hendrerit. Maecenas vitae
diff --git a/rinja_derive/src/config.rs b/rinja_derive/src/config.rs
@@ -337,7 +337,7 @@ impl RawConfig<'_> {
 #[cfg_attr(feature = "config", derive(Deserialize))]
 #[cfg_attr(feature = "config", serde(field_identifier, rename_all = "lowercase"))]
 pub(crate) enum WhitespaceHandling {
-    /// The default behaviour. It will leave the whitespace characters "as is".
+    /// The default behavior. It will leave the whitespace characters "as is".
     #[default]
     Preserve,
     /// It'll remove all the whitespace characters before and after the jinja block.
diff --git a/rinja_derive/src/input.rs b/rinja_derive/src/input.rs
@@ -433,7 +433,7 @@ impl TemplateArgs {
     }
 }
 
-/// Try to find the souce in the comment, in a `rinja` code block.
+/// Try to find the source in the comment, in a `rinja` code block.
 ///
 /// This is only done if no path or source was given in the `#[template]` attribute.
 fn source_from_docs(

Original file line number	Diff line number	Diff line change
`@@ -433,7 +433,7 @@ impl TemplateArgs {`
`433`	`433`	`}`
`434`	`434`	`}`
`435`	`435`
`436`		-/// Try to find the souce in the comment, in a `rinja` code block.
	`436`	+/// Try to find the source in the comment, in a `rinja` code block.
`437`	`437`	`///`
`438`	`438`	/// This is only done if no path or source was given in the `#[template]` attribute.
`439`	`439`	`fn source_from_docs(`