From 9269fe95970362453a14335ba7d08cc3d04489bd Mon Sep 17 00:00:00 2001
From: Phillip Alday <palday@users.noreply.github.com>
Date: Tue, 7 Nov 2023 22:25:56 +0000
Subject: [PATCH] spellcheck CI (#60)

* spellcheck CI

* typos
---
 .github/workflows/spellcheck.yml | 21 +++++++++++++++++++++
 _typos.toml                      | 25 +++++++++++++++++++++++++
 src/typical.jl                   |  2 +-
 3 files changed, 47 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/spellcheck.yml
 create mode 100644 _typos.toml

diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml
new file mode 100644
index 0000000..c38290a
--- /dev/null
+++ b/.github/workflows/spellcheck.yml
@@ -0,0 +1,21 @@
+# adapted from https://github.com/JuliaDocs/Documenter.jl/blob/master/.github/workflows/SpellCheck.yml
+# see docs at https://github.com/crate-ci/typos
+name: Spell Check
+on: [pull_request]
+
+jobs:
+  typos-check:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v4
+      - name: Check spelling
+        uses: crate-ci/typos@master
+        with:
+            config: _typos.toml
+            write_changes: true
+      - uses: reviewdog/action-suggester@v1
+        with:
+          tool_name: Typos
+          fail_on_error: true
diff --git a/_typos.toml b/_typos.toml
new file mode 100644
index 0000000..39f9f8f
--- /dev/null
+++ b/_typos.toml
@@ -0,0 +1,25 @@
+# https://github.com/crate-ci/typos#false-positives
+[default]
+
+[default.extend-identifiers]
+Lik = "Lik"
+missings = "missings"
+# misspelled in the car::Cowles dataset
+Extraversion = "Extraversion"
+extraversion = "extraversion"
+Fo = "Fo"
+
+[default.extend-words]
+Lik = "Lik"
+missings = "missings"
+
+
+[type.package_toml]
+# Don't check spellings in these files
+extend-glob = ["Manifest.toml", "Project.toml"]
+check-file = false
+
+[type.bib]
+# contain lots of names, which are a great spot for false positives
+extend-glob = ["*.bib"]
+check-file = false
diff --git a/src/typical.jl b/src/typical.jl
index 6f7cf61..e42d4aa 100644
--- a/src/typical.jl
+++ b/src/typical.jl
@@ -1,7 +1,7 @@
 #=
 
 Idea is: we have a model formula and a design dict of variables with reference values.
-all teh terms that are not present in the design get "typified".  we re-write the model
+all the terms that are not present in the design get "typified".  we re-write the model
 formula replacing all the terms with their "typified" version where available.
 
 then we call modelcols using this new formula + the reference grid