diff --git a/.github/workflows/typos.yml b/.github/workflows/typos.yml new file mode 100644 index 0000000..46f5458 --- /dev/null +++ b/.github/workflows/typos.yml @@ -0,0 +1,16 @@ +name: Typos + +on: + push: + branches: [main] + pull_request: + branches: [main] + +jobs: + typos: + name: Check for typos + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - uses: crate-ci/typos@v1.19.0 diff --git a/.typos.toml b/.typos.toml new file mode 100644 index 0000000..bc31e69 --- /dev/null +++ b/.typos.toml @@ -0,0 +1,9 @@ +[default] +extend-ignore-re = [ + "ff32ba0", +] + +[files] +extend-exclude = [ + "crates/aide/res/**/*.js", +] diff --git a/crates/aide/src/axum/mod.rs b/crates/aide/src/axum/mod.rs index b9cef20..df51617 100644 --- a/crates/aide/src/axum/mod.rs +++ b/crates/aide/src/axum/mod.rs @@ -713,7 +713,7 @@ mod private { pub trait Sealed {} } -/// A trait that extens [`axum::handler::Handler`] with API operation +/// A trait that extends [`axum::handler::Handler`] with API operation /// details. /// /// Just like axum's `Handler`, it is automatically implemented diff --git a/crates/aide/src/gen.rs b/crates/aide/src/gen.rs index 7b79914..20deafa 100644 --- a/crates/aide/src/gen.rs +++ b/crates/aide/src/gen.rs @@ -76,7 +76,7 @@ pub fn infer_responses(infer: bool) { }); } -/// Output all theoretically possbile error responses +/// Output all theoretically possible error responses /// including framework-specific ones. /// /// This is disabled by default. diff --git a/crates/aide/src/helpers/with_api.rs b/crates/aide/src/helpers/with_api.rs index 787c37a..a1641fb 100644 --- a/crates/aide/src/helpers/with_api.rs +++ b/crates/aide/src/helpers/with_api.rs @@ -61,7 +61,7 @@ use crate::{OperationInput, OperationOutput}; /// } /// ``` pub trait ApiOverride { - /// The type that is being overriden + /// The type that is being overridden type Target; } diff --git a/crates/axum-jsonschema/src/lib.rs b/crates/axum-jsonschema/src/lib.rs index 917cd1f..be19ee0 100644 --- a/crates/axum-jsonschema/src/lib.rs +++ b/crates/axum-jsonschema/src/lib.rs @@ -185,7 +185,7 @@ impl From for JsonSchemaErrorResponse { error: "deserialization failed".to_string(), extra: AdditionalError::Deserialization(DeserializationResponse { deserialization_error: VecDeque::from([PathError { - // keys and index seperated by a '/' + // keys and index separated by a '/' // enum is ignored because it doesn't exist in json instance_location: std::iter::once(String::new()) .chain(s.path().iter().map(|s| match s {