Skip to content

feat: add debug capability to trestle jinja support #1960

@degenaro

Description

@degenaro

Issue description / feature objectives

Presently, when there is an issue with trestle author jinja there is no ability to debug. For example, issue #1953.

Proposed:

Include the following in trestle/core/commands/author/jinja.py:

def jinja_debug_filter(value):
    print(f"DEBUG: {value}")  # Print to console for debugging
    return value  # Return the original value to maintain template flow

Then, where ever jinja Environment is created, for example:

jinja_env = Environment(
            loader=FileSystemLoader(template_folder), extensions=extensions(), trim_blocks=True, autoescape=True
        )

Follow with this code:

jinja_env.filters['debug'] = jinja_debug_filter

This will enable templates do add debugging.

In template:
{{"group.id:"~group.id|debug}}

In produced markdown:
group.id:AC.2

Caveats / Assumptions

Commensurate test cases and documentation.

Completion Criteria

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    New

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions