new_command

build_creation_panel(input_file_path, created_items, existing_items)

Build Rich panel summarizing created and existing files.

Why

The new command output is a structured panel with file statuses, next steps, and template info. Extracting this keeps the command handler focused on orchestration while this function owns presentation.

Parameters:

• input_file_path (Path) –

  Path to the generated YAML input file.

• created_items (list[tuple[str, Path]]) –

  Items that were newly created (description, path).

• existing_items (list[tuple[str, Path]]) –

  Items that already existed (description, path).

Returns:

• Panel –

  Rich Panel ready for printing.

Source code in src/rendercv/cli/new_command/new_command.py

def build_creation_panel(
    input_file_path: pathlib.Path,
    created_items: list[tuple[str, pathlib.Path]],
    existing_items: list[tuple[str, pathlib.Path]],
) -> rich.panel.Panel:
    """Build Rich panel summarizing created and existing files.

    Why:
        The ``new`` command output is a structured panel with file statuses,
        next steps, and template info. Extracting this keeps the command
        handler focused on orchestration while this function owns presentation.

    Args:
        input_file_path: Path to the generated YAML input file.
        created_items: Items that were newly created (description, path).
        existing_items: Items that already existed (description, path).

    Returns:
        Rich Panel ready for printing.
    """
    lines: list[str] = []

    # Input file status (always first)
    input_file_created = any(
        desc == "Your YAML input file" for desc, _ in created_items
    )
    if input_file_created:
        lines.append(
            "[green]✓[/green] Created your YAML input file: "
            f"[purple]./{input_file_path}[/purple]"
        )
    else:
        lines.append(
            f"Your YAML input file already exists: [purple]./{input_file_path}[/purple]"
        )

    # Next steps (always visible)
    lines.append("")
    lines.append("Next steps:")
    lines.append("  1. Edit the YAML input file with your information")
    lines.append(f"  2. Run: [cyan]rendercv render {input_file_path}[/cyan]")

    # Templates (exclude input file from these lists)
    created_templates = [
        (d, p) for d, p in created_items if d != "Your YAML input file"
    ]
    existing_templates = [
        (d, p) for d, p in existing_items if d != "Your YAML input file"
    ]

    if created_templates:
        lines.append("")
        lines.append("Also created:")
        for desc, path in created_templates:
            lines.append(f"  ○ {desc}: ./{path}")

    if existing_templates:
        lines.append("")
        lines.append("Not modified (already exist):")
        for desc, path in existing_templates:
            lines.append(f"  - {desc}: ./{path}")

    if created_templates or existing_templates:
        lines.append("")
        lines.append(
            "Templates are for advanced design customization. You can ignore or"
            " delete them."
        )

    return rich.panel.Panel(
        "\n".join(lines),
        title="Get started",
        title_align="left",
        border_style="bright_black",
    )

cli_command_new(full_name, theme='classic', locale='english', create_typst_templates=False, create_markdown_templates=False)

Source code in src/rendercv/cli/new_command/new_command.py

@app.command(
    name="new",
    help=(
        "Generate a YAML input file to get started. Example: [yellow]rendercv new"
        ' "John Doe"[/yellow]. Details: [cyan]rendercv new --help[/cyan]'
    ),
)
@handle_user_errors
def cli_command_new(
    full_name: Annotated[str, typer.Argument(help="Your full name")],
    theme: Annotated[
        str,
        typer.Option(
            help=(
                "The name of the theme (available themes are:"
                f" {', '.join(available_themes)})"
            )
        ),
    ] = "classic",
    locale: Annotated[
        str,
        typer.Option(
            help=(
                "The name of the locale (available locales are:"
                f" {', '.join(available_locales)}). You can also continue with"
                " `English`, and then write your own `locale` field for your own"
                " language."
            )
        ),
    ] = "english",
    create_typst_templates: Annotated[
        bool,
        typer.Option(
            "--create-typst-templates",
            help="Create Typst templates",
        ),
    ] = False,
    create_markdown_templates: Annotated[
        bool,
        typer.Option(
            "--create-markdown-templates",
            help="Create Markdown templates",
        ),
    ] = False,
):
    if theme not in available_themes:
        message = (
            f"Theme {theme} is not available. Available themes are:"
            f" {', '.join(available_themes)}"
        )
        raise RenderCVUserError(message)

    if locale not in available_locales:
        message = (
            f"Locale {locale} is not available. Available locales are:"
            f" {', '.join(available_locales)}"
        )
        raise RenderCVUserError(message)

    print_welcome()

    input_file_path = pathlib.Path(f"{full_name.replace(' ', '_')}_CV.yaml")
    typst_templates_folder = pathlib.Path(theme)
    markdown_folder = pathlib.Path("markdown")

    # Define all items to create: (description, path, creator, skip)
    items_to_create: list[tuple[str, pathlib.Path, Callable[[], object], bool]] = [
        (
            "Your YAML input file",
            input_file_path,
            lambda: create_sample_yaml_input_file(
                file_path=input_file_path, name=full_name, theme=theme, locale=locale
            ),
            True,  # never skip the input file
        ),
        (
            "Typst templates",
            typst_templates_folder,
            lambda: copy_templates("typst", typst_templates_folder),
            create_typst_templates,
        ),
        (
            "Markdown templates",
            markdown_folder,
            lambda: copy_templates("markdown", markdown_folder),
            create_markdown_templates,
        ),
    ]

    # Process items
    created_items: list[tuple[str, pathlib.Path]] = []
    existing_items: list[tuple[str, pathlib.Path]] = []
    for description, path, creator, create in items_to_create:
        if not create:
            continue
        if path.exists():
            existing_items.append((description, path))
        else:
            creator()
            created_items.append((description, path))

    print(build_creation_panel(input_file_path, created_items, existing_items))