add cspell CI job (#58)

.cspell.json

@@ -33,6 +33,9 @@
         "autogenerate",
         "autogenerated",
         "asdict",
+        "noqa",
+        "rpartition",
+        "pyright",
 
         // spinx docs
         "autofunction",

.github/workflows/ci.yml

@@ -34,3 +34,16 @@ jobs:
           poetry run poe tests
           poetry run coverage xml
           curl -sL https://coveralls.io/coveralls-linux.tar.gz | tar -xz && ./coveralls -f coverage.xml
+
+  spelling:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: streetsidesoftware/cspell-action@v2
+        with:
+          config: ".cspell.json"
+          files: |
+            cincoconfig/**/*.py
+            docs/*.rst
+            CHANGELOG.md

cincoconfig/support.py

@@ -324,7 +324,7 @@ def asdict(config: Config, virtual: bool = False) -> dict:
     the configuration, and all nested configuration objects, to a dict, preserving each value
     as-is.
 
-    :param config: the configuration to conver to a dict
+    :param config: the configuration to convert to a dict
     :param virtual: include virtual field values in the dict
     :returns: the converted configuration dict
     """

pyproject.toml

@@ -101,3 +101,6 @@ tests = [
     { cmd = "coverage run --source cincoconfig -m pytest" },
     { cmd = "coverage report -m" }
 ]
+# The check-spelling task is currently disabled until poe fixes CMD resolution on Windows:
+# https://github.com/nat-n/poethepoet/pull/142
+# "check-spelling" = "npx cspell \"cincoconfig/**/*.py\" \"docs/*.rst\" CHANGELOG.md"