🔀 Merge pull request #96 from davep/codespell

Add codespell checking

Author: davep

.github/workflows/style-lint-and-test.yaml

@@ -36,6 +36,9 @@ jobs:
           echo ${{ matrix.python-version }} > .python-version
           make setup
 
+      - name: Check for typos
+        run: make spellcheck
+
       - name: Check the Code style
         run: make codestyle
 

.pre-commit-config.yaml

@@ -8,3 +8,7 @@ repos:
         args: [ --fix, --select, I ]
       # Run the formatter.
       - id: ruff-format
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell

CONTRIBUTING.md

@@ -17,7 +17,7 @@ like something that makes sense for Hike I'll turn it into an issue
 from there.
 
 Be sure to [have a look over the TODO
-isues](https://github.com/davep/hike/issues?q=is%3Aissue+is%3Aopen+label%3ATODO)
+issues](https://github.com/davep/hike/issues?q=is%3Aissue+is%3Aopen+label%3ATODO)
 before leaving a request, it might be I'm already planning on implementing
 whatever it is you're asking for.
 

Makefile

@@ -1,13 +1,15 @@
 app    := hike
 src    := src/
 tests  := tests/
+docs   := docs/
 run    := rye run
 test   := rye test
 python := $(run) python
 lint   := rye lint -- --select I
 fmt    := rye fmt
 mypy   := $(run) mypy
 mkdocs := $(run) mkdocs
+spell  := $(run) codespell
 
 ##############################################################################
 # Local "interactive testing" of the code.
@@ -64,8 +66,12 @@ stricttypecheck:	        # Perform a strict static type checks with mypy
 test:				# Run the unit tests
 	$(test) -v
 
+.PHONY: spellcheck
+spellcheck:			# Spell check the code
+	$(spell) *.md $(src) $(docs) $(tests)
+
 .PHONY: checkall
-checkall: codestyle lint stricttypecheck test # Check all the things
+checkall: spellcheck codestyle lint stricttypecheck test # Check all the things
 
 ##############################################################################
 # Documentation.

docs/source/commands.md

@@ -57,7 +57,7 @@ There are some commands that interact with the navigation panel. These are:
 
 Ensures that the navigation panel is opened and then jumps to the bookmarks.
 
-#### `conents`
+#### `contents`
 
 !!! aliases
 

docs/source/configuration.md

@@ -69,7 +69,7 @@ generally use a name (`number_sign`, `at`, `asterisk`, etc...).
 
 !!! tip
 
-    If you want to test and discover all of the key names and combiantions
+    If you want to test and discover all of the key names and combinations
     that will work, you may want to install
     [`textual-dev`](https://github.com/Textualize/textual-dev) and use the
     `textual keys` command.
@@ -178,10 +178,10 @@ You can show or hide the navigation panel. This can be done in Hike with the
 
 !!! tip
 
-    You can force nagivation [visible](index.md#-navigation) or
+    You can force navigation [visible](index.md#-navigation) or
     [hidden](index.md#-no-navigation) via [the command
     line](index.md#command-line-options).
-    Note that this *also* configures the visability of the navigation panel
+    Note that this *also* configures the visibility of the navigation panel
     for future runs of Hike.
 
 Here is Hike with the navigation panel visible:

pyproject.toml

@@ -78,6 +78,7 @@ dev-dependencies = [
     "pytest>=8.3.4",
     "mkdocs-material>=9.6.11",
     "markdown-exec>=1.10.3",
+    "codespell>=2.4.1",
 ]
 
 [tool.hatch.metadata]

requirements-dev.lock

@@ -39,6 +39,7 @@ charset-normalizer==3.4.1
 click==8.1.8
     # via mkdocs
     # via textual-dev
+codespell==2.4.1
 colorama==0.4.6
     # via mkdocs-material
 distlib==0.3.9

src/hike/data/location_types.py

@@ -55,7 +55,7 @@ def looks_urllike(candidate: str) -> bool:
     """Does the given value look like a URL?
 
     Args:
-        candiate: The candidate to test.
+        candidate: The candidate to test.
 
     Returns:
         `True` if the string looks like a URL, `False` if not.

tests/unit/test_command_line_commands.py

@@ -32,7 +32,7 @@ class ExampleCommand(InputCommand):
         ("  TEstER  ", True),
         ("  TESting  ", True),
         ("", False),
-        ("te", False),
+        ("te", False),  # codespell:ignore
     ),
 )
 def test_is_command(look_for: str, found: bool) -> None: