oscal-compass/compliance-trestle

feat: add debug capability to trestle jinja support

Open

#1,960 opened on Oct 22, 2025

View on GitHub
 (8 comments) (0 reactions) (2 assignees)Python (103 forks)auto 404
event/slamexempt-from-stalehelp wantedmarkdown / Authorpython

Repository metrics

Stars
 (264 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Locate the Jinja Environment initialization in the author command and add a custom filter for debugging. Then document the usage in the template files.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonJinja2
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70