Enable Codespell (#128)

* Enable Codespell

* Oops checkout code before spellchecking

* Only run tests once!

* Ignore juxt

* Learn to spell Cam!

* Fix spellings

Author: camsaul

.codespellignore

@@ -0,0 +1,3 @@
+edn
+juxt
+methodd

.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+skip = ./.git,./target,./.clj-kondo/.cache
+ignore-words = .codespellignore

.github/workflows/tests.yml

@@ -2,6 +2,8 @@ name: Tests
 
 on:
   push:
+    branches:
+      - master
   pull_request:
 
 jobs:
@@ -212,3 +214,11 @@ jobs:
       uses: codecov/codecov-action@v3
       with:
         files: ./target/coverage/codecov.json
+
+  codespell:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: codespell-project/actions-codespell@v1
+        with:
+          ignore_words_file: .codespellignore

codecov.yml

@@ -8,7 +8,7 @@ coverage:
       default:
         # Project must always have at least 80% coverage (by line)
         target: 80%
-        # Whole-project test coverage is allowed to drop up to 5%. (For situtations where we delete code with full coverage)
+        # Whole-project test coverage is allowed to drop up to 5%. (For situations where we delete code with full coverage)
         threshold: 5%
     patch:
       default:

scripts/lint-and-test.sh

@@ -2,8 +2,12 @@
 
 # This script is a convenience for running linters and tests without having to type in a bunch of nonsense.
 
+# switch to project root directory if we're not already there
+script_directory=`dirname "${BASH_SOURCE[0]}"`
+cd "$script_directory/.."
+
 set -euxo pipefail
 
-clj-kondo --parallel --lint src test toucan1/src/ toucan1/test/
+codespell
 
 clojure -X:dev:test $@

src/toucan2/execute.clj

@@ -113,7 +113,7 @@
 
 (defmacro with-call-count
   "Execute `body`, trackingthe number of database queries and statements executed. This number can be fetched at any
-  time withing `body` by calling function bound to `call-count-fn-binding`:
+  time within `body` by calling function bound to `call-count-fn-binding`:
 
   ```clj
   (with-call-count [call-count]

src/toucan2/log.clj

@@ -27,7 +27,7 @@
   nil)
 
 (defonce ^{:doc "The default log level to log messages directly to stdout with. Takes the value of the env var
-  `TOUCAN_DEBUG_LEVEL`, if set. Can be overriden with [[*level*]]. This is stored as an atom, so you can `swap!` or
+  `TOUCAN_DEBUG_LEVEL`, if set. Can be overridden with [[*level*]]. This is stored as an atom, so you can `swap!` or
   `reset!` it."} level
   (atom (some-> (env/env :toucan-debug-level) keyword)))
 

src/toucan2/map_backend/honeysql2.clj

@@ -37,7 +37,7 @@
 (defn condition->honeysql-where-clause
   "Something sequential like `:id [:> 5]` becomes `[:> :id 5]`. Other stuff like `:id 5` just becomes `[:= :id 5]`."
   [k v]
-  ;; don't think there's any situtation where `nil` on the LHS is on purpose and not a bug.
+  ;; don't think there's any situation where `nil` on the LHS is on purpose and not a bug.
   {:pre [(some? k)]}
   (if (sequential? v)
     (fn-condition->honeysql-where-clause k v)

toucan1/src/toucan/models.clj

@@ -327,7 +327,7 @@
   ```"
   [modelable]
   (let [model (model/resolve-model modelable)]
-    ;; programatically try all the hydration methods with `[:default <k>]` dispatch values and see which of them returns
+    ;; programmatically try all the hydration methods with `[:default <k>]` dispatch values and see which of them returns
     ;; our `model` when invoked. This is a totally wacky way of doing this. But it lets us introspect things even if
     ;; they weren't defined with [[define-hydration-keys]].
     (for [[dispatch-value f] (m/primary-methods hydrate/model-for-automagic-hydration)

toucan1/test/toucan/models_test.clj

@@ -414,16 +414,16 @@
   (test/with-discarded-table-changes Category
     (is (= true
            (t1.db/delete! Category :id 1)))
-    (is (= #{{:id 3, :name "resturaunt", :parent-category-id nil}
-             {:id 4, :name "mexican-resturaunt", :parent-category-id 3}}
+    (is (= #{{:id 3, :name "restaurant", :parent-category-id nil}
+             {:id 4, :name "mexican-restaurant", :parent-category-id 3}}
            (set (t1.db/select Category)))))
   (testing "shouldn't delete anything else if the Category is not parent of anybody else"
     (test/with-discarded-table-changes Category
       (is (= true
              (t1.db/delete! Category :id 2)))
       (is (= #{{:id 1, :name "bar", :parent-category-id nil}
-               {:id 3, :name "resturaunt", :parent-category-id nil}
-               {:id 4, :name "mexican-resturaunt", :parent-category-id 3}}
+               {:id 3, :name "restaurant", :parent-category-id nil}
+               {:id 4, :name "mexican-restaurant", :parent-category-id 3}}
              (set (t1.db/select Category)))))))
 
 ;; (def ^:private pre-deleted (atom []))