display.py 36 KB

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