Function create_sketch_path_formatter

ci/util/output_formatter.py:191–215

Create a formatter that maps lib/FastLED paths to src/ and src/sketch paths to examples/{example}/ and timestamps lines. Args: example: Example name or path (e.g., "Pintest" or "examples/SmartMatrix"). Returns: OutputFormatter: Configured formatter instance.

(example: str)

def create_sketch_path_formatter(example: str) -> OutputFormatter:
    """Create a formatter that maps lib/FastLED paths to src/ and src/sketch paths to examples/{example}/ and timestamps lines.

    Args:
        example: Example name or path (e.g., "Pintest" or "examples/SmartMatrix").

    Returns:
        OutputFormatter: Configured formatter instance.
    """
    # Normalize example path
    display_example_str: str
    if "/" in example or "\\" in example:
        display_example_str = example.replace("\\", "/")
    else:
        display_example_str = f"examples/{example}"

    # Define multiple path substitutions
    substitutions = [
        # Replace lib/FastLED/ paths with src/ for better UX
        ("lib/FastLED", r"lib[/\\]+FastLED[/\\]+", "src/"),
        # Replace src/sketch/ paths with examples/{example}/
        ("sketch", r"src[/\\]+sketch[/\\]+", f"{display_example_str}/"),
    ]

    return _MultiPathSubstitutionFormatter(substitutions)