💫 Toolkit to help you get started with SDD or any other process!
"""Implementation of the ``specify preset info`` command."""
from __future__ import annotations
import typer
from rich.markup import escape as _escape_markup
from .._console import console
from ._catalog import PresetCatalogValidationError
from ._catalog_versions import available_versions
from .._installed_info_json import preset_info_item
from .._installed_list_json import InstalledListJSONCommand, emit_json, emit_json_error
from .._project import resolve_specify_project_root
from ._commands import preset_app
@preset_app.command("info", cls=InstalledListJSONCommand)
def preset_info(
preset_id: str = typer.Argument(..., help="Preset ID to get info about"),
versions: bool = typer.Option(False, "--versions", help="List catalog versions"),
json_output: bool = typer.Option(
False, "--json", help="Output the installed preset as JSON"
),
):
"""Show detailed information about a preset."""
from .. import _require_specify_project
from ..extensions import normalize_priority
from . import PresetCatalog, PresetError, PresetManager
# Direct compatibility callers receive Typer's OptionInfo default rather
# than a parsed bool; only the CLI's explicit True enables JSON output.
if json_output is True:
if versions is True:
emit_json_error(ValueError("--json cannot be combined with --versions"), exit_code=2)
try:
manager = PresetManager(resolve_specify_project_root())
emit_json(preset_info_item(manager.list_installed(), manager, preset_id))
return
except Exception as error: # noqa: BLE001 - emit the JSON error contract
emit_json_error(error)
project_root = _require_specify_project()
safe_preset_id = _escape_markup(str(preset_id))
if versions is True:
catalog = PresetCatalog(project_root)
try:
pack_info = catalog.get_pack_info(preset_id)
available = available_versions(pack_info) if pack_info else []
except PresetError as exc:
console.print(f"[red]Error:[/red] {_escape_markup(str(exc))}")
raise typer.Exit(1) from exc
if not available:
console.print(
f"[red]Error:[/red] No catalog versions found for {safe_preset_id}."
)
raise typer.Exit(1)
console.print(f"Catalog versions for {safe_preset_id}:")
for index, item in enumerate(available):
console.print(
f" {_escape_markup(item)}{' (current)' if index == 0 else ''}"
)
if not pack_info.get("_install_allowed", True):
console.print("[yellow]Discovery only; catalog installation is disabled.[/yellow]")
return
# Check if installed locally first
manager = PresetManager(project_root)
local_pack = manager.get_pack(preset_id)
if local_pack:
console.print(
f"\n[bold cyan]Preset: {_escape_markup(str(local_pack.name))}[/bold cyan]\n"
)
console.print(f" ID: {_escape_markup(str(local_pack.id))}")
console.print(f" Version: {_escape_markup(str(local_pack.version))}")
console.print(f" Description: {_escape_markup(str(local_pack.description))}")
if local_pack.author:
console.print(f" Author: {_escape_markup(str(local_pack.author))}")
local_tags = local_pack.tags
if isinstance(local_tags, list) and local_tags:
tags_str = _escape_markup(", ".join(str(t) for t in local_tags))
console.print(f" Tags: {tags_str}")
console.print(f" Templates: {len(local_pack.templates)}")
for tmpl in local_pack.templates:
tmpl_name = _escape_markup(str(tmpl["name"]))
tmpl_type = _escape_markup(str(tmpl["type"]))
tmpl_desc = _escape_markup(str(tmpl.get("description", "")))
console.print(f" - {tmpl_name} ({tmpl_type}): {tmpl_desc}")
repo = local_pack.data.get("preset", {}).get("repository")
if repo:
console.print(f" Repository: {_escape_markup(str(repo))}")
license_val = local_pack.data.get("preset", {}).get("license")
if license_val:
console.print(f" License: {_escape_markup(str(license_val))}")
console.print("\n [green]Status: installed[/green]")
# Get priority from registry
pack_metadata = manager.registry.get(preset_id)
priority = normalize_priority(
pack_metadata.get("priority") if isinstance(pack_metadata, dict) else None
)
console.print(f" [dim]Priority:[/dim] {priority}")
console.print()
return
# Fall back to catalog
catalog = PresetCatalog(project_root)
try:
pack_info = catalog.get_pack_info(preset_id)
except PresetCatalogValidationError as exc:
console.print(f"[red]Error:[/red] {_escape_markup(str(exc))}")
raise typer.Exit(1) from exc
except PresetError:
pack_info = None
if not pack_info:
console.print(
f"[red]Error:[/red] Preset '{preset_id}' not found (not installed and not in catalog)"
)
raise typer.Exit(1)
name = _escape_markup(str(pack_info.get("name", preset_id)))
console.print(f"\n[bold cyan]Preset: {name}[/bold cyan]\n")
console.print(f" ID: {_escape_markup(str(pack_info['id']))}")
console.print(
f" Version: {_escape_markup(str(pack_info.get('version', '?')))}"
)
console.print(
f" Description: {_escape_markup(str(pack_info.get('description', '')))}"
)
if pack_info.get("author"):
console.print(f" Author: {_escape_markup(str(pack_info['author']))}")
catalog_tags = pack_info.get("tags", [])
if isinstance(catalog_tags, list) and catalog_tags:
catalog_tags_str = _escape_markup(", ".join(str(t) for t in catalog_tags))
console.print(f" Tags: {catalog_tags_str}")
if pack_info.get("repository"):
console.print(f" Repository: {_escape_markup(str(pack_info['repository']))}")
if pack_info.get("license"):
console.print(f" License: {_escape_markup(str(pack_info['license']))}")
console.print("\n [yellow]Status: not installed[/yellow]")
console.print(f" Install with: [cyan]specify preset add {safe_preset_id}[/cyan]")
console.print()