Skip to content
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.

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

Resource names with a space in them are line split in markdown, breaking formatting #82

Closed
robzr opened this issue Nov 13, 2024 · 4 comments · Fixed by #83
Closed

Resource names with a space in them are line split in markdown, breaking formatting #82

robzr opened this issue Nov 13, 2024 · 4 comments · Fixed by #83
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@robzr
Copy link

robzr commented Nov 13, 2024

Example of generated markdown from 0.3.13. Note that this is not a regression, this has been happening as long as I've used tf-summarize:

| CHANGE |                      RESOURCE                       |
|--------|-----------------------------------------------------|
| add    | `github_organization_ruleset.this["Org              |
|        | Require Signatures"]`                               |
|        | `github_repository_ruleset.this["repo-next/Code     |
|        | Freeze"]`                                           |

Renders as:

CHANGE RESOURCE
add `github_organization_ruleset.this["Org
Require Signatures"]`
`github_repository_ruleset.this["repo-next/Code
Freeze"]`
@dineshba
Copy link
Owner

Thanks for reporting this issue @robzr . I was able to reproduce this issue.

If the resource name has space in-between and if it crossed certain length, then this auto-wrapping happen and goes into new line which creates invalid table row syntax.

Doesn't look like quick fix. I will try to fix it soon. Code location. If anyone able to fix it, please feel free to raise PR

@dineshba dineshba added help wanted Extra attention is needed good first issue Good for newcomers labels Nov 17, 2024
@wobondar
Copy link
Contributor

I'll try to tackle the issue.

@dineshba @robzr, should the expected behaviour be like such?

| CHANGE |                           RESOURCE                           |
|--------|--------------------------------------------------------------|
| add    | `github_organization_ruleset.this["Org Require Signatures"]` |
|        | `github_repository_ruleset.this["repo-next/Code Freeze"]`    |

that will render as:

CHANGE RESOURCE
add github_organization_ruleset.this["Org Require Signatures"]
github_repository_ruleset.this["repo-next/Code Freeze"]

wobondar added a commit to wobondar/tf-summarize that referenced this issue Nov 29, 2024

Verified

This commit was signed with the committer’s verified signature.
)
@wobondar
Copy link
Contributor

@dineshba please have a look on PR #83

dineshba pushed a commit that referenced this issue Nov 30, 2024
@dineshba
Copy link
Owner

dineshba commented Nov 30, 2024

Released as part of v0.3.14 version... @robzr thanks for reporting and @wobondar thanks for fixing it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants