Add spell checking (#180)

Electron100 · Jan 15, 2024 · c92ae21 · c92ae21
1 parent 4ea231b
commit c92ae21
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 8 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -29,6 +29,8 @@ jobs:
         sudo cat /etc/postgresql/14/main/pg_hba.conf
         sudo service postgresql restart && sleep 3
         echo BUTANE_PG_CONNSTR="host=localhost user=postgres sslmode=disable port=5432" >> $GITHUB_ENV
+    - name: Install Rust tools
+      run: cargo install typos-cli
     - name: Build
       run: make build
     - name: Lint

diff --git a/Makefile b/Makefile
@@ -15,7 +15,7 @@ lint :
 	$(CARGO) clippy --all-features -- -D warnings
 
 
-check : build test doclint lint
+check : build test doclint lint spellcheck
 
 
 test :
@@ -25,6 +25,9 @@ clean :
 	$(CARGO) clean
 
 
+spellcheck :
+	typos
+
 doclint :
 	RUSTDOCFLAGS="-D warnings" $(CARGO_NIGHTLY) doc --no-deps --all-features
 

diff --git a/butane_core/src/codegen/migration.rs b/butane_core/src/codegen/migration.rs
@@ -77,7 +77,7 @@ fn many_table(main_table_name: &str, many_field: &Field, pk_field: &Field) -> AT
         .expect("fields must be named")
         .to_string();
     let many_field_type = get_many_sql_type(many_field)
-        .unwrap_or_else(|| panic!("Mis-identified Many field {field_name}"));
+        .unwrap_or_else(|| panic!("Misidentified Many field {field_name}"));
     let pk_field_name = pk_field
         .ident
         .as_ref()

diff --git a/butane_core/src/codegen/mod.rs b/butane_core/src/codegen/mod.rs
@@ -338,7 +338,7 @@ fn is_row_field(f: &Field) -> bool {
 }
 
 /// Test if the ident of each segment in two paths is the same without
-/// looking at the argments
+/// looking at the arguments.
 fn is_same_path_ident(path1: &syn::Path, path2: &syn::Path) -> bool {
     if path1.segments.len() != path2.segments.len() {
         return false;

diff --git a/butane_core/tests/codegen.rs b/butane_core/tests/codegen.rs
@@ -20,21 +20,21 @@ fn make_litstr_from_str() {
 
 #[test]
 fn test_get_deferred_sql_type() {
-    // primative type
+    // primitive type
     let type_path: syn::TypePath = syn::parse_quote!(i8);
     let typ = syn::Type::Path(type_path);
     let rv = get_deferred_sql_type(&typ);
-    if let DeferredSqlType::KnownId(TypeIdentifier::Ty(sql_tye)) = rv {
-        assert_eq!(sql_tye, SqlType::Int);
+    if let DeferredSqlType::KnownId(TypeIdentifier::Ty(sql_type)) = rv {
+        assert_eq!(sql_type, SqlType::Int);
     } else {
         panic!()
     }
 
     let type_path: syn::TypePath = syn::parse_quote!(Option<i8>);
     let typ = syn::Type::Path(type_path);
     let rv = get_deferred_sql_type(&typ);
-    if let DeferredSqlType::KnownId(TypeIdentifier::Ty(sql_tye)) = rv {
-        assert_eq!(sql_tye, SqlType::Int);
+    if let DeferredSqlType::KnownId(TypeIdentifier::Ty(sql_type)) = rv {
+        assert_eq!(sql_type, SqlType::Int);
     } else {
         panic!()
     }