Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/click/formatting.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,9 @@ def write_usage(self, prog: str, args: str = "", prefix: str | None = None) -> N
usage_prefix = f"{prefix:>{self.current_indent}}{prog} "
text_width = self.width - self.current_indent

if text_width >= (term_len(usage_prefix) + 20):
if not args:
self.write(usage_prefix.rstrip())
elif text_width >= (term_len(usage_prefix) + 20):
# The arguments will fit to the right of the prefix.
indent = " " * term_len(usage_prefix)
self.write(
Expand Down
21 changes: 21 additions & 0 deletions tests/test_formatting.py
Original file line number Diff line number Diff line change
Expand Up @@ -366,3 +366,24 @@ def test_help_formatter_write_text():
actual = formatter.getvalue()
expected = " Lorem ipsum dolor sit amet,\n consectetur adipiscing elit\n"
assert actual == expected


def test_write_usage_no_args():
"""write_usage should output the usage line even when args is empty."""
formatter = click.HelpFormatter()
formatter.write_usage("program")
assert formatter.getvalue() == "Usage: program\n"


def test_write_usage_with_args():
"""write_usage should still work normally with arguments."""
formatter = click.HelpFormatter()
formatter.write_usage("program", "FILE [OPTIONS]")
assert formatter.getvalue() == "Usage: program FILE [OPTIONS]\n"


def test_write_usage_no_args_custom_prefix():
"""write_usage with a custom prefix and no args."""
formatter = click.HelpFormatter()
formatter.write_usage("program", prefix="Run: ")
assert formatter.getvalue() == "Run: program\n"