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

Add source Attribute to Checkstyle Format #2056

Open
nyamada100 opened this issue May 30, 2024 · 1 comment · May be fixed by #2078
Open

Add source Attribute to Checkstyle Format #2056

nyamada100 opened this issue May 30, 2024 · 1 comment · May be fixed by #2078
Labels

Comments

@nyamada100
Copy link

Introduction

When using reviewdog to read tflint's checkstyle format output, the rule IDs from tflint are not displayed.

Proposal

reviewdog refers to the source attribute when reading the checkstyle format, but the source attribute is missing in tflint's checkstyle format.

Please add the source attribute to tflint's checkstyle format output. For example, the content of the Rule attribute could be used as the source.

References

https://github.com/reviewdog/reviewdog/blob/master/parser/checkstyle.go,
reviewdog/action-tflint#87

@wata727
Copy link
Member

wata727 commented May 30, 2024

Indeed, it seems that Checkstyle's XML output requires the source attribute.
https://github.com/checkstyle/checkstyle/blob/a7042e5119e6df9b8f782751af6cae2ee54a215a/src/main/java/com/puppycrawl/tools/checkstyle/XMLLogger.java#L205-L224

Based on past history, there seems to be no reason to use the rule attribute, so this proposal seems reasonable.
#82
#122

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging a pull request may close this issue.

2 participants