Add codespell (#241)

.github/workflows/ci.yaml

@@ -14,6 +14,29 @@ on:
   workflow_dispatch:
 
 jobs:
+  codespell:
+    name: codespell
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/[email protected]
+      - name: 🏗 Set up Poetry
+        run: pipx install poetry
+      - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
+        id: python
+        uses: actions/[email protected]
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+          cache: "poetry"
+      - name: 🏗 Install workflow dependencies
+        run: |
+          poetry config virtualenvs.create true
+          poetry config virtualenvs.in-project true
+      - name: 🏗 Install Python dependencies
+        run: poetry install --no-interaction
+      - name: 🚀 Check code for common misspellings
+        run: poetry run pre-commit run codespell --all-files
+
   ruff:
     name: Ruff
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -66,6 +66,14 @@ repos:
         language: system
         types: [yaml]
         entry: poetry run check-yaml
+      - id: codespell
+        name: ✅ Check code for common misspellings
+        language: system
+        types: [text]
+        exclude: ^poetry\.lock$
+        entry: poetry run codespell
+        args:
+          - --ignore-words-list=nd
       - id: detect-private-key
         name: 🕵️  Detect Private Keys
         language: system

pyproject.toml

@@ -33,6 +33,7 @@ pytest-asyncio = "^0.23"
 ruff = "^0.2.2"
 pre-commit = "^3.6.2"
 pre-commit-hooks = "^4.5.0"
+codespell = "^2.2.6"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

roombapy/remote_client.py

@@ -119,7 +119,7 @@ def _internal_on_connect(self, client, userdata, flags, rc):
             "Connected to Roomba %s, response code = %s", self.address, rc
         )
         connection_error = MQTT_ERROR_MESSAGES.get(rc)
-        # If response code(rc) is 0 then connection was succesfull.
+        # If response code(rc) is 0 then connection was successful.
         if rc != 0 and connection_error is None:
             self.log.warning(
                 "Unknown connection error: ID=%s."
@@ -135,7 +135,7 @@ def _internal_on_disconnect(self, client, userdata, rc):
             "Disconnected from Roomba %s, response code = %s", self.address, rc
         )
         connection_error = MQTT_ERROR_MESSAGES.get(rc)
-        # If response code(rc) is 0 then connection was succesfull.
+        # If response code(rc) is 0 then connection was successful.
         if rc != 0 and connection_error is None:
             self.log.warning(
                 "Unknown disconnection error: ID=%s."

roombapy/roomba.py

@@ -39,7 +39,7 @@ class Roomba:
     password() class above (or can be auto discovered)
     Most of the underlying info was obtained from here:
     https://github.com/koalazak/dorita980 many thanks!
-    The values received from the Roomba as stored in a dictionay called
+    The values received from the Roomba as stored in a dictionary called
     master_state, and can be accessed at any time, the contents are live, and
     will build with time after connection.
     This is not needed if the forward to mqtt option is used, as the events will
@@ -297,8 +297,8 @@ def decode_payload(self, topic, payload):
     def decode_topics(self, state, prefix=None):
         """Decode json data dict and publish as individual topics.
 
-        Publish to brokerFeedback/topic the keys are concatinated with _
-        to make one unique topic name strings are expressely converted
+        Publish to brokerFeedback/topic the keys are concatenated with _
+        to make one unique topic name strings are expressively converted
         to strings to avoid unicode representations
         """
         for key, value in state.items():