scc-cli 1.5.3__py3-none-any.whl

scc_cli/ui/git_render.py

@@ -0,0 +1,176 @@
+"""Git rendering functions - pure UI components for git data display.
+
+Pure functions with no side effects beyond console output. These take
+data structures (like WorktreeInfo) and render them to Rich consoles.
+
+Extracted from git.py to separate rendering from domain logic.
+"""
+
+from rich import box
+from rich.console import Console
+from rich.table import Table
+from rich.text import Text
+
+from ..panels import create_warning_panel
+from ..services.git.branch import PROTECTED_BRANCHES, get_display_branch
+from ..services.git.worktree import WorktreeInfo
+
+
+def format_git_status(wt: WorktreeInfo) -> Text:
+    """Format git status as compact symbols: +N!N?N, . for clean, or ... for timeout.
+
+    Args:
+        wt: WorktreeInfo object with status fields populated.
+
+    Returns:
+        Rich Text with styled git status symbols.
+    """
+    # Show ellipsis if status timed out
+    if wt.status_timed_out:
+        return Text("...", style="dim")
+
+    if wt.staged_count == 0 and wt.modified_count == 0 and wt.untracked_count == 0:
+        return Text(".", style="green")
+
+    parts = Text()
+    if wt.staged_count > 0:
+        parts.append(f"+{wt.staged_count}", style="green")
+    if wt.modified_count > 0:
+        parts.append(f"!{wt.modified_count}", style="yellow")
+    if wt.untracked_count > 0:
+        parts.append(f"?{wt.untracked_count}", style="dim")
+    return parts
+
+
+def render_worktrees_table(
+    worktrees: list[WorktreeInfo],
+    console: Console,
+    *,
+    verbose: bool = False,
+) -> None:
+    """Render worktrees in a responsive table.
+
+    Args:
+        worktrees: List of WorktreeInfo objects to display.
+        console: Rich console for output.
+        verbose: If True, show git status symbols.
+    """
+    if not worktrees:
+        console.print()
+        console.print(
+            create_warning_panel(
+                "No Worktrees",
+                "No git worktrees found for this repository.",
+                "Create one with: scc worktree <repo> <feature-name>",
+            )
+        )
+        return
+
+    console.print()
+
+    # Responsive: check terminal width
+    width = console.width
+    wide_mode = width >= 110
+
+    # Create table with adaptive columns
+    table = Table(
+        title="[bold cyan]Git Worktrees[/bold cyan]",
+        box=box.ROUNDED,
+        header_style="bold cyan",
+        show_lines=False,
+        expand=True,
+        padding=(0, 1),
+    )
+
+    table.add_column("#", style="dim", width=3, justify="right")
+    table.add_column("Branch", style="cyan", no_wrap=True)
+
+    if verbose:
+        table.add_column("Status", no_wrap=True, width=10)
+
+    if wide_mode:
+        table.add_column("Path", style="dim", overflow="ellipsis", ratio=2)
+        if not verbose:
+            table.add_column("Status", style="dim", no_wrap=True, width=12)
+    else:
+        table.add_column("Path", style="dim", overflow="ellipsis", max_width=40)
+
+    for idx, wt in enumerate(worktrees, 1):
+        # Style the branch name with @ prefix for current
+        is_detached = not wt.branch
+        is_protected = wt.branch in PROTECTED_BRANCHES if wt.branch else False
+        # Use display-friendly name (strip SCC prefix)
+        branch_value = get_display_branch(wt.branch) if wt.branch else "detached"
+
+        # Add @ prefix for current worktree
+        if wt.is_current:
+            branch_display = Text("@ ", style="green bold")
+            branch_display.append(branch_value, style="cyan bold")
+        elif is_protected or is_detached:
+            branch_display = Text(branch_value, style="yellow")
+        else:
+            branch_display = Text(branch_value, style="cyan")
+
+        # Determine text status (for non-verbose wide mode)
+        text_status = wt.status or ("detached" if is_detached else "active")
+        if is_protected:
+            text_status = "protected"
+
+        status_style = {
+            "active": "green",
+            "protected": "yellow",
+            "detached": "yellow",
+            "bare": "dim",
+        }.get(text_status, "dim")
+
+        if verbose:
+            # Verbose mode: show git status symbols
+            git_status = format_git_status(wt)
+            if wide_mode:
+                table.add_row(
+                    str(idx),
+                    branch_display,
+                    git_status,
+                    wt.path,
+                )
+            else:
+                table.add_row(
+                    str(idx),
+                    branch_display,
+                    git_status,
+                    wt.path,
+                )
+        elif wide_mode:
+            table.add_row(
+                str(idx),
+                branch_display,
+                wt.path,
+                Text(text_status, style=status_style),
+            )
+        else:
+            table.add_row(
+                str(idx),
+                branch_display,
+                wt.path,
+            )
+
+    console.print(table)
+    console.print()
+
+
+def render_worktrees(
+    worktrees: list[WorktreeInfo],
+    console: Console,
+    *,
+    verbose: bool = False,
+) -> None:
+    """Render worktrees with beautiful formatting.
+
+    Public interface used by cli.py for consistent styling across the application.
+
+    Args:
+        worktrees: List of WorktreeInfo objects to display.
+        console: Rich console for output.
+        verbose: If True, show git status symbols.
+    """
+    render_worktrees_table(worktrees, console, verbose=verbose)

scc_cli/ui/help.py

@@ -0,0 +1,157 @@
+"""Help overlay for interactive UI screens.
+
+Provides mode-aware help that shows only keys relevant to the current screen.
+The overlay is triggered by pressing '?' and dismissed by any key.
+
+Key categories shown per mode:
+- ALL: Navigation (↑↓/j/k), typing to filter, backspace, t for teams
+- PICKER: Enter to select, Esc to cancel
+- MULTI_SELECT: Space to toggle, a to toggle all, Enter to confirm, Esc to cancel
+- DASHBOARD: Tab/Shift+Tab for tabs, Enter for details, q to quit
+
+Example:
+    >>> from scc_cli.ui.help import show_help_overlay
+    >>> from scc_cli.ui.list_screen import ListMode
+    >>> show_help_overlay(ListMode.SINGLE_SELECT)
+"""
+
+from __future__ import annotations
+
+from enum import Enum, auto
+from typing import TYPE_CHECKING
+
+from rich.panel import Panel
+from rich.table import Table
+from rich.text import Text
+
+from ..theme import Indicators
+
+if TYPE_CHECKING:
+    from rich.console import Console, RenderableType
+
+
+class HelpMode(Enum):
+    """Screen mode for help overlay customization."""
+
+    PICKER = auto()  # Single-select picker (team, worktree, etc.)
+    MULTI_SELECT = auto()  # Multi-select list (containers, etc.)
+    DASHBOARD = auto()  # Tabbed dashboard view
+
+
+# Mapping from HelpMode enum to string mode names used in KEYBINDING_DOCS
+_MODE_NAMES: dict[HelpMode, str] = {
+    HelpMode.PICKER: "PICKER",
+    HelpMode.MULTI_SELECT: "MULTI_SELECT",
+    HelpMode.DASHBOARD: "DASHBOARD",
+}
+
+
+def get_help_entries(mode: HelpMode) -> list[tuple[str, str]]:
+    """Get help entries filtered for a specific mode.
+
+    This function uses KEYBINDING_DOCS from keys.py as the single source
+    of truth for keybinding documentation.
+
+    Args:
+        mode: The current screen mode.
+
+    Returns:
+        List of (key, description) tuples for the given mode.
+    """
+    from .keys import get_keybindings_for_mode
+
+    mode_name = _MODE_NAMES[mode]
+    return get_keybindings_for_mode(mode_name)
+
+
+def get_help_entries_grouped(mode: HelpMode) -> dict[str, list[tuple[str, str]]]:
+    """Get help entries grouped by section for a specific mode.
+
+    This function uses KEYBINDING_DOCS from keys.py as the single source
+    of truth for keybinding documentation.
+
+    Args:
+        mode: The current screen mode.
+
+    Returns:
+        Dict mapping section names to lists of (key, description) tuples.
+    """
+    from .keys import get_keybindings_grouped_by_section
+
+    mode_name = _MODE_NAMES[mode]
+    return get_keybindings_grouped_by_section(mode_name)
+
+
+def render_help_content(mode: HelpMode) -> RenderableType:
+    """Render help content for a given mode with section headers.
+
+    Args:
+        mode: The current screen mode.
+
+    Returns:
+        A Rich renderable with the help content organized by section.
+    """
+    from rich.console import Group
+
+    grouped = get_help_entries_grouped(mode)
+
+    renderables: list[RenderableType] = []
+
+    for section_name, entries in grouped.items():
+        # Section header
+        section_header = Text()
+        sep = Indicators.get("HORIZONTAL_LINE")
+        section_header.append(f"{sep}{sep}{sep} {section_name} ", style="dim")
+        section_header.append(sep * max(0, 30 - len(section_name)), style="dim")
+        renderables.append(section_header)
+
+        # Section table
+        table = Table(show_header=False, box=None, padding=(0, 2, 0, 0))
+        table.add_column("Key", style="cyan bold", width=12)
+        table.add_column("Action", style="dim")
+
+        for key, desc in entries:
+            table.add_row(key, desc)
+
+        renderables.append(table)
+        renderables.append(Text(""))  # Spacing between sections
+
+    # Mode indicator
+    mode_display = {
+        HelpMode.PICKER: "Picker",
+        HelpMode.MULTI_SELECT: "Multi-Select",
+        HelpMode.DASHBOARD: "Dashboard",
+    }.get(mode, "Unknown")
+
+    footer = Text()
+    footer.append("Press any key to dismiss", style="dim italic")
+    renderables.append(footer)
+
+    return Panel(
+        Group(*renderables),
+        title=f"[bold]Keyboard Shortcuts[/bold] {Indicators.get('VERTICAL_LINE')} {mode_display}",
+        title_align="left",
+        border_style="blue",
+        padding=(1, 2),
+    )
+
+
+def show_help_overlay(mode: HelpMode, console: Console | None = None) -> None:
+    """Display help overlay and wait for any key to dismiss.
+
+    Args:
+        mode: The current screen mode (affects which keys are shown).
+        console: Optional console to use. If None, creates a new one.
+    """
+    if console is None:
+        from ..console import get_err_console
+
+        console = get_err_console()
+
+    content = render_help_content(mode)
+    console.print(content)
+
+    # Wait for any key to dismiss
+    from .keys import read_key
+
+    read_key()