Skip to content

feat: Enhanced Markdown Report Formatting and Readability #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 9 commits into from
Jul 1, 2025
Merged

feat: Enhanced Markdown Report Formatting and Readability #30

merged 9 commits into from
Jul 1, 2025

Conversation

@bcdady
Copy link
Contributor

@bcdady bcdady commented Jun 29, 2025 •
edited
Loading

Changes

  • Improved Change Display: Modified attribute change output to use a block quote style for better readability of before/after values
  • Action-Based Formatting: Customized attribute output based on resource action (create/update/delete)
  • Markdown Linting:
    • Added markdownlint-disable comments where needed
    • Fixed whitespace issues in Jinja2 templates
    • Ensured CommonMark compliance
  • UI Enhancements:
    • Added a link to tfsumpy in the report footer
    • Improved whitespace control in detailed output

Technical Details

  • Uses Jinja2 whitespace controls for cleaner template output
  • Implements conditional rendering based on resource action type
  • Maintains markdownlint compliance while allowing necessary HTML for styling

Testing

  • Verified markdown output with various action types
  • Ensured proper rendering in different markdown viewers
  • Confirmed markdownlint passes with minimal necessary exceptions

Closes #29

bcdady added 9 commits June 29, 2025 02:47
@bcdady
fix(plan_report): move Analysis header after if statement
1b4648a
@bcdady
fix(plan_report): format to CommonMark standards
032e1d9
@bcdady
feat(plan_report): add link to tfsumpy in footer
374a772
@bcdady
fix(plan_report): Use Jinja2 whitespace controls
ef912b8 
(- in {%- and -%})
@bcdady
style(plan_report): add markdownlint-disable-next-line comments
2fa4f16 
where Jinja2 functions and Markdown headers should be immedialy next to each other, so additional line breaks are not rendered
@bcdady
fix(plan_report): Jinja2 whitespace controls for --detailed output
bc12d50
@bcdady
style(plan_report): customize attribute output based on its resource.…
69f1017 
…action

only show both before and after attributes when an action is update or replace
@bcdady
style(plan_report): show change.attributes Before and After values in…
e6ad95a 
… Block Quote Style

This is intended to make it easier to read and compare longer values
@bcdady
test(plan_report): update test criteria
d3f6dc6
@bcdady bcdady marked this pull request as ready for review June 29, 2025 08:57
@rafaelherik rafaelherik merged commit 7c27ebc into rafaelherik:main Jul 1, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rafaelherik rafaelherik rafaelherik approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Feature] generated markdown should pass markdownlint

2 participants

@bcdady @rafaelherik