Skip to content

Commit a84fa6f

Browse files
GuillaumeGomezGuillaumeGomez
authored
Merge pull request #160 from Kijewski/pr-typos
ci: fix a few typos and add check
2 parents 06c21b5 + acd6a48 commit a84fa6f

File tree

10 files changed

+120
-128
lines changed

10 files changed

+120
-128
lines changed

‎.github/workflows/rust.yml

+6
Original file line numberDiff line numberDiff line change
@@ -179,3 +179,9 @@ jobs:
179179
working-directory: fuzzing
180180
env:
181181
RUSTFLAGS: '-Ctarget-feature=-crt-static'
182+
183+
Typos:
184+
runs-on: ubuntu-latest
185+
steps:
186+
- uses: actions/checkout@v4
187+
- uses: crate-ci/typos@master

‎_typos.toml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
[default]
2+
locale = "en-us"
3+
4+
[files]
5+
extend-exclude = [
6+
# generated files
7+
"book/ethicalads-theme.css",
8+
"fuzzing/fuzz/artifacts/",
9+
"fuzzing/fuzz/corpus/",
10+
"target/",
11+
"rinja_parser/tests/*.txt",
12+
# fillter texts
13+
"rinja/benches/strings.inc",
14+
# too many false positives
15+
"testing/tests/gen_ws_tests.py",
16+
]
17+
18+
[default.extend-words]
19+
# French words
20+
exemple = "exemple"
21+
existant = "existant"
22+
# used in tests
23+
Ba = "Ba"
24+
fo = "fo"
25+
Fo = "Fo"
26+
sur = "sur"

‎book/src/configuration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Hello
5454
To be noted, if one of the trimmed characters is a newline, then the only
5555
character remaining will be a newline.
5656

57-
If you want this to be the default behaviour, you can set `whitespace` to
57+
If you want this to be the default behavior, you can set `whitespace` to
5858
`"minimize"`.
5959

6060
To be noted: you can also configure `whitespace` directly into the `template`

‎book/src/template_syntax.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ struct MyTemplate {
196196

197197
However, since we'll need to define this function every time we create an
198198
instance of `MyTemplate`, it's probably not the most ideal way to associate
199-
some behaviour for our template.
199+
some behavior for our template.
200200

201201
### Static functions
202202

‎examples/actix-web-app/src/main.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ enum Error {
5555
///
5656
/// The same type is used by actix-web as part of the URL, and in rinja to select what content to
5757
/// show, and also as an HTML attribute in `<html lang=`. To make it possible to use the same type
58-
/// for three diffent use cases, we use a few derive macros:
58+
/// for three different use cases, we use a few derive macros:
5959
///
6060
/// * `Default` to have a default/fallback language.
6161
/// * `Debug` is not strictly needed, but it might aid debugging.
@@ -105,7 +105,7 @@ async fn not_found_handler(req: HttpRequest) -> Result<impl Responder> {
105105
}
106106
}
107107

108-
/// The is first page your user hits does not contain language infomation, so we redirect them
108+
/// The is first page your user hits does not contain language information, so we redirect them
109109
/// to a URL that does contain the default language.
110110
#[get("/")]
111111
async fn start_handler(req: HttpRequest) -> Result<impl Responder> {
@@ -139,7 +139,7 @@ async fn index_handler(
139139
// `{% if lang !=`, the former to select the text of a specific language, e.g. in the `<title>`;
140140
// and the latter to display references to all other available languages except the currently
141141
// selected one.
142-
// The field `name` will contain the value of the query paramater of the same name.
142+
// The field `name` will contain the value of the query parameter of the same name.
143143
// In `IndexHandlerQuery` we annotated the field with `#[serde(default)]`, so if the value is
144144
// absent, an empty string is selected by default, which is visible to the user an empty
145145
// `<input type="text" />` element.

‎rinja/benches/escape.rs

+6-61
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use criterion::{criterion_group, criterion_main, Criterion};
1+
use criterion::{black_box, criterion_group, criterion_main, Criterion};
22
use rinja::filters::{escape, Html};
33

44
criterion_main!(benches);
@@ -9,66 +9,11 @@ fn functions(c: &mut Criterion) {
99
}
1010

1111
fn escaping(b: &mut criterion::Bencher<'_>) {
12-
let string_long = r#"
13-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris consequat tellus sit
14-
amet ornare fermentum. Etiam nec erat ante. In at metus a orci mollis scelerisque.
15-
Sed eget ultrices turpis, at sollicitudin erat. Integer hendrerit nec magna quis
16-
venenatis. Vivamus non dolor hendrerit, vulputate velit sed, varius nunc. Quisque
17-
in pharetra mi. Sed ullamcorper nibh malesuada commodo porttitor. Ut scelerisque
18-
sodales felis quis dignissim. Morbi aliquam finibus justo, sit amet consectetur
19-
mauris efficitur sit amet. Donec posuere turpis felis, eu lacinia magna accumsan
20-
quis. Fusce egestas lacus vel fermentum tincidunt. Phasellus a nulla eget lectus
21-
placerat commodo at eget nisl. Fusce cursus dui quis purus accumsan auctor.
22-
Donec iaculis felis quis metus consectetur porttitor.
23-
<p>
24-
Etiam nibh mi, <b>accumsan</b> quis purus sed, posuere fermentum lorem. In pulvinar porta
25-
maximus. Fusce tincidunt lacinia tellus sit amet tincidunt. Aliquam lacus est, pulvinar
26-
non metus a, <b>facilisis</b> ultrices quam. Nulla feugiat leo in cursus eleifend. Suspendisse
27-
eget nisi ac justo sagittis interdum id a ipsum. Nulla mauris justo, scelerisque ac
28-
rutrum vitae, consequat vel ex.
29-
</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
30-
<p>
31-
Sed sollicitudin <b>sem</b> mauris, at rutrum nibh egestas vel. Ut eu nisi tellus. Praesent dignissim
32-
orci elementum, mattis turpis eget, maximus ante. Suspendisse luctus eu felis a tempor. Morbi
33-
ac risus vitae sem molestie ullamcorper. Curabitur ligula augue, sollicitudin quis maximus vel,
34-
facilisis sed nibh. Aenean auctor magna sem, id rutrum metus convallis quis. Nullam non arcu
35-
dictum, lobortis erat quis, rhoncus est. Suspendisse venenatis, mi sed venenatis vehicula,
36-
tortor dolor egestas lectus, et efficitur turpis odio non augue. Integer velit sapien, dictum
37-
non egestas vitae, hendrerit sed quam. Phasellus a nunc eu erat varius imperdiet. Etiam id
38-
sollicitudin turpis, vitae molestie orci. Quisque ornare magna quis metus rhoncus commodo.
39-
Phasellus non mauris velit.
40-
</p>
41-
<p>
42-
Etiam dictum tellus ipsum, nec varius quam ornare vel. Cras vehicula diam nec sollicitudin
43-
ultricies. Pellentesque rhoncus sagittis nisl id facilisis. Nunc viverra convallis risus ut
44-
luctus. Aliquam vestibulum <b>efficitur massa</b>, id tempus nisi posuere a. Aliquam scelerisque
45-
elit justo. Nullam a ante felis. Cras vitae lorem eu nisi feugiat hendrerit. Maecenas vitae
46-
suscipit leo, lacinia dignissim lacus. Sed eget volutpat mi. In eu bibendum neque. Pellentesque
47-
finibus velit a fermentum rhoncus. Maecenas leo purus, eleifend eu lacus a, condimentum sagittis
48-
justo.
49-
</p>"#;
50-
let string_short = "Lorem ipsum dolor sit amet,<foo>bar&foo\"bar\\foo/bar";
51-
let empty = "";
52-
let no_escape = "Lorem ipsum dolor sit amet,";
53-
let no_escape_long = r#"
54-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin scelerisque eu urna in aliquet.
55-
Phasellus ac nulla a urna sagittis consequat id quis est. Nullam eu ex eget erat accumsan dictum
56-
ac lobortis urna. Etiam fermentum ut quam at dignissim. Curabitur vestibulum luctus tellus, sit
57-
amet lobortis augue tempor faucibus. Nullam sed felis eget odio elementum euismod in sit amet massa.
58-
Vestibulum sagittis purus sit amet eros auctor, sit amet pharetra purus dapibus. Donec ornare metus
59-
vel dictum porta. Etiam ut nisl nisi. Nullam rutrum porttitor mi. Donec aliquam ac ipsum eget
60-
hendrerit. Cras faucibus, eros ut pharetra imperdiet, est tellus aliquet felis, eget convallis
61-
lacus ipsum eget quam. Vivamus orci lorem, maximus ac mi eget, bibendum vulputate massa. In
62-
vestibulum dui hendrerit, vestibulum lacus sit amet, posuere erat. Vivamus euismod massa diam,
63-
vulputate euismod lectus vestibulum nec. Donec sit amet massa magna. Nunc ipsum nulla, euismod
64-
quis lacus at, gravida maximus elit. Duis tristique, nisl nullam.
65-
"#;
66-
6712
b.iter(|| {
68-
format!("{}", escape(string_long, Html).unwrap());
69-
format!("{}", escape(string_short, Html).unwrap());
70-
format!("{}", escape(empty, Html).unwrap());
71-
format!("{}", escape(no_escape, Html).unwrap());
72-
format!("{}", escape(no_escape_long, Html).unwrap());
13+
for &s in black_box(STRINGS) {
14+
format!("{}", escape(s, Html).unwrap());
15+
}
7316
});
7417
}
18+
19+
const STRINGS: &[&str] = include!("strings.inc");

‎rinja/benches/strings.inc

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
{
2+
const STRING_LONG: &str = r#"
3+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris consequat tellus sit
4+
amet ornare fermentum. Etiam nec erat ante. In at metus a orci mollis scelerisque.
5+
Sed eget ultrices turpis, at sollicitudin erat. Integer hendrerit nec magna quis
6+
venenatis. Vivamus non dolor hendrerit, vulputate velit sed, varius nunc. Quisque
7+
in pharetra mi. Sed ullamcorper nibh malesuada commodo porttitor. Ut scelerisque
8+
sodales felis quis dignissim. Morbi aliquam finibus justo, sit amet consectetur
9+
mauris efficitur sit amet. Donec posuere turpis felis, eu lacinia magna accumsan
10+
quis. Fusce egestas lacus vel fermentum tincidunt. Phasellus a nulla eget lectus
11+
placerat commodo at eget nisl. Fusce cursus dui quis purus accumsan auctor.
12+
Donec iaculis felis quis metus consectetur porttitor.
13+
<p>
14+
Etiam nibh mi, <b>accumsan</b> quis purus sed, posuere fermentum lorem. In pulvinar porta
15+
maximus. Fusce tincidunt lacinia tellus sit amet tincidunt. Aliquam lacus est, pulvinar
16+
non metus a, <b>facilisis</b> ultrices quam. Nulla feugiat leo in cursus eleifend. Suspendisse
17+
eget nisi ac justo sagittis interdum id a ipsum. Nulla mauris justo, scelerisque ac
18+
rutrum vitae, consequat vel ex.
19+
</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
20+
<p>
21+
Sed sollicitudin <b>sem</b> mauris, at rutrum nibh egestas vel. Ut eu nisi tellus. Praesent dignissim
22+
orci elementum, mattis turpis eget, maximus ante. Suspendisse luctus eu felis a tempor. Morbi
23+
ac risus vitae sem molestie ullamcorper. Curabitur ligula augue, sollicitudin quis maximus vel,
24+
facilisis sed nibh. Aenean auctor magna sem, id rutrum metus convallis quis. Nullam non arcu
25+
dictum, lobortis erat quis, rhoncus est. Suspendisse venenatis, mi sed venenatis vehicula,
26+
tortor dolor egestas lectus, et efficitur turpis odio non augue. Integer velit sapien, dictum
27+
non egestas vitae, hendrerit sed quam. Phasellus a nunc eu erat varius imperdiet. Etiam id
28+
sollicitudin turpis, vitae molestie orci. Quisque ornare magna quis metus rhoncus commodo.
29+
Phasellus non mauris velit.
30+
</p>
31+
<p>
32+
Etiam dictum tellus ipsum, nec varius quam ornare vel. Cras vehicula diam nec sollicitudin
33+
ultricies. Pellentesque rhoncus sagittis nisl id facilisis. Nunc viverra convallis risus ut
34+
luctus. Aliquam vestibulum <b>efficitur massa</b>, id tempus nisi posuere a. Aliquam scelerisque
35+
elit justo. Nullam a ante felis. Cras vitae lorem eu nisi feugiat hendrerit. Maecenas vitae
36+
suscipit leo, lacinia dignissim lacus. Sed eget volutpat mi. In eu bibendum neque. Pellentesque
37+
finibus velit a fermentum rhoncus. Maecenas leo purus, eleifend eu lacus a, condimentum sagittis
38+
justo.
39+
</p>"#;
40+
41+
const STRING_SHORT: &str = "Lorem ipsum dolor sit amet,<foo>bar&foo\"bar\\foo/bar";
42+
43+
const EMPTY: &str = "";
44+
45+
const NO_ESCAPE: &str = "Lorem ipsum dolor sit amet,";
46+
47+
const NO_ESCAPE_LONG: &str = r#"
48+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin scelerisque eu urna in aliquet.
49+
Phasellus ac nulla a urna sagittis consequat id quis est. Nullam eu ex eget erat accumsan dictum
50+
ac lobortis urna. Etiam fermentum ut quam at dignissim. Curabitur vestibulum luctus tellus, sit
51+
amet lobortis augue tempor faucibus. Nullam sed felis eget odio elementum euismod in sit amet massa.
52+
Vestibulum sagittis purus sit amet eros auctor, sit amet pharetra purus dapibus. Donec ornare metus
53+
vel dictum porta. Etiam ut nisl nisi. Nullam rutrum porttitor mi. Donec aliquam ac ipsum eget
54+
hendrerit. Cras faucibus, eros ut pharetra imperdiet, est tellus aliquet felis, eget convallis
55+
lacus ipsum eget quam. Vivamus orci lorem, maximus ac mi eget, bibendum vulputate massa. In
56+
vestibulum dui hendrerit, vestibulum lacus sit amet, posuere erat. Vivamus euismod massa diam,
57+
vulputate euismod lectus vestibulum nec. Donec sit amet massa magna. Nunc ipsum nulla, euismod
58+
quis lacus at, gravida maximus elit. Duis tristique, nisl nullam.
59+
"#;
60+
61+
const STRINGS: &[&str] = &[
62+
STRING_LONG,
63+
STRING_SHORT,
64+
EMPTY,
65+
NO_ESCAPE,
66+
NO_ESCAPE_LONG,
67+
];
68+
STRINGS
69+
}

‎rinja/benches/to-json.rs

+6-60
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use criterion::{criterion_group, criterion_main, Criterion};
1+
use criterion::{black_box, criterion_group, criterion_main, Criterion};
22
use rinja::Template;
33

44
criterion_main!(benches);
@@ -18,7 +18,7 @@ fn escape_json(b: &mut criterion::Bencher<'_>) {
1818

1919
b.iter(|| {
2020
let mut len = 0;
21-
for &s in STRINGS {
21+
for &s in black_box(STRINGS) {
2222
len += Tmpl(s).to_string().len();
2323
}
2424
len
@@ -32,7 +32,7 @@ fn escape_json_pretty(b: &mut criterion::Bencher<'_>) {
3232

3333
b.iter(|| {
3434
let mut len = 0;
35-
for &s in STRINGS {
35+
for &s in black_box(STRINGS) {
3636
len += Tmpl(s).to_string().len();
3737
}
3838
len
@@ -46,7 +46,7 @@ fn escape_json_for_html(b: &mut criterion::Bencher<'_>) {
4646

4747
b.iter(|| {
4848
let mut len = 0;
49-
for &s in STRINGS {
49+
for &s in black_box(STRINGS) {
5050
len += Tmpl(s).to_string().len();
5151
}
5252
len
@@ -60,65 +60,11 @@ fn escape_json_for_html_pretty(b: &mut criterion::Bencher<'_>) {
6060

6161
b.iter(|| {
6262
let mut len = 0;
63-
for &s in STRINGS {
63+
for &s in black_box(STRINGS) {
6464
len += Tmpl(s).to_string().len();
6565
}
6666
len
6767
});
6868
}
6969

70-
const STRINGS: &[&str] = &[STRING_LONG, STRING_SHORT, EMPTY, NO_ESCAPE, NO_ESCAPE_LONG];
71-
const STRING_LONG: &str = r#"
72-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris consequat tellus sit
73-
amet ornare fermentum. Etiam nec erat ante. In at metus a orci mollis scelerisque.
74-
Sed eget ultrices turpis, at sollicitudin erat. Integer hendrerit nec magna quis
75-
venenatis. Vivamus non dolor hendrerit, vulputate velit sed, varius nunc. Quisque
76-
in pharetra mi. Sed ullamcorper nibh malesuada commodo porttitor. Ut scelerisque
77-
sodales felis quis dignissim. Morbi aliquam finibus justo, sit amet consectetur
78-
mauris efficitur sit amet. Donec posuere turpis felis, eu lacinia magna accumsan
79-
quis. Fusce egestas lacus vel fermentum tincidunt. Phasellus a nulla eget lectus
80-
placerat commodo at eget nisl. Fusce cursus dui quis purus accumsan auctor.
81-
Donec iaculis felis quis metus consectetur porttitor.
82-
<p>
83-
Etiam nibh mi, <b>accumsan</b> quis purus sed, posuere fermentum lorem. In pulvinar porta
84-
maximus. Fusce tincidunt lacinia tellus sit amet tincidunt. Aliquam lacus est, pulvinar
85-
non metus a, <b>facilisis</b> ultrices quam. Nulla feugiat leo in cursus eleifend. Suspendisse
86-
eget nisi ac justo sagittis interdum id a ipsum. Nulla mauris justo, scelerisque ac
87-
rutrum vitae, consequat vel ex.
88-
</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
89-
<p>
90-
Sed sollicitudin <b>sem</b> mauris, at rutrum nibh egestas vel. Ut eu nisi tellus. Praesent dignissim
91-
orci elementum, mattis turpis eget, maximus ante. Suspendisse luctus eu felis a tempor. Morbi
92-
ac risus vitae sem molestie ullamcorper. Curabitur ligula augue, sollicitudin quis maximus vel,
93-
facilisis sed nibh. Aenean auctor magna sem, id rutrum metus convallis quis. Nullam non arcu
94-
dictum, lobortis erat quis, rhoncus est. Suspendisse venenatis, mi sed venenatis vehicula,
95-
tortor dolor egestas lectus, et efficitur turpis odio non augue. Integer velit sapien, dictum
96-
non egestas vitae, hendrerit sed quam. Phasellus a nunc eu erat varius imperdiet. Etiam id
97-
sollicitudin turpis, vitae molestie orci. Quisque ornare magna quis metus rhoncus commodo.
98-
Phasellus non mauris velit.
99-
</p>
100-
<p>
101-
Etiam dictum tellus ipsum, nec varius quam ornare vel. Cras vehicula diam nec sollicitudin
102-
ultricies. Pellentesque rhoncus sagittis nisl id facilisis. Nunc viverra convallis risus ut
103-
luctus. Aliquam vestibulum <b>efficitur massa</b>, id tempus nisi posuere a. Aliquam scelerisque
104-
elit justo. Nullam a ante felis. Cras vitae lorem eu nisi feugiat hendrerit. Maecenas vitae
105-
suscipit leo, lacinia dignissim lacus. Sed eget volutpat mi. In eu bibendum neque. Pellentesque
106-
finibus velit a fermentum rhoncus. Maecenas leo purus, eleifend eu lacus a, condimentum sagittis
107-
justo.
108-
</p>"#;
109-
const STRING_SHORT: &str = "Lorem ipsum dolor sit amet,<foo>bar&foo\"bar\\foo/bar";
110-
const EMPTY: &str = "";
111-
const NO_ESCAPE: &str = "Lorem ipsum dolor sit amet,";
112-
const NO_ESCAPE_LONG: &str = r#"
113-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin scelerisque eu urna in aliquet.
114-
Phasellus ac nulla a urna sagittis consequat id quis est. Nullam eu ex eget erat accumsan dictum
115-
ac lobortis urna. Etiam fermentum ut quam at dignissim. Curabitur vestibulum luctus tellus, sit
116-
amet lobortis augue tempor faucibus. Nullam sed felis eget odio elementum euismod in sit amet massa.
117-
Vestibulum sagittis purus sit amet eros auctor, sit amet pharetra purus dapibus. Donec ornare metus
118-
vel dictum porta. Etiam ut nisl nisi. Nullam rutrum porttitor mi. Donec aliquam ac ipsum eget
119-
hendrerit. Cras faucibus, eros ut pharetra imperdiet, est tellus aliquet felis, eget convallis
120-
lacus ipsum eget quam. Vivamus orci lorem, maximus ac mi eget, bibendum vulputate massa. In
121-
vestibulum dui hendrerit, vestibulum lacus sit amet, posuere erat. Vivamus euismod massa diam,
122-
vulputate euismod lectus vestibulum nec. Donec sit amet massa magna. Nunc ipsum nulla, euismod
123-
quis lacus at, gravida maximus elit. Duis tristique, nisl nullam.
124-
"#;
70+
const STRINGS: &[&str] = include!("strings.inc");

‎rinja_derive/src/config.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ impl RawConfig<'_> {
337337
#[cfg_attr(feature = "config", derive(Deserialize))]
338338
#[cfg_attr(feature = "config", serde(field_identifier, rename_all = "lowercase"))]
339339
pub(crate) enum WhitespaceHandling {
340-
/// The default behaviour. It will leave the whitespace characters "as is".
340+
/// The default behavior. It will leave the whitespace characters "as is".
341341
#[default]
342342
Preserve,
343343
/// It'll remove all the whitespace characters before and after the jinja block.

‎rinja_derive/src/input.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ impl TemplateArgs {
433433
}
434434
}
435435

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.
437437
///
438438
/// This is only done if no path or source was given in the `#[template]` attribute.
439439
fn source_from_docs(

0 commit comments

Comments
 (0)