Merge pull request #15 from py-mine/add-codespell

Add codespell

.github/workflows/prepare-release.yml

@@ -25,8 +25,8 @@ jobs:
         with:
           token: ${{ steps.generate_token.outputs.token }}
 
-      # Make the github application be the comitter
-      # (see: https://stackoverflow.com/a/74071223 on how to obtain the comitter email)
+      # Make the github application be the committer
+      # (see: https://stackoverflow.com/a/74071223 on how to obtain the committer email)
       - name: Setup git config
         run: |
           git config --global user.name "py-mine-ci-bot"

.github/workflows/validation.yml

@@ -27,7 +27,7 @@ jobs:
           install_args: "--without release"
 
       - name: Run pre-commit hooks
-        run: SKIP=black,isort,flake8,slotscheck,pyright pre-commit run --all-files
+        run: SKIP=black,isort,flake8,slotscheck,codespell,pyright pre-commit run --all-files
 
       - name: Run black formatter check
         run: black --check --diff .
@@ -38,6 +38,9 @@ jobs:
       - name: Run flake8 linter
         run: flake8 .
 
+      - name: Run codespell linter
+        run: codespell .
+
       - name: Run slotscheck
         run: slotscheck -m mcproto
 

.pre-commit-config.yaml

@@ -44,6 +44,15 @@ repos:
         language: system
         types: [python]
 
+  - repo: local
+    hooks:
+      - id: codespell
+        name: CodeSpell
+        description: Run code spell checker
+        entry: poetry run codespell
+        language: system
+
+
   - repo: local
     hooks:
       - id: slotscheck

CONTRIBUTING.md

@@ -65,7 +65,7 @@ Methods of marking PR as a draft:
 1. When creating it
 
    ![image](https://user-images.githubusercontent.com/20902250/94499351-bc736e80-01fc-11eb-8e99-a7863dd1428a.png)
-2. After it was crated
+2. After it was created
 
    ![image](https://user-images.githubusercontent.com/20902250/94499276-8930df80-01fc-11eb-9292-7f0c6101b995.png)
 

README.md

@@ -102,7 +102,7 @@ async def handshake(conn: TCPAsyncConnection, ip: str, port: int = 25565) -> Non
 
     # And now, it's time to send it!
     await conn.write_varint(len(packet))  # First field (size of packet id + data)
-    await conn.write(packet)  # Second + Third fileds (packet id + data)
+    await conn.write(packet)  # Second + Third fields (packet id + data)
 
 
 async def status(conn: TCPAsyncConnection, ip: str, port: int = 25565) -> dict:

changes/15.internal.md

@@ -0,0 +1 @@
+Add codespell tool, to automatically find spelling mistakes.

pyproject.toml

@@ -63,6 +63,7 @@ pep8-naming = "^0.12.1"
 black = "^22.3.0"
 isort = "^5.10.1"
 pyright = "^1.1.239"
+codespell = {extras = ["tomli"], version = "^2.2.2"}
 slotscheck = "^0.16.1"
 
 [tool.poetry.group.release.dependencies]
@@ -85,6 +86,10 @@ order_by_type = false
 case_sensitive = true
 combine_as_imports = true
 
+[tool.codespell]
+skip = "./.venv/*,./htmlcov/*,./.git,./.mypy_cache/*,./.pytest_cache/*"
+ignore-words-list = "ned"
+
 [tool.pytest.ini_options]
 minversion = "6.0"
 asyncio_mode = "auto"
@@ -153,6 +158,7 @@ black = "black ."
 isort = "isort ."
 pyright = "pyright ."
 flake8 = "flake8 ."
+codespell = "codespell ."
 slotscheck = "slotscheck -m mcproto"
 test = "pytest -v --failed-first"
 retest = "pytest -v --last-failed"