Use US spelling for consistency, plus add typos configuration to pyproject.toml.

jonathanslenders · jonathanslenders · commit 8b18fef2bb48 · 2023-11-16T22:47:32.000+01:00
diff --git a/CHANGELOG b/CHANGELOG
@@ -471,7 +471,7 @@ New features:
   * The color depth logic has been refactored and moved to the `Output`
     implementations. Added `get_default_color_depth` method to `Output`
     objects.
-  * All line feets are now preceded by a carriage return in the telnet
+  * All line feet are now preceded by a carriage return in the telnet
     connection stdout.
 - Introduce `REPLACE_SINGLE` input mode for Vi key bindings.
 - Improvements to the checkbox implementation:
@@ -1141,7 +1141,7 @@ Fixes:
 
 New features:
 - Allow users to enter Vi digraphs in reverse order.
-- Improved autocompletion behaviour. See IPython issue #9658.
+- Improved autocompletion behavior. See IPython issue #9658.
 - Added a 'clear' function in the shortcuts module.
 
 For future compatibility:
@@ -1162,7 +1162,7 @@ For future compatibility:
 
 Fixes:
 - Bugfix for Python2 in readline-like completion.
-- Bugfix in readline-like completion visualisation.
+- Bugfix in readline-like completion visualization.
 
 New features:
 - Added `erase_when_done` parameter to the `Application` class.  (This was
@@ -1175,7 +1175,7 @@ New features:
 
 Fixes:
 - Don't select the first completion when `complete_while_typing` is False.
-  (Restore the old behaviour.)
+  (Restore the old behavior.)
 
 
 1.0.1: 2016-06-15
@@ -1327,7 +1327,7 @@ Backwards-incompatible changes:
   the `vi_mode` parameter in `KeyBindingManager`.
 - The default accept_action for the default Buffer in Application now becomes
   IGNORE. This is a much more sensible default. Pass RETURN_DOCUMENT to get
-  the previous behaviour,
+  the previous behavior,
 - Always expect an EventLoop instance in CommandLineInterface. Creating it in
   __init__ caused a memory leak.
 
@@ -1344,8 +1344,8 @@ Fixes:
 - Correctly align right prompt to the top when the left prompt consists of
   multiple lines.
 - Correctly use Token.Transparent as default token for a TokenListControl.
-- Fix in syntax synchronisation. (Better handle the case when no
-  synchronisation point was found.)
+- Fix in syntax synchronization. (Better handle the case when no
+  synchronization point was found.)
 - Send SIGTSTP to the whole process group.
 - Correctly raise on_buffer_changed on all text changes.
 - Fix in regular_languages.GrammarLexer. (Fixes bug in ptipython syntax
@@ -1403,7 +1403,7 @@ New features:
   `create_prompt_layout`.
 - Some improvements to the default style.
 - Also handle Ctrl-R and Ctrl-S in Vi mode when searching.
-- Added TabsProcessor: a tool to visualise tabs instead of displaying ^I.
+- Added TabsProcessor: a tool to visualize tabs instead of displaying ^I.
 - Give a better error message when trying to run in git-bash.
 - Support for ANSI color names in style dictionaries.
 
@@ -1421,7 +1421,7 @@ New features:
     they process one line at a time.)
   - Lexers work differently. `Lexer.lex_document` should now return a function
     that returns the tokens for one line. PygmentsLexer has been optimized that
-    it becomes 'lazy', and it has optional syntax synchronisation. That means,
+    it becomes 'lazy', and it has optional syntax synchronization. That means,
     that the lexer doesn't have to start the lexing at the beginning of the
     document. (Which would be slow for big documents.)
 
@@ -1672,7 +1672,7 @@ New features:
 - Added `prompt_toolkit.layout.utils.iter_token_lines`.
 - Allow `None` values on the focus stack.
 - Buffers can be readonly. Added `IsReadOnly` filter.
-- `eager` behaviour for key bindings. When a key binding is eager it will be
+- `eager` behavior for key bindings. When a key binding is eager it will be
   executed as soon as it's matched, even when there is another binding that
   starts with this key sequence.
 - Custom margins for BufferControl.
@@ -1738,7 +1738,7 @@ Fixes:
 New features:
 - CompletionsMenu got a scroll_offset.
 - Use 256 colors and ANSI sequences when ConEmu ANSI support has been detected.
-- Added PyperclipClipboard for synchronisation with the system clipboard.
+- Added PyperclipClipboard for synchronization with the system clipboard.
   and clipboard parameter in shortcut functions.
 - Filter for enabling/disabling handling of Vi 'v' binding.
 
@@ -2033,7 +2033,7 @@ New features:
 - prompt_toolkit.contrib.shortcuts.get_input has been extended.
 
 Fixed:
-- Behaviour of Control+left/right/up/down.
+- Behavior of Control+left/right/up/down.
 - Backspace in incremental search.
 - Hide completion menu correctly when the cursor position changes.
 
@@ -2108,7 +2108,7 @@ New features:
 - Experimental Win32 support added.
 
 Fixed:
-- Behaviour of 'r' and 'R' key bindings in Vi mode.
+- Behavior of 'r' and 'R' key bindings in Vi mode.
 - Detect multiline correctly for ptpython when there are triple quoted strings.
 - Some other small improvements.
 
diff --git a/PROJECTS.rst b/PROJECTS.rst
@@ -37,7 +37,7 @@ Shells:
 - `athenacli <https://github.com/dbcli/athenacli>`_: A CLI for AWS Athena.
 - `vulcano <https://github.com/dgarana/vulcano>`_: A framework for creating command-line applications that also runs in REPL mode.
 - `kafka-shell <https://github.com/devshawn/kafka-shell>`_: A supercharged shell for Apache Kafka.
-- `starterTree <https://github.com/thomas10-10/starterTree>`_: A command launcher organised in a tree structure with fuzzy autocompletion 
+- `starterTree <https://github.com/thomas10-10/starterTree>`_: A command launcher organized in a tree structure with fuzzy autocompletion 
 - `git-delete-merged-branches <https://github.com/hartwork/git-delete-merged-branches>`_: Command-line tool to delete merged Git branches
 
 Full screen applications:
diff --git a/docs/pages/advanced_topics/rendering_flow.rst b/docs/pages/advanced_topics/rendering_flow.rst
@@ -33,7 +33,7 @@ What happens when a :class:`~prompt_toolkit.renderer.Renderer` objects wants a
 :class:`~prompt_toolkit.layout.Container` to be rendered on a certain
 :class:`~prompt_toolkit.layout.screen.Screen`?
 
-The visualisation happens in several steps:
+The visualization happens in several steps:
 
 1. The :class:`~prompt_toolkit.renderer.Renderer` calls the
    :meth:`~prompt_toolkit.layout.Container.write_to_screen` method
diff --git a/docs/pages/asking_for_input.rst b/docs/pages/asking_for_input.rst
@@ -656,7 +656,7 @@ Adding a right prompt
 ---------------------
 
 The :func:`~prompt_toolkit.shortcuts.prompt` function has out of the box
-support for right prompts as well. People familiar to ZSH could recognise this
+support for right prompts as well. People familiar to ZSH could recognize this
 as the `RPROMPT` option.
 
 So, similar to adding a bottom toolbar, we can pass an ``rprompt`` argument.
@@ -706,7 +706,7 @@ Adding custom key bindings
 --------------------------
 
 By default, every prompt already has a set of key bindings which implements the
-usual Vi or Emacs behaviour. We can extend this by passing another
+usual Vi or Emacs behavior. We can extend this by passing another
 :class:`~prompt_toolkit.key_binding.KeyBindings` instance to the
 ``key_bindings`` argument of the :func:`~prompt_toolkit.shortcuts.prompt`
 function or the :class:`~prompt_toolkit.shortcuts.PromptSession` class.
diff --git a/docs/pages/full_screen_apps.rst b/docs/pages/full_screen_apps.rst
@@ -385,7 +385,7 @@ Input processors
 A :class:`~prompt_toolkit.layout.processors.Processor` is used to postprocess
 the content of a :class:`~prompt_toolkit.layout.BufferControl` before it's
 displayed. It can for instance highlight matching brackets or change the
-visualisation of tabs and so on.
+visualization of tabs and so on.
 
 A :class:`~prompt_toolkit.layout.processors.Processor` operates on individual
 lines. Basically, it takes a (formatted) line and produces a new (formatted)
@@ -410,11 +410,11 @@ Some build-in processors:
 +----------------------------------------------------------------------------+-----------------------------------------------------------+
 | :class:`~prompt_toolkit.layout.processors.AppendAutoSuggestion`            | Append auto suggestion text.                              |
 +----------------------------------------------------------------------------+-----------------------------------------------------------+
-| :class:`~prompt_toolkit.layout.processors.ShowLeadingWhiteSpaceProcessor`  | Visualise leading whitespace.                             |
+| :class:`~prompt_toolkit.layout.processors.ShowLeadingWhiteSpaceProcessor`  | Visualize leading whitespace.                             |
 +----------------------------------------------------------------------------+-----------------------------------------------------------+
-| :class:`~prompt_toolkit.layout.processors.ShowTrailingWhiteSpaceProcessor` | Visualise trailing whitespace.                            |
+| :class:`~prompt_toolkit.layout.processors.ShowTrailingWhiteSpaceProcessor` | Visualize trailing whitespace.                            |
 +----------------------------------------------------------------------------+-----------------------------------------------------------+
-| :class:`~prompt_toolkit.layout.processors.TabsProcessor`                   | Visualise tabs as `n` spaces, or some symbols.            |
+| :class:`~prompt_toolkit.layout.processors.TabsProcessor`                   | Visualize tabs as `n` spaces, or some symbols.            |
 +----------------------------------------------------------------------------+-----------------------------------------------------------+
 
 A :class:`~prompt_toolkit.layout.BufferControl` takes only one processor as
diff --git a/docs/pages/getting_started.rst b/docs/pages/getting_started.rst
@@ -21,7 +21,7 @@ Several use cases: prompts versus full screen terminal applications
 --------------------------------------------------------------------
 
 `prompt_toolkit` was in the first place meant to be a replacement for readline.
-However, when it became more mature, we realised that all the components for
+However, when it became more mature, we realized that all the components for
 full screen applications are there and `prompt_toolkit` is very capable of
 handling many use situations. `Pyvim
 <http://github.com/prompt-toolkit/pyvim>`_ and `pymux
diff --git a/docs/pages/progress_bars.rst b/docs/pages/progress_bars.rst
@@ -127,7 +127,7 @@ Both the title and the labels can be :ref:`formatted text <formatted_text>`.
 Formatting the progress bar
 ---------------------------
 
-The visualisation of a :class:`~prompt_toolkit.shortcuts.ProgressBar` can be
+The visualization of a :class:`~prompt_toolkit.shortcuts.ProgressBar` can be
 customized by using a different sequence of formatters. The default formatting
 looks something like this:
 
diff --git a/examples/full-screen/split-screen.py b/examples/full-screen/split-screen.py
@@ -94,7 +94,7 @@ def get_titlebar_text():
 # sure that we won't wait for that key binding to match, but instead execute
 # Ctrl-Q immediately, we can pass eager=True. (Don't make a habit of adding
 # `eager=True` to all key bindings, but do it when it conflicts with another
-# existing key binding, and you definitely want to override that behaviour.
+# existing key binding, and you definitely want to override that behavior.
 
 
 @kb.add("c-c", eager=True)
diff --git a/examples/progress-bar/styled-rainbow.py b/examples/progress-bar/styled-rainbow.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 """
-A simple progress bar, visualised with rainbow colors (for fun).
+A simple progress bar, visualized with rainbow colors (for fun).
 """
 import time
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -36,3 +36,31 @@ ignore = [
 [tool.ruff.isort]
 known-first-party = ["prompt_toolkit"]
 known-third-party = ["pygments", "asyncssh"]
+
+[tool.typos.default]
+extend-ignore-re = [
+    "Formicidae",
+    "Iterm",
+    "goes",
+    "iterm",
+    "prepend",
+    "prepended",
+    "prev",
+    "ret",
+    "rouble",
+    "x1b\\[4m",
+    # Deliberate spelling mistakes in autocorrection.py
+    "wolrd",
+    "impotr",
+    # Lorem ipsum.
+    "Nam",
+    "varius",
+]
+
+locale = 'en-us'  # US English.
+
+[tool.typos.files]
+extend-exclude = [
+    "tests/test_cli.py",
+    "tests/test_regular_languages.py",
+]
diff --git a/src/prompt_toolkit/contrib/regular_languages/__init__.py b/src/prompt_toolkit/contrib/regular_languages/__init__.py
@@ -30,7 +30,7 @@
 ---------------------------------
 
 - Syntax highlighting: We could use this for instance to give file names
-                       different colour.
+                       different color.
 - Parse the result: .. We can extract the file names and commands by using a
                        regular expression with named groups.
 - Input validation: .. Don't accept anything that does not match this grammar.
diff --git a/src/prompt_toolkit/input/posix_utils.py b/src/prompt_toolkit/input/posix_utils.py
@@ -26,7 +26,7 @@ class PosixStdinReader:
         On Python3, this can be 'surrogateescape', which is the default.
 
         'surrogateescape' is preferred, because this allows us to transfer
-        unrecognised bytes to the key bindings. Some terminals, like lxterminal
+        unrecognized bytes to the key bindings. Some terminals, like lxterminal
         and Guake, use the 'Mxx' notation to send mouse events, where each 'x'
         can be any possible byte.
     """
diff --git a/src/prompt_toolkit/layout/containers.py b/src/prompt_toolkit/layout/containers.py
@@ -2050,7 +2050,7 @@ def copy_line(
                         new_buffer_row[x + xpos] = char
 
                         # When we print a multi width character, make sure
-                        # to erase the neighbours positions in the screen.
+                        # to erase the neighbors positions in the screen.
                         # (The empty string if different from everything,
                         # so next redraw this cell will repaint anyway.)
                         if char_width > 1:
@@ -2537,7 +2537,7 @@ def do_scroll(
             scroll_offset_end=offsets.right,
             cursor_pos=get_cwidth(current_line_text[: ui_content.cursor_position.x]),
             window_size=width - current_line_prefix_width,
-            # We can only analyse the current line. Calculating the width off
+            # We can only analyze the current line. Calculating the width off
             # all the lines is too expensive.
             content_size=max(
                 get_cwidth(current_line_text), self.horizontal_scroll + width
diff --git a/src/prompt_toolkit/layout/controls.py b/src/prompt_toolkit/layout/controls.py
@@ -491,7 +491,7 @@ class _ProcessedLine(NamedTuple):
 
 class BufferControl(UIControl):
     """
-    Control for visualising the content of a :class:`.Buffer`.
+    Control for visualizing the content of a :class:`.Buffer`.
 
     :param buffer: The :class:`.Buffer` object to be displayed.
     :param input_processors: A list of
@@ -603,7 +603,7 @@ def preferred_width(self, max_available_width: int) -> int | None:
               width can be done by calculating the longest line, but this would
               require applying all the processors to each line. This is
               unfeasible for a larger document, and doing it for small
-              documents only would result in inconsistent behaviour.
+              documents only would result in inconsistent behavior.
         """
         return None
 
diff --git a/src/prompt_toolkit/layout/menus.py b/src/prompt_toolkit/layout/menus.py
@@ -679,7 +679,7 @@ def any_completion_has_meta() -> bool:
             filter=full_filter & show_meta & any_completion_has_meta,
         )
 
-        # Initialise split.
+        # Initialize split.
         super().__init__([completions_window, meta_window], z_index=z_index)
 
 
diff --git a/src/prompt_toolkit/layout/processors.py b/src/prompt_toolkit/layout/processors.py
@@ -288,7 +288,7 @@ def apply_transformation(
 
             if from_ == 0 and to == 0 and len(fragments) == 0:
                 # When this is an empty line, insert a space in order to
-                # visualise the selection.
+                # visualize the selection.
                 return Transformation([(selected_fragment, " ")])
             else:
                 for i in range(from_, to):
diff --git a/src/prompt_toolkit/lexers/pygments.py b/src/prompt_toolkit/lexers/pygments.py
@@ -31,7 +31,7 @@
 
 class SyntaxSync(metaclass=ABCMeta):
     """
-    Syntax synchroniser. This is a tool that finds a start position for the
+    Syntax synchronizer. This is a tool that finds a start position for the
     lexer. This is especially important when editing big documents; we don't
     want to start the highlighting by running the lexer from the beginning of
     the file. That is very slow when editing.
@@ -67,12 +67,12 @@ class RegexSync(SyntaxSync):
     Synchronize by starting at a line that matches the given regex pattern.
     """
 
-    # Never go more than this amount of lines backwards for synchronisation.
+    # Never go more than this amount of lines backwards for synchronization.
     # That would be too CPU intensive.
     MAX_BACKWARDS = 500
 
     # Start lexing at the start, if we are in the first 'n' lines and no
-    # synchronisation position was found.
+    # synchronization position was found.
     FROM_START_IF_NO_SYNC_POS_FOUND = 100
 
     def __init__(self, pattern: str) -> None:
@@ -88,13 +88,13 @@ def get_sync_start_position(
         lines = document.lines
 
         # Scan upwards, until we find a point where we can start the syntax
-        # synchronisation.
+        # synchronization.
         for i in range(lineno, max(-1, lineno - self.MAX_BACKWARDS), -1):
             match = pattern.match(lines[i])
             if match:
                 return i, match.start()
 
-        # No synchronisation point found. If we aren't that far from the
+        # No synchronization point found. If we aren't that far from the
         # beginning, start at the very beginning, otherwise, just try to start
         # at the current line.
         if lineno < self.FROM_START_IF_NO_SYNC_POS_FOUND:
@@ -228,7 +228,7 @@ def lex_document(self, document: Document) -> Callable[[int], StyleAndTextTuples
         line_generators: dict[LineGenerator, int] = {}
 
         def get_syntax_sync() -> SyntaxSync:
-            "The Syntax synchronisation object that we currently use."
+            "The Syntax synchronization object that we currently use."
             if self.sync_from_start():
                 return SyncFromStart()
             else:
@@ -271,7 +271,7 @@ def get_generator(i: int) -> LineGenerator:
                 return generator
 
             # No generator found. Determine starting point for the syntax
-            # synchronisation first.
+            # synchronization first.
 
             # Go at least x lines back. (Make scrolling upwards more
             # efficient.)
@@ -291,7 +291,7 @@ def get_generator(i: int) -> LineGenerator:
                 generator = create_line_generator(row, column)
 
             # If the column is not 0, ignore the first line. (Which is
-            # incomplete. This happens when the synchronisation algorithm tells
+            # incomplete. This happens when the synchronization algorithm tells
             # us to start parsing in the middle of a line.)
             if column:
                 next(generator)
@@ -316,7 +316,7 @@ def get_line(i: int) -> StyleAndTextTuples:
                         # Remove the next item from the cache.
                         # (It could happen that it's already there, because of
                         # another generator that started filling these lines,
-                        # but we want to synchronise these lines with the
+                        # but we want to synchronize these lines with the
                         # current lexer's state.)
                         if num + 1 in cache:
                             del cache[num + 1]
diff --git a/src/prompt_toolkit/output/base.py b/src/prompt_toolkit/output/base.py
@@ -66,7 +66,7 @@ def flush(self) -> None:
     @abstractmethod
     def erase_screen(self) -> None:
         """
-        Erases the screen with the background colour and moves the cursor to
+        Erases the screen with the background color and moves the cursor to
         home.
         """
 
diff --git a/src/prompt_toolkit/output/vt100.py b/src/prompt_toolkit/output/vt100.py
diff --git a/src/prompt_toolkit/patch_stdout.py b/src/prompt_toolkit/patch_stdout.py
diff --git a/src/prompt_toolkit/renderer.py b/src/prompt_toolkit/renderer.py
diff --git a/tests/test_formatted_text.py b/tests/test_formatted_text.py
