Fix typos, add typos CI

.github/workflows/ci.yml

@@ -20,6 +20,13 @@ jobs:
                 pipx install ruff
                 ruff check
 
+    typos:
+        name: Typos
+        runs-on: ubuntu-latest
+        steps:
+        -   uses: actions/checkout@v4
+        -   uses: crate-ci/typos@master
+
     pylint:
         name: Pylint
         runs-on: ubuntu-latest

doc/shells.rst

@@ -52,7 +52,7 @@ PuDB supports the following external shells.
 - Internal (same as pressing ``Ctrl-x``). This is the default.
 - Classic (similar to the default ``python`` interactive shell)
 - `IPython <https://ipython.org/>`_
-   The `IPython` shell can also be used in a server-client fasion, which is
+   The `IPython` shell can also be used in a server-client fashion, which is
    enabled by selecting the shell `ipython_kernel` in the settings. When set,
    the ``!`` key will start an `IPython` kernel and wait for connection from,
    e.g., `qtconsole`. Like other shells, `ipython_kernel` blocks the debugger

examples/shell.py

@@ -25,7 +25,7 @@ def pudb_shell(_globals, _locals):
     # Many shells only let you pass in a single locals dictionary, rather than
     # separate globals and locals dictionaries. In this case, you can use
     # pudb.shell.SetPropagatingDict to automatically merge the two into a
-    # single dictionary. It does this in such a way that assignments propogate
+    # single dictionary. It does this in such a way that assignments propagate
     # to _locals, so that when the debugger is at the module level, variables
     # can be reassigned in the shell.
     from pudb.shell import SetPropagatingDict

examples/stringifier.py

@@ -7,7 +7,7 @@
 cannot fail.  PuDB also includes built-in options for using str() and repr().
 
 Note that str() and repr() will be slower than type(), which is especially
-noticable when you have many variables, or some of your variables have very
+noticeable when you have many variables, or some of your variables have very
 large string/repr representations.
 
 Also note that if you just want to change the type for one or two variables,

pudb/debugger.py

@@ -2828,7 +2828,7 @@ def event_loop(self, toplevel=None):
                     "- Size changes in sidebar boxes (contributed by Aaron Meurer)\n"
                     "- New theme 'midnight' (contributed by Aaron Meurer)\n"
                     "- Support for IPython 0.11 (contributed by Chris Farrow)\n"
-                    "- Suport for custom stringifiers "
+                    "- Support for custom stringifiers "
                     "(contributed by Aaron Meurer)\n"
                     "- Line wrapping in variables view "
                     "(contributed by Aaron Meurer)\n"
@@ -2951,7 +2951,7 @@ def update_var_view(self, locals=None, globals=None, focus_index=None):
                 locals, globals)
         if focus_index is not None:
             # Have to set the focus _after_ updating the locals list, as there
-            # appears to be a brief moment while reseting the list when the
+            # appears to be a brief moment while resetting the list when the
             # list is empty but urwid will attempt to set the focus anyway,
             # which causes problems.
             try:

pudb/lowlevel.py

@@ -201,7 +201,7 @@ def lookup_module(filename):
 def detect_encoding(line_iter):
     """
     The detect_encoding() function is used to detect the encoding that should
-    be used to decode a Python source file. It requires one argment, line_iter,
+    be used to decode a Python source file. It requires one argument, line_iter,
     an iterator on the lines to be read.
 
     It will read a maximum of two lines, and return the encoding used

pudb/test/test_lowlevel.py

@@ -74,7 +74,7 @@ def main():
             conf = ''. \\
                 replace('', '')
 
-            conf_tpl = ''  # <-- imposible to set breakpoint here
+            conf_tpl = ''  # <-- impossible to set breakpoint here
 
         main()
         """

pyproject.toml

@@ -40,3 +40,17 @@ addopts = [
         "--ignore=pudb/b.py",
         "--ignore=pudb/ipython.py",
         ]
+
+
+[tool.typos.default]
+extend-ignore-re = [
+  "(?Rm)^.*(#|//)\\s*spellchecker:\\s*disable-line$"
+]
+
+[tool.typos.default.extend-words]
+# Ned Batchelder, person
+Ned = "Ned"
+
+[tool.typos.files]
+extend-exclude = [
+]