Merge pull request #34 from yarikoptic/enh-codespell

Add codespell support (config, workflow to detect/not fix) and make it fix some typos

Author: ReboreExplore

.github/workflows/codespell.yml

@@ -0,0 +1,25 @@
+# Codespell configuration is within pyproject.toml
+---
+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: Annotate locations with typos
+        uses: codespell-project/codespell-problem-matcher@v1
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

README.md

@@ -23,7 +23,7 @@ git clone https://github.com/s-ccs/LSLAutoBIDS.git
 ```
 pip3 install lslautobids
 ```
-It is advised to install the package in a seperate environment (e.g. using `conda` or `virtualenv`).
+It is advised to install the package in a separate environment (e.g. using `conda` or `virtualenv`).
 
 > [!NOTE]  
 > If you are using conda, you can create a new conda environment using the following command and activate it.

lslautobids/convert_to_bids_and_upload.py

@@ -448,7 +448,7 @@ def bids_process_and_upload(processed_files,logger):
         val = bids.convert_to_bids(xdf_path,subject_id,session_id, run_id, task_id, stim, logger)   
 
         if val == 1:
-                logger.info("Bids Conversion Sucessful")      
+                logger.info("BIDS Conversion Successful")      
         elif val == 2:
                 logger.info("Converted file already found, skipping")   
         else:

pyproject.toml

@@ -1,3 +1,10 @@
 [build-system]
 requires = ["setuptools", "wheel"]
 build-backend = "setuptools.build_meta"
+
+[tool.codespell]
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+skip = '.git*,*.svg,*.bib'
+check-hidden = true
+# ignore-regex = ''
+# ignore-words-list = ''

typst/main.typ

@@ -49,7 +49,7 @@ Cognitive neuroscience routinely collect large datasets, yet data integration, m
 // set spellcheck language
 #set text(lang: "en", region: "US")
 
-// figure caption alighment
+// figure caption alignment
 #show figure.caption: set align(center)
 
 //#elements.float(align: bottom, [\*Corresponding author])