From 7c5cf651f7fcd946fcb087f3ae0cac9d1c91ecf5 Mon Sep 17 00:00:00 2001
From: Phillip Alday <phillip.alday@beacon.bio>
Date: Mon, 6 Nov 2023 16:16:09 -0600
Subject: [PATCH] spellcheck CI

---
 .github/workflows/spellcheck.yml | 21 +++++++++++++++++++++
 _typos.toml                      | 20 ++++++++++++++++++++
 2 files changed, 41 insertions(+)
 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..f8d9752
--- /dev/null
+++ b/_typos.toml
@@ -0,0 +1,20 @@
+# https://github.com/crate-ci/typos#false-positives
+[default]
+
+[default.extend-identifiers]
+Lik = "Lik"
+missings = "missings"
+
+[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