display.py 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832
  1. from __future__ import annotations
  2. import logging
  3. from pathlib import Path
  4. from typing import TYPE_CHECKING
  5. from rich.console import Console
  6. from rich.table import Table
  7. from rich.tree import Tree
  8. if TYPE_CHECKING:
  9. from .template import Template
  10. logger = logging.getLogger(__name__)
  11. console = Console()
  12. console_err = Console(stderr=True)
  13. class IconManager:
  14. """Centralized icon management system for consistent CLI display.
  15. This class provides standardized icons for file types, status indicators,
  16. and UI elements. Icons use Nerd Font glyphs for consistent display.
  17. Categories:
  18. - File types: .yaml, .j2, .json, .md, etc.
  19. - Status: success, warning, error, info, skipped
  20. - UI elements: folders, config, locks, etc.
  21. """
  22. # File Type Icons
  23. FILE_FOLDER = "\uf07b" #
  24. FILE_DEFAULT = "\uf15b" #
  25. FILE_YAML = "\uf15c" #
  26. FILE_JSON = "\ue60b" #
  27. FILE_MARKDOWN = "\uf48a" #
  28. FILE_JINJA2 = "\ue235" #
  29. FILE_DOCKER = "\uf308" #
  30. FILE_COMPOSE = "\uf308" #
  31. FILE_SHELL = "\uf489" #
  32. FILE_PYTHON = "\ue73c" #
  33. FILE_TEXT = "\uf15c" #
  34. # Status Indicators
  35. STATUS_SUCCESS = "\uf00c" # (check)
  36. STATUS_ERROR = "\uf00d" # (times/x)
  37. STATUS_WARNING = "\uf071" # (exclamation-triangle)
  38. STATUS_INFO = "\uf05a" # (info-circle)
  39. STATUS_SKIPPED = "\uf05e" # (ban/circle-slash)
  40. # UI Elements
  41. UI_CONFIG = "\ue5fc" #
  42. UI_LOCK = "\uf084" #
  43. UI_SETTINGS = "\uf013" #
  44. UI_ARROW_RIGHT = "\uf061" # (arrow-right)
  45. UI_BULLET = "\uf111" # (circle)
  46. UI_LIBRARY_GIT = "\uf418" # (git icon)
  47. UI_LIBRARY_STATIC = "\uf07c" # (folder icon)
  48. @classmethod
  49. def get_file_icon(cls, file_path: str | Path) -> str:
  50. """Get the appropriate icon for a file based on its extension or name.
  51. Args:
  52. file_path: Path to the file (can be string or Path object)
  53. Returns:
  54. Unicode icon character for the file type
  55. Examples:
  56. >>> IconManager.get_file_icon("config.yaml")
  57. '\uf15c'
  58. >>> IconManager.get_file_icon("template.j2")
  59. '\ue235'
  60. """
  61. if isinstance(file_path, str):
  62. file_path = Path(file_path)
  63. file_name = file_path.name.lower()
  64. suffix = file_path.suffix.lower()
  65. # Check for Docker Compose files
  66. compose_names = {
  67. "docker-compose.yml", "docker-compose.yaml",
  68. "compose.yml", "compose.yaml"
  69. }
  70. if file_name in compose_names or file_name.startswith("docker-compose"):
  71. return cls.FILE_DOCKER
  72. # Check by extension
  73. extension_map = {
  74. ".yaml": cls.FILE_YAML,
  75. ".yml": cls.FILE_YAML,
  76. ".json": cls.FILE_JSON,
  77. ".md": cls.FILE_MARKDOWN,
  78. ".j2": cls.FILE_JINJA2,
  79. ".sh": cls.FILE_SHELL,
  80. ".py": cls.FILE_PYTHON,
  81. ".txt": cls.FILE_TEXT,
  82. }
  83. return extension_map.get(suffix, cls.FILE_DEFAULT)
  84. @classmethod
  85. def get_status_icon(cls, status: str) -> str:
  86. """Get the appropriate icon for a status indicator.
  87. Args:
  88. status: Status type (success, error, warning, info, skipped)
  89. Returns:
  90. Unicode icon character for the status
  91. Examples:
  92. >>> IconManager.get_status_icon("success")
  93. '✓'
  94. >>> IconManager.get_status_icon("warning")
  95. '⚠'
  96. """
  97. status_map = {
  98. "success": cls.STATUS_SUCCESS,
  99. "error": cls.STATUS_ERROR,
  100. "warning": cls.STATUS_WARNING,
  101. "info": cls.STATUS_INFO,
  102. "skipped": cls.STATUS_SKIPPED,
  103. }
  104. return status_map.get(status.lower(), cls.STATUS_INFO)
  105. @classmethod
  106. def folder(cls) -> str:
  107. """Get the folder icon."""
  108. return cls.FILE_FOLDER
  109. @classmethod
  110. def config(cls) -> str:
  111. """Get the config icon."""
  112. return cls.UI_CONFIG
  113. @classmethod
  114. def lock(cls) -> str:
  115. """Get the lock icon (for sensitive variables)."""
  116. return cls.UI_LOCK
  117. @classmethod
  118. def arrow_right(cls) -> str:
  119. """Get the right arrow icon (for showing transitions/changes)."""
  120. return cls.UI_ARROW_RIGHT
  121. class DisplayManager:
  122. """Handles all rich rendering for the CLI.
  123. This class is responsible for ALL display output in the CLI, including:
  124. - Status messages (success, error, warning, info)
  125. - Tables (templates, summaries, results)
  126. - Trees (file structures, configurations)
  127. - Confirmation dialogs and prompts
  128. - Headers and sections
  129. Design Principles:
  130. - All display logic should go through DisplayManager methods
  131. - IconManager is ONLY used internally by DisplayManager
  132. - External code should never directly call IconManager or console.print
  133. - Consistent formatting across all display types
  134. """
  135. def __init__(self, quiet: bool = False):
  136. """Initialize DisplayManager.
  137. Args:
  138. quiet: If True, suppress all non-error output
  139. """
  140. self.quiet = quiet
  141. def display_templates_table(
  142. self, templates: list, module_name: str, title: str
  143. ) -> None:
  144. """Display a table of templates with library type indicators.
  145. Args:
  146. templates: List of Template objects
  147. module_name: Name of the module
  148. title: Title for the table
  149. """
  150. if not templates:
  151. logger.info(f"No templates found for module '{module_name}'")
  152. return
  153. logger.info(f"Listing {len(templates)} templates for module '{module_name}'")
  154. table = Table(title=title)
  155. table.add_column("ID", style="bold", no_wrap=True)
  156. table.add_column("Name")
  157. table.add_column("Tags")
  158. table.add_column("Version", no_wrap=True)
  159. table.add_column("Library", no_wrap=True)
  160. for template in templates:
  161. name = template.metadata.name or "Unnamed Template"
  162. tags_list = template.metadata.tags or []
  163. tags = ", ".join(tags_list) if tags_list else "-"
  164. version = str(template.metadata.version) if template.metadata.version else ""
  165. # Show library with type indicator and color
  166. library_name = template.metadata.library or ""
  167. library_type = template.metadata.library_type or "git"
  168. if library_type == "static":
  169. # Static libraries: yellow/amber color with folder icon
  170. library_display = f"[yellow]{IconManager.UI_LIBRARY_STATIC} {library_name}[/yellow]"
  171. else:
  172. # Git libraries: blue color with git icon
  173. library_display = f"[blue]{IconManager.UI_LIBRARY_GIT} {library_name}[/blue]"
  174. # Display qualified ID if present (e.g., "alloy.default")
  175. display_id = template.id
  176. table.add_row(display_id, name, tags, version, library_display)
  177. console.print(table)
  178. def display_template_details(self, template: Template, template_id: str, show_all: bool = False) -> None:
  179. """Display template information panel and variables table.
  180. Args:
  181. template: Template instance to display
  182. template_id: ID of the template
  183. show_all: If True, show all variables/sections regardless of needs satisfaction
  184. """
  185. self._display_template_header(template, template_id)
  186. self._display_file_tree(template)
  187. self._display_variables_table(template, show_all=show_all)
  188. def display_section_header(self, title: str, description: str | None) -> None:
  189. """Display a section header."""
  190. if description:
  191. console.print(f"\n[bold cyan]{title}[/bold cyan] [dim]- {description}[/dim]")
  192. else:
  193. console.print(f"\n[bold cyan]{title}[/bold cyan]")
  194. console.print("─" * 40, style="dim")
  195. def display_validation_error(self, message: str) -> None:
  196. """Display a validation error message."""
  197. self.display_message('error', message)
  198. def display_message(self, level: str, message: str, context: str | None = None) -> None:
  199. """Display a message with consistent formatting.
  200. Args:
  201. level: Message level (error, warning, success, info)
  202. message: The message to display
  203. context: Optional context information
  204. """
  205. # Errors and warnings always go to stderr, even in quiet mode
  206. # Success and info respect quiet mode and go to stdout
  207. if level in ('error', 'warning'):
  208. output_console = console_err
  209. should_print = True
  210. else:
  211. output_console = console
  212. should_print = not self.quiet
  213. if not should_print:
  214. return
  215. icon = IconManager.get_status_icon(level)
  216. colors = {'error': 'red', 'warning': 'yellow', 'success': 'green', 'info': 'blue'}
  217. color = colors.get(level, 'white')
  218. # Format message based on context
  219. if context:
  220. text = f"{level.capitalize()} in {context}: {message}" if level == 'error' or level == 'warning' else f"{context}: {message}"
  221. else:
  222. text = f"{level.capitalize()}: {message}" if level == 'error' or level == 'warning' else message
  223. output_console.print(f"[{color}]{icon} {text}[/{color}]")
  224. # Log appropriately
  225. log_message = f"{context}: {message}" if context else message
  226. log_methods = {'error': logger.error, 'warning': logger.warning, 'success': logger.info, 'info': logger.info}
  227. log_methods.get(level, logger.info)(log_message)
  228. def display_error(self, message: str, context: str | None = None) -> None:
  229. """Display an error message."""
  230. self.display_message('error', message, context)
  231. def display_warning(self, message: str, context: str | None = None) -> None:
  232. """Display a warning message."""
  233. self.display_message('warning', message, context)
  234. def display_success(self, message: str, context: str | None = None) -> None:
  235. """Display a success message."""
  236. self.display_message('success', message, context)
  237. def display_info(self, message: str, context: str | None = None) -> None:
  238. """Display an informational message."""
  239. self.display_message('info', message, context)
  240. def display_version_incompatibility(self, template_id: str, required_version: str, current_version: str) -> None:
  241. """Display a version incompatibility error with upgrade instructions.
  242. Args:
  243. template_id: ID of the incompatible template
  244. required_version: Minimum CLI version required by template
  245. current_version: Current CLI version
  246. """
  247. console_err.print()
  248. console_err.print(f"[bold red]{IconManager.STATUS_ERROR} Version Incompatibility[/bold red]")
  249. console_err.print()
  250. console_err.print(f"Template '[cyan]{template_id}[/cyan]' requires CLI version [green]{required_version}[/green] or higher.")
  251. console_err.print(f"Current CLI version: [yellow]{current_version}[/yellow]")
  252. console_err.print()
  253. console_err.print("[bold]Upgrade Instructions:[/bold]")
  254. console_err.print(f" {IconManager.UI_ARROW_RIGHT} Run: [cyan]pip install --upgrade boilerplates[/cyan]")
  255. console_err.print(f" {IconManager.UI_ARROW_RIGHT} Or install specific version: [cyan]pip install boilerplates=={required_version}[/cyan]")
  256. console_err.print()
  257. logger.error(
  258. f"Template '{template_id}' requires CLI version {required_version}, "
  259. f"current version is {current_version}"
  260. )
  261. def _display_template_header(self, template: Template, template_id: str) -> None:
  262. """Display the header for a template with library information."""
  263. template_name = template.metadata.name or "Unnamed Template"
  264. version = str(template.metadata.version) if template.metadata.version else "Not specified"
  265. description = template.metadata.description or "No description available"
  266. # Get library information
  267. library_name = template.metadata.library or ""
  268. library_type = template.metadata.library_type or "git"
  269. # Format library display with icon and color
  270. if library_type == "static":
  271. library_display = f"[yellow]{IconManager.UI_LIBRARY_STATIC} {library_name}[/yellow]"
  272. else:
  273. library_display = f"[blue]{IconManager.UI_LIBRARY_GIT} {library_name}[/blue]"
  274. console.print(
  275. f"[bold blue]{template_name} ({template_id} - [cyan]{version}[/cyan]) {library_display}[/bold blue]"
  276. )
  277. console.print(description)
  278. def _build_file_tree(self, root_label: str, files: list, get_file_info: callable) -> Tree:
  279. """Build a file tree structure.
  280. Args:
  281. root_label: Label for root node
  282. files: List of files to display
  283. get_file_info: Function that takes a file and returns (path, display_name, color, extra_text)
  284. Returns:
  285. Tree object ready for display
  286. """
  287. file_tree = Tree(root_label)
  288. tree_nodes = {Path("."): file_tree}
  289. for file_item in sorted(files, key=lambda f: get_file_info(f)[0]):
  290. path, display_name, color, extra_text = get_file_info(file_item)
  291. parts = path.parts
  292. current_path = Path(".")
  293. current_node = file_tree
  294. # Build directory structure
  295. for part in parts[:-1]:
  296. current_path = current_path / part
  297. if current_path not in tree_nodes:
  298. new_node = current_node.add(f"{IconManager.folder()} [white]{part}[/white]")
  299. tree_nodes[current_path] = new_node
  300. current_node = tree_nodes[current_path]
  301. # Add file
  302. icon = IconManager.get_file_icon(display_name)
  303. file_label = f"{icon} [{color}]{display_name}[/{color}]"
  304. if extra_text:
  305. file_label += f" {extra_text}"
  306. current_node.add(file_label)
  307. return file_tree
  308. def _display_file_tree(self, template: Template) -> None:
  309. """Display the file structure of a template."""
  310. console.print()
  311. console.print("[bold blue]Template File Structure:[/bold blue]")
  312. def get_template_file_info(template_file):
  313. display_name = template_file.output_path.name if hasattr(template_file, 'output_path') else template_file.relative_path.name
  314. return (template_file.relative_path, display_name, 'white', None)
  315. file_tree = self._build_file_tree(
  316. f"{IconManager.folder()} [white]{template.id}[/white]",
  317. template.template_files,
  318. get_template_file_info
  319. )
  320. if file_tree.children:
  321. console.print(file_tree)
  322. def _display_variables_table(self, template: Template, show_all: bool = False) -> None:
  323. """Display a table of variables for a template.
  324. Args:
  325. template: Template instance
  326. show_all: If True, show all variables/sections regardless of needs satisfaction
  327. """
  328. if not (template.variables and template.variables.has_sections()):
  329. return
  330. console.print()
  331. console.print("[bold blue]Template Variables:[/bold blue]")
  332. variables_table = Table(show_header=True, header_style="bold blue")
  333. variables_table.add_column("Variable", style="white", no_wrap=True)
  334. variables_table.add_column("Type", style="magenta")
  335. variables_table.add_column("Default", style="green")
  336. variables_table.add_column("Description", style="white")
  337. first_section = True
  338. for section in template.variables.get_sections().values():
  339. if not section.variables:
  340. continue
  341. # Skip sections with unsatisfied needs unless show_all is True
  342. if not show_all and not template.variables.is_section_satisfied(section.key):
  343. continue
  344. if not first_section:
  345. variables_table.add_row("", "", "", "", style="bright_black")
  346. first_section = False
  347. # Check if section is enabled AND dependencies are satisfied
  348. is_enabled = section.is_enabled()
  349. dependencies_satisfied = template.variables.is_section_satisfied(section.key)
  350. is_dimmed = not (is_enabled and dependencies_satisfied)
  351. # Only show (disabled) if section has no dependencies (dependencies make it obvious)
  352. # Empty list means no dependencies (same as None)
  353. has_dependencies = section.needs and len(section.needs) > 0
  354. disabled_text = " (disabled)" if (is_dimmed and not has_dependencies) else ""
  355. # For disabled sections, make entire heading bold and dim (don't include colored markup inside)
  356. if is_dimmed:
  357. # Build text without internal markup, then wrap entire thing in bold bright_black (dimmed appearance)
  358. required_part = " (required)" if section.required else ""
  359. header_text = f"[bold bright_black]{section.title}{required_part}{disabled_text}[/bold bright_black]"
  360. else:
  361. # For enabled sections, include the colored markup
  362. required_text = " [yellow](required)[/yellow]" if section.required else ""
  363. header_text = f"[bold]{section.title}{required_text}{disabled_text}[/bold]"
  364. variables_table.add_row(header_text, "", "", "")
  365. for var_name, variable in section.variables.items():
  366. # Check if variable's needs are satisfied
  367. var_satisfied = template.variables.is_variable_satisfied(var_name)
  368. # Skip variables with unsatisfied needs unless show_all is True
  369. if not show_all and not var_satisfied:
  370. continue
  371. # Dim the variable if section is dimmed OR variable needs are not satisfied
  372. row_style = "bright_black" if (is_dimmed or not var_satisfied) else None
  373. # Build default value display
  374. # If origin is 'config' and original value differs from current, show: original → config_value
  375. if (variable.origin == "config" and
  376. hasattr(variable, '_original_stored') and
  377. variable.original_value != variable.value):
  378. # Format original value (use same display logic, but shorter)
  379. if variable.sensitive:
  380. orig_display = "********"
  381. elif variable.original_value is None or variable.original_value == "":
  382. orig_display = "[dim](none)[/dim]"
  383. else:
  384. orig_val_str = str(variable.original_value)
  385. orig_display = orig_val_str[:15] + "..." if len(orig_val_str) > 15 else orig_val_str
  386. # Get current (config) value display (without showing "(none)" since we have the arrow)
  387. config_display = variable.get_display_value(mask_sensitive=True, max_length=15, show_none=False)
  388. if not config_display: # If still empty after show_none=False, show actual value
  389. config_display = str(variable.value) if variable.value else "(empty)"
  390. # Highlight the arrow and config value in bold yellow to show it's a custom override
  391. default_val = f"{orig_display} [bold yellow]{IconManager.arrow_right()} {config_display}[/bold yellow]"
  392. else:
  393. # Use variable's native get_display_value() method (shows "(none)" for empty)
  394. default_val = variable.get_display_value(mask_sensitive=True, max_length=30, show_none=True)
  395. # Add lock icon for sensitive variables
  396. sensitive_icon = f" {IconManager.lock()}" if variable.sensitive else ""
  397. # Add required indicator for required variables
  398. required_indicator = " [yellow](required)[/yellow]" if variable.required else ""
  399. var_display = f" {var_name}{sensitive_icon}{required_indicator}"
  400. variables_table.add_row(
  401. var_display,
  402. variable.type or "str",
  403. default_val,
  404. variable.description or "",
  405. style=row_style,
  406. )
  407. console.print(variables_table)
  408. def display_file_generation_confirmation(
  409. self,
  410. output_dir: Path,
  411. files: dict[str, str],
  412. existing_files: list[Path] | None = None
  413. ) -> None:
  414. """Display files to be generated with confirmation prompt."""
  415. console.print()
  416. console.print("[bold]Files to be generated:[/bold]")
  417. def get_file_generation_info(file_path_str):
  418. file_path = Path(file_path_str)
  419. file_name = file_path.parts[-1] if file_path.parts else file_path.name
  420. full_path = output_dir / file_path
  421. if existing_files and full_path in existing_files:
  422. return (file_path, file_name, 'yellow', '[red](will overwrite)[/red]')
  423. else:
  424. return (file_path, file_name, 'green', None)
  425. file_tree = self._build_file_tree(
  426. f"{IconManager.folder()} [cyan]{output_dir.resolve()}[/cyan]",
  427. files.keys(),
  428. get_file_generation_info
  429. )
  430. console.print(file_tree)
  431. console.print()
  432. def display_config_tree(self, spec: dict, module_name: str, show_all: bool = False) -> None:
  433. """Display configuration spec as a tree view.
  434. Args:
  435. spec: The configuration spec dictionary
  436. module_name: Name of the module
  437. show_all: If True, show all details including descriptions
  438. """
  439. if not spec:
  440. console.print(f"[yellow]No configuration found for module '{module_name}'[/yellow]")
  441. return
  442. # Create root tree node
  443. tree = Tree(f"[bold blue]{IconManager.config()} {str.capitalize(module_name)} Configuration[/bold blue]")
  444. for section_name, section_data in spec.items():
  445. if not isinstance(section_data, dict):
  446. continue
  447. # Determine if this is a section with variables
  448. # Guard against None from empty YAML sections
  449. section_vars = section_data.get("vars") or {}
  450. section_desc = section_data.get("description", "")
  451. section_required = section_data.get("required", False)
  452. section_toggle = section_data.get("toggle", None)
  453. section_needs = section_data.get("needs", None)
  454. # Build section label
  455. section_label = f"[cyan]{section_name}[/cyan]"
  456. if section_required:
  457. section_label += " [yellow](required)[/yellow]"
  458. if section_toggle:
  459. section_label += f" [dim](toggle: {section_toggle})[/dim]"
  460. if section_needs:
  461. needs_str = ", ".join(section_needs) if isinstance(section_needs, list) else section_needs
  462. section_label += f" [dim](needs: {needs_str})[/dim]"
  463. if show_all and section_desc:
  464. section_label += f"\n [dim]{section_desc}[/dim]"
  465. section_node = tree.add(section_label)
  466. # Add variables
  467. if section_vars:
  468. for var_name, var_data in section_vars.items():
  469. if isinstance(var_data, dict):
  470. var_type = var_data.get("type", "string")
  471. var_default = var_data.get("default", "")
  472. var_desc = var_data.get("description", "")
  473. var_sensitive = var_data.get("sensitive", False)
  474. # Build variable label
  475. var_label = f"[green]{var_name}[/green] [dim]({var_type})[/dim]"
  476. if var_default is not None and var_default != "":
  477. display_val = "********" if var_sensitive else str(var_default)
  478. if not var_sensitive and len(display_val) > 30:
  479. display_val = display_val[:27] + "..."
  480. var_label += f" = [yellow]{display_val}[/yellow]"
  481. if show_all and var_desc:
  482. var_label += f"\n [dim]{var_desc}[/dim]"
  483. section_node.add(var_label)
  484. else:
  485. # Simple key-value pair
  486. section_node.add(f"[green]{var_name}[/green] = [yellow]{var_data}[/yellow]")
  487. console.print(tree)
  488. def display_next_steps(self, next_steps: str, variable_values: dict) -> None:
  489. """Display next steps after template generation, rendering them as a Jinja2 template.
  490. Args:
  491. next_steps: The next_steps string from template metadata (may contain Jinja2 syntax)
  492. variable_values: Dictionary of variable values to use for rendering
  493. """
  494. if not next_steps:
  495. return
  496. console.print("\n[bold cyan]Next Steps:[/bold cyan]")
  497. try:
  498. from jinja2 import Template as Jinja2Template
  499. next_steps_template = Jinja2Template(next_steps)
  500. rendered_next_steps = next_steps_template.render(variable_values)
  501. console.print(rendered_next_steps)
  502. except Exception as e:
  503. logger.warning(f"Failed to render next_steps as template: {e}")
  504. # Fallback to plain text if rendering fails
  505. console.print(next_steps)
  506. def display_status_table(self, title: str, rows: list[tuple[str, str, bool]],
  507. columns: tuple[str, str] = ("Item", "Status")) -> None:
  508. """Display a status table with success/error indicators.
  509. Args:
  510. title: Table title
  511. rows: List of tuples (name, message, success_bool)
  512. columns: Column headers (name_header, status_header)
  513. """
  514. table = Table(title=title, show_header=True)
  515. table.add_column(columns[0], style="cyan", no_wrap=True)
  516. table.add_column(columns[1])
  517. for name, message, success in rows:
  518. status_style = "green" if success else "red"
  519. status_icon = IconManager.get_status_icon("success" if success else "error")
  520. table.add_row(name, f"[{status_style}]{status_icon} {message}[/{status_style}]")
  521. console.print(table)
  522. def display_summary_table(self, title: str, items: dict[str, str]) -> None:
  523. """Display a simple two-column summary table.
  524. Args:
  525. title: Table title
  526. items: Dictionary of key-value pairs to display
  527. """
  528. table = Table(title=title, show_header=False, box=None, padding=(0, 2))
  529. table.add_column(style="bold")
  530. table.add_column()
  531. for key, value in items.items():
  532. table.add_row(key, value)
  533. console.print(table)
  534. def display_file_operation_table(self, files: list[tuple[str, int, str]]) -> None:
  535. """Display a table of file operations with sizes and statuses.
  536. Args:
  537. files: List of tuples (file_path, size_bytes, status)
  538. """
  539. table = Table(show_header=True, header_style="bold cyan", box=None, padding=(0, 1))
  540. table.add_column("File", style="white", no_wrap=False)
  541. table.add_column("Size", justify="right", style="dim")
  542. table.add_column("Status", style="yellow")
  543. for file_path, size_bytes, status in files:
  544. # Format size
  545. if size_bytes < 1024:
  546. size_str = f"{size_bytes}B"
  547. elif size_bytes < 1024 * 1024:
  548. size_str = f"{size_bytes / 1024:.1f}KB"
  549. else:
  550. size_str = f"{size_bytes / (1024 * 1024):.1f}MB"
  551. table.add_row(str(file_path), size_str, status)
  552. console.print(table)
  553. def display_heading(self, text: str, icon_type: str | None = None, style: str = "bold") -> None:
  554. """Display a heading with optional icon.
  555. Args:
  556. text: Heading text
  557. icon_type: Type of icon to display (e.g., 'folder', 'file', 'config')
  558. style: Rich style to apply
  559. """
  560. if icon_type:
  561. icon = self._get_icon_by_type(icon_type)
  562. console.print(f"[{style}]{icon} {text}[/{style}]")
  563. else:
  564. console.print(f"[{style}]{text}[/{style}]")
  565. def display_warning_with_confirmation(self, message: str, details: list[str] | None = None,
  566. default: bool = False) -> bool:
  567. """Display a warning message with optional details and get confirmation.
  568. Args:
  569. message: Warning message to display
  570. details: Optional list of detail lines to show
  571. default: Default value for confirmation
  572. Returns:
  573. True if user confirms, False otherwise
  574. """
  575. icon = IconManager.get_status_icon('warning')
  576. console.print(f"\n[yellow]{icon} {message}[/yellow]")
  577. if details:
  578. for detail in details:
  579. console.print(f"[yellow] {detail}[/yellow]")
  580. from rich.prompt import Confirm
  581. return Confirm.ask("Continue?", default=default)
  582. def display_skipped(self, message: str, reason: str | None = None) -> None:
  583. """Display a skipped/disabled message.
  584. Args:
  585. message: The main message to display
  586. reason: Optional reason why it was skipped
  587. """
  588. icon = IconManager.get_status_icon('skipped')
  589. if reason:
  590. console.print(f"\n[dim]{icon} {message} (skipped - {reason})[/dim]")
  591. else:
  592. console.print(f"\n[dim]{icon} {message} (skipped)[/dim]")
  593. def get_lock_icon(self) -> str:
  594. """Get the lock icon for sensitive variables.
  595. Returns:
  596. Lock icon unicode character
  597. """
  598. return IconManager.lock()
  599. def _get_icon_by_type(self, icon_type: str) -> str:
  600. """Get icon by semantic type name.
  601. Args:
  602. icon_type: Type of icon (e.g., 'folder', 'file', 'config', 'lock')
  603. Returns:
  604. Icon unicode character
  605. """
  606. icon_map = {
  607. 'folder': IconManager.folder(),
  608. 'file': IconManager.FILE_DEFAULT,
  609. 'config': IconManager.config(),
  610. 'lock': IconManager.lock(),
  611. 'arrow': IconManager.arrow_right(),
  612. }
  613. return icon_map.get(icon_type, '')
  614. def display_template_render_error(self, error: 'TemplateRenderError', context: str | None = None) -> None:
  615. """Display a detailed template rendering error with context and suggestions.
  616. Args:
  617. error: TemplateRenderError exception with detailed error information
  618. context: Optional context information (e.g., template ID)
  619. """
  620. from rich.panel import Panel
  621. from rich.syntax import Syntax
  622. # Always display errors to stderr
  623. # Display main error header
  624. icon = IconManager.get_status_icon('error')
  625. if context:
  626. console_err.print(f"\n[red bold]{icon} Template Rendering Error[/red bold] [dim]({context})[/dim]")
  627. else:
  628. console_err.print(f"\n[red bold]{icon} Template Rendering Error[/red bold]")
  629. console_err.print()
  630. # Display error message
  631. if error.file_path:
  632. console_err.print(f"[red]Error in file:[/red] [cyan]{error.file_path}[/cyan]")
  633. if error.line_number:
  634. location = f"Line {error.line_number}"
  635. if error.column:
  636. location += f", Column {error.column}"
  637. console_err.print(f"[red]Location:[/red] {location}")
  638. console_err.print(f"[red]Message:[/red] {str(error.original_error) if error.original_error else str(error)}")
  639. console_err.print()
  640. # Display code context if available
  641. if error.context_lines:
  642. console_err.print("[bold cyan]Code Context:[/bold cyan]")
  643. # Build the context text
  644. context_text = "\n".join(error.context_lines)
  645. # Display in a panel with syntax highlighting if possible
  646. file_ext = Path(error.file_path).suffix if error.file_path else ""
  647. if file_ext == ".j2":
  648. # Remove .j2 to get base extension for syntax highlighting
  649. base_name = Path(error.file_path).stem
  650. base_ext = Path(base_name).suffix
  651. lexer = "jinja2" if not base_ext else None
  652. else:
  653. lexer = None
  654. try:
  655. if lexer:
  656. syntax = Syntax(context_text, lexer, line_numbers=False, theme="monokai")
  657. console_err.print(Panel(syntax, border_style="red", padding=(1, 2)))
  658. else:
  659. console_err.print(Panel(context_text, border_style="red", padding=(1, 2)))
  660. except Exception:
  661. # Fallback to plain panel if syntax highlighting fails
  662. console_err.print(Panel(context_text, border_style="red", padding=(1, 2)))
  663. console_err.print()
  664. # Display suggestions if available
  665. if error.suggestions:
  666. console_err.print("[bold yellow]Suggestions:[/bold yellow]")
  667. for i, suggestion in enumerate(error.suggestions, 1):
  668. bullet = IconManager.UI_BULLET
  669. console_err.print(f" [yellow]{bullet}[/yellow] {suggestion}")
  670. console_err.print()
  671. # Display variable context in debug mode
  672. if error.variable_context:
  673. console_err.print("[bold blue]Available Variables (Debug):[/bold blue]")
  674. var_list = ", ".join(sorted(error.variable_context.keys()))
  675. console_err.print(f"[dim]{var_list}[/dim]")
  676. console_err.print()