formatting: don't break wrapped text at hyphens

CLI option names and other hyphenated tokens (e.g. --enable-verbose-logging)
are split at the hyphen when they fall exactly at the text-wrap boundary.
textwrap.TextWrapper.break_on_hyphens defaults to True, which is designed
for prose but is wrong for a CLI help formatter where option names, paths,
and compound identifiers must stay intact.

Pass break_on_hyphens=False to the TextWrapper so that wrap_text, and by
extension HelpFormatter.write_usage / write_text, only ever break at
whitespace.

Fixes #3362

Author: SapirBaruch

CHANGES.rst

@@ -5,6 +5,8 @@ Version 8.5.0
 
 Unreleased
 
+-   :func:`wrap_text` no longer breaks text at hyphens. CLI option names
+    such as ``--enable-verbose-logging`` now wrap only at whitespace. :issue:`3362`
 -   Supported versions of Windows enable ANSI terminal styles by default.
     Colorama is no longer a dependency and is not used. :issue:`2986` :pr:`3505`
 -   :class:`Argument` accepts a ``help`` parameter, and help output includes

src/click/formatting.py

@@ -67,6 +67,7 @@ def wrap_text(
         initial_indent=initial_indent,
         subsequent_indent=subsequent_indent,
         replace_whitespace=False,
+        break_on_hyphens=False,
     )
     if not preserve_paragraphs:
         return wrapper.fill(text)

tests/test_formatting.py

@@ -436,6 +436,30 @@ def test_help_formatter_write_text():
     assert actual == expected
 
 
+def test_wrap_text_does_not_break_at_hyphens():
+    """wrap_text must not split tokens at hyphens.
+
+    CLI option names such as ``--enable-verbose-logging`` should never be
+    broken in the middle at a hyphen; wrapping must happen only at
+    whitespace boundaries.  Regression for :issue:`3362`.
+    """
+    args = (
+        "--enable-verbose-logging --output-file-path --max-retry-count"
+        " --disable-cache-mode --config-file-location"
+    )
+    result = click.formatting.wrap_text(
+        args,
+        width=65,
+        initial_indent="Usage: program ",
+        subsequent_indent="               ",
+    )
+    for line in result.splitlines():
+        stripped = line.rstrip()
+        assert not stripped.endswith(
+            "-"
+        ), f"wrap_text broke a token at a hyphen: {stripped!r}"
+
+
 @pytest.mark.parametrize(
     ("body", "width", "initial_indent"),
     [