Skip to content

fix(cli): Colorize example sections in help output #1008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tony merged 5 commits into from
Jan 11, 2026
Merged

fix(cli): Colorize example sections in help output #1008

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bb2ab46
fix(cli): Add "examples:" suffix to build_description headings
tony Jan 11, 2026
03dac31
tests(_internal/colors): Add tests for build_description heading format
tony Jan 11, 2026
9e98012
tests(cli/formatter): Add tests for examples suffix colorization
tony Jan 11, 2026
d9a00e1
tests(cli/help_examples): Add integration tests for colorized examples
tony Jan 11, 2026
1f1d4c1
docs(CHANGES): Add changelog entry for CLI example colorization fix
tony Jan 11, 2026
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
Prev Previous commit
Next Next commit
tests(cli/help_examples): Add integration tests for colorized examples 
Add integration tests to verify:
- Main --help has section headings with "examples:" suffix
- Example sections are colorized when FORCE_COLOR is set

Also update comment to reflect the new heading format.
  • Loading branch information
@tony
tony committed Jan 11, 2026
commit d9a00e1380f4a6abcf748bccdfcca82e30ecf47b
23 changes: 22 additions & 1 deletion tests/cli/test_help_examples.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ def extract_examples_from_help(help_text: str) -> list[str]:
for line in help_text.splitlines():
# Match example section headings:
# - "examples:" (default examples section)
# - "load examples:" or "load:" (category headings)
# - "load examples:" (category headings with examples suffix)
# - "Field-scoped search:" (multi-word category headings)
# Exclude argparse sections like "positional arguments:", "options:"
stripped = line.strip()
Expand Down Expand Up @@ -250,3 +250,24 @@ def test_search_no_args_shows_help() -> None:
assert "usage: tmuxp search" in result.stdout
# Should exit successfully (not error)
assert result.returncode == 0


def test_main_help_example_sections_have_examples_suffix() -> None:
"""Main --help should have section headings ending with 'examples:'."""
help_text = _get_help_text()

# Should have "load examples:", "freeze examples:", etc.
# NOT just "load:", "freeze:"
assert "load examples:" in help_text.lower()
assert "freeze examples:" in help_text.lower()


def test_main_help_examples_are_colorized(monkeypatch: pytest.MonkeyPatch) -> None:
"""Main --help should have colorized example sections when FORCE_COLOR is set."""
monkeypatch.delenv("NO_COLOR", raising=False)
monkeypatch.setenv("FORCE_COLOR", "1")

help_text = _get_help_text()

# Should contain ANSI escape codes for colorization
assert "\033[" in help_text, "Example sections should be colorized"