Merge pull request #121 from yarikoptic/enh-codespell

MAINT: Add codespell and make it fix some typos

Author: oesteban

.github/workflows/codespell.yml

@@ -0,0 +1,23 @@
+# Codespell configuration is within pyproject.toml
+---
+name: Codespell
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+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

.maint/update_changes.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 #
 # Collects the pull-requests since the latest release and
-# aranges them in the CHANGES.rst.txt file.
+# arranges them in the CHANGES.rst.txt file.
 #
 # This is a script to be run before releasing a new version.
 #

CHANGES.rst

@@ -1,6 +1,6 @@
 24.1.0 (March 15, 2024)
 =======================
-Minor relase updating *PyBIDS*'s configuration to enable new entities
+Minor release updating *PyBIDS*'s configuration to enable new entities
 that allow the selection of recently added *FreeSurfer*'s surface parcellations in
 `templateflow/tpl-fsaverage#5 <https://github.com/templateflow/tpl-fsaverage/pull/5>`__.
 

docs/installation.rst

@@ -34,7 +34,7 @@ of any available template set.
 The lazy-loading implementation of the client requires some folder on the host
 where template resources can be stored (therefore, write permissions are
 required). By default, the home folder will be ``$HOME/.cache/templateflow``.
-This setting can be overriden by defining the environment variable ``TEMPLATEFLOW_HOME``
+This setting can be overridden by defining the environment variable ``TEMPLATEFLOW_HOME``
 before running the client, for example::
 
   $ export TEMPLATEFLOW_HOME=$DATA/.templateflow

pyproject.toml

@@ -178,4 +178,11 @@ inline-quotes = "single"
 "docs/sphinxext/github_link.py" = ["BLE001"]
 
 [tool.ruff.format]
-quote-style = "single"
+quote-style = "single"
+
+[tool.codespell]
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+skip = '.git,*.pdf,*.svg,venvs,*.css'
+check-hidden = true
+# ignore-regex = ''
+# ignore-words-list = ''