enable spellchecking for sourcecode (#722)

Co-authored-by: Markus Kühbach <mkuehbach@users.noreply.github.com>
Co-authored-by: Lukas Pielsticker <you@example.com>
Co-authored-by: GitHub <github-actions[bot]@users.noreply.github.com>

Author: 4 people

.cspell/custom-dictionary.txt

@@ -1,112 +1,207 @@
-# Custom Dictionary Words
 ARPES
+ATTRIBUTENAME
 AXISNAME
 Aeschlimann
 BASECLASS
-Bluesky
+BASESECTIONS
 Brockhauser
-Brückner
-CSET
 Carola
 DECTRIS
+Dataconverter
 Dobener
+Downsample
+Downsampled
 Draxl
 ELECTRONANALYZER
 Emminger
-FAIRMAT
-Fekete
 Florian
 Forschungsgemeinschaft
 GROUPNAME
 Ginzburg
+Globar
+González
 Grundmann
-Haraszti
 Heiko
 Hetaba
+Hildebrandt
 José
 Kühbach
 Laurenz
 Lukas
+MONOCHROMATOR
 MPES
 MSYS
-Maier
 Markus
 Metainfo
 Mozumder
 Márquez
 NFDI
 NIAC
-NULLTERM
+NINF
 NXDL
+Namefits
+Namefitting
+OPCPA
+ORCID
 PATHCONV
+PDBX
+PYNXTOOLS
 Pielsticker
 Pincelli
+Plottable
 Prieto
+Pynxtools
 Raman
 Rettig
-STRPAD
-STRSIZE
+SILX
 Sandor
 Scheidgen
 Shabih
 Sherjeel
+Tommaso
+UNALLOWED
+Uniquified
+Uniquifies
 Walid
+Xclass
 Zenodo
+allclose
 alphabetagamma
 analyser
+anamethat
+anamethatichangetothis
+anamethatrenames
 appdef
 appdefdir
 appdefs
 arpes
+atleast
+atomutils
+attribs
+backgroundcolor
+baseclass
+basesections
+bulletpoint
+callspec
 caplog
 cnxvalidate
+complexfloating
+dataarrays
 dataconverter
+datamodel
+defaultdicts
+docstrings
+edgeitems
+ekey
 electronanalyzer
+elems
 ellips
+elist
 ellipsometry
 emittance
-filemanager
+execinfo
+fairmat
+fillvalue
 flatfield
 fluence
 fxcef
-hildebrandt
+getlink
+getroottree
+groupgroup
+groupnames
+hashkey
+hashvalue
+hdfdict
+hdfgroup
+hdfobject
 hixu
 hypothes
+idname
+idobj
 infile
-infty
+instancename
+isdt
+isscalar
+issubdtype
+itemsizing
+iufc
+iupac
+keystring
+keyval
 kfra
-libhdf
-libiconv
+lauetof
+ldic
+levelname
+levelno
+libversion
+lineterm
+listified
+listify
 loadgroup
 lukaspie
 mainfile
 mbar
+metainfo
 mkuehbach
 monochromator
 monoclinic
-mydata
+mpes
 mydatareader
 mynxdl
+namefit
 namefitting
+ndarray
+ndataconverter
 nexpy
+nexusapp
 nexusformat
-nexusvalidate
-nexusvalidation
+nodemixin
+nonvariadic
+nsmap
+nxcollection
+nxdata
+nxdl
 nxdls
+nxentry
+optionalities
 orcid
 otherfile
 oxidising
 pathtovalidate
-physik
 plottable
 posint
+printoptions
 punx
 pynxtools
+raman
+redef
+reqs
+requiredness
+rtol
 setpoint
 sherjeelshabih
+showgrid
+showlegend
+straße
+submoduled
+tnxdl
+tofile
 tommaso
+tracebacklimit
 underload
+uniquify
+unitless
+unlazy
+unlazying
+unsignedinteger
+ureg
+usefixtures
+visititems
 xarrays
+xaxis
 xdist
 xfbaa
 xraylens
+yaxis
+zaxis
+zenodo

.github/workflows/spellcheck.yaml

@@ -2,8 +2,7 @@ name: Spell Check
 
 on:
   pull_request:
-    branches:
-      - master  # Triggers deployment on push to the master branch
+    branches: [master]
 
 jobs:
   spellcheck:
@@ -19,11 +18,15 @@ jobs:
 
     - name: Run cspell
       run: |
-        cspell --config cspell.json "docs/**/*.md" "CITATION.cff" "README.md"
+        cspell --config cspell.json \
+        "README.md" "CITATION.cff" \
+        "docs/**/*" \
+        "src/pynxtools/**/*.py" \
+        "tests/**/*.py"
 
     - name: Fail on errors
       run: |
         if [[ $? -ne 0 ]]; then
           echo "There are spelling errors in your code. Please fix them and try again."
           exit 1
-        fi
+        fi

.pre-commit-config.yaml

@@ -1,9 +1,38 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    # Ruff version.
     rev: v0.14.0
     hooks:
-      # Run the linter.
-      - id: ruff
-      # Run the formatter.
-      - id: ruff-format
+      - id: ruff-check
+        files: ^(src/pynxtools|tests)/.*\.py$
+      - id: ruff-format
+        files: ^(src/pynxtools|tests)/.*\.py$
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.18.1
+    hooks:
+      - id: mypy  # static type checking
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.21.1
+    hooks:
+      - id: pyupgrade
+        args: [--py36-plus]  # modernizes syntax for Python 3.6+
+
+  - repo: https://github.com/kynan/nbstripout
+    rev: 0.6.0
+    hooks:
+      - id: nbstripout  # removes notebook outputs before committing
+
+  - repo: https://github.com/streetsidesoftware/cspell-cli
+    rev: v9.3.0
+    hooks:
+      - id: cspell  # spellchecking
+        pass_filenames: false
+        args:
+          - --config
+          - cspell.json
+          - README.md
+          - CITATION.cff
+          - docs/**/*
+          - src/pynxtools/**/*.py
+          - tests/**/*.py

cspell.json

@@ -1,28 +1,32 @@
 {
     "version": "0.2",
     "ignorePaths": [
-        "./tests/data/*",
+        "tests/data/*",
         "*.toml",
         "Makefile",
         "*.bat",
-        "*.egg-info"
+        "*.egg-info",
+        "venv",
+        "__pycache__",
+        "dist",
+        "build",
+        "src/pynxtools/definitions"
     ],
-    "dictionaryDefinitions": [
-        {
-            "name": "custom-dictionary",
-            "path": "./.cspell/custom-dictionary.txt",
-            "addWords": true
-        }
-    ],
-    "import": ["@cspell/dict-scientific-terms-us/cspell-ext.json"],
-    "dictionaries": [
-        "custom-dictionary",
-        "scientific_terms_US",
-        "python"
-    ],
-    "words": [],
-    "ignoreWords": [],
-    "ignoreRegExpList": ["\\bNX\\w*\\b", "https?://[\\S]+"],
-    "import": [],
-    "language": "en-US"
+  "dictionaryDefinitions": [
+    {
+      "name": "custom-dictionary",
+      "path": "./.cspell/custom-dictionary.txt",
+      "addWords": true
+    }
+  ],
+  "dictionaries": [
+    "custom-dictionary",
+    "scientific_terms_US",
+    "en_US",
+    "python"
+  ],
+  "words": [],
+  "ignoreWords": [],
+  "ignoreRegExpList": ["\\bNX\\w*\\b", "https?://[\\S]+"],
+  "language": "en-US"
 }