From 6bbcf327427212f8156c389428d0fc450c6dcb59 Mon Sep 17 00:00:00 2001
From: Yaroslav Halchenko <debian@onerussian.com>
Date: Wed, 13 Mar 2024 11:08:24 -0400
Subject: [PATCH] [CI] adding codespell: fixing one typo (#86)

* Add github action to codespell main on push and PRs

* Add rudimentary codespell config

* [DATALAD RUNCMD] run codespell throughout fixing typos automagically

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^

---------

Co-authored-by: Arman Jahanpour <77515879+rmanaem@users.noreply.github.com>
---
 .codespellrc                    |  6 ++++++
 .github/workflows/codespell.yml | 23 +++++++++++++++++++++++
 CHANGELOG.md                    |  2 +-
 3 files changed, 30 insertions(+), 1 deletion(-)
 create mode 100644 .codespellrc
 create mode 100644 .github/workflows/codespell.yml

diff --git a/.codespellrc b/.codespellrc
new file mode 100644
index 00000000..c5fd3bc4
--- /dev/null
+++ b/.codespellrc
@@ -0,0 +1,6 @@
+[codespell]
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+skip = .git,package-lock.json,*.css,.codespellrc
+check-hidden = true
+# ignore-regex = 
+# ignore-words-list =
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
new file mode 100644
index 00000000..7c9eafb1
--- /dev/null
+++ b/.github/workflows/codespell.yml
@@ -0,0 +1,23 @@
+# Codespell configuration is within .codespellrc
+---
+name: Codespell
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e863859c..5f186a3c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -41,7 +41,7 @@ The first release of the tool refactored and reimplemented in React and TypeScri
 #### 🐛 Bug Fixes
 
 - [FIX] Fixed the performance issues caused by re-rendering [#39](https://github.com/neurobagel/query-tool/pull/39) ([@rmanaem](https://github.com/rmanaem))
-- [FIX] Refactored synching of the `URLSearchParams` and selected nodes [#25](https://github.com/neurobagel/query-tool/pull/25) ([@rmanaem](https://github.com/rmanaem))
+- [FIX] Refactored syncing of the `URLSearchParams` and selected nodes [#25](https://github.com/neurobagel/query-tool/pull/25) ([@rmanaem](https://github.com/rmanaem))
 
 #### 🏠 Internal