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/formatter): Add tests for examples suffix colorization 
Add tests to verify formatter correctly colorizes section headings
ending with "examples:" even without an initial "examples:" block:
- Single "X examples:" heading is colorized
- Multiple "X examples:" sections are all colorized
  • Loading branch information
@tony
tony committed Jan 11, 2026
commit 9e98012e1271f90069363f58ec5bda6264b66420
46 changes: 46 additions & 0 deletions tests/cli/test_formatter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,3 +216,49 @@ def test_help_theme_from_colors_enabled_returns_colored(
assert "\033[" in theme.prog
assert "\033[" in theme.action
assert theme.reset == ANSI_RESET


def test_fill_text_section_heading_with_examples_suffix(
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""Section headings ending with 'examples:' are colorized without initial block."""
monkeypatch.delenv("NO_COLOR", raising=False)
colors = Colors(ColorMode.ALWAYS)
formatter_cls = create_themed_formatter(colors)
formatter = formatter_cls("tmuxp")

# This is what build_description produces - no initial "examples:" block
text = (
"load examples:\n tmuxp load myproject\n\n"
"freeze examples:\n tmuxp freeze mysession"
)
result = formatter._fill_text(text, 80, "")

# Both headings should be colorized (contain ANSI escape codes)
assert "\033[" in result
# Commands should be colorized
assert "tmuxp" in result


def test_fill_text_multiple_example_sections_all_colorized(
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""Multiple 'X examples:' sections should all be colorized."""
monkeypatch.delenv("NO_COLOR", raising=False)
colors = Colors(ColorMode.ALWAYS)
formatter_cls = create_themed_formatter(colors)
formatter = formatter_cls("tmuxp")

text = """load examples:
tmuxp load myproject

freeze examples:
tmuxp freeze mysession

ls examples:
tmuxp ls"""
result = formatter._fill_text(text, 80, "")

# All sections should have ANSI codes
# Count ANSI escape sequences - should have at least heading + command per section
assert result.count("\033[") >= 6