feat: add debug capability to trestle jinja support

[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

[LAKSHJAIN14]

Hi, I would be interested to work on this issue. Could you please assign it to me?

Do you have any specific insights or requirements for how is it supposed to work @vikas-agarwal76

[degenaro]

@LAKSHJAIN14 I have assigned this to you. Please get input from @vikas-agarwal76 for how this functionality might work. Thx!

[LAKSHJAIN14]

Hey @degenaro @vikas-agarwal76 , the pass-through filter makes a lot of sense. Instead of print(), what if we wire it into logger.debug()? This would make the debug output opt-in (only showing up when using the -v flag) so we don't spam the terminal on normal runs.

Or are there any other things to take care of how this functionality might work ?

[degenaro]

Yes, using "print" is probably not the best choice. Would be nice to have a "unified" solution to debugging. Perhaps this is only one part of an epic that comprises a debugging strategy for all trestle commands. I suggest looking at other commands and sub-commands for how -v and --debug or other similar flags are handled.