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

FindbugsParser - Remove bug details from message field #167

Open
PaulCormier opened this issue Dec 30, 2022 · 1 comment
Open

FindbugsParser - Remove bug details from message field #167

PaulCormier opened this issue Dec 30, 2022 · 1 comment

Comments

@PaulCormier
Copy link

In the FindbugsParser, the details of the bug is being included in the Violation's message field.

messagesPerType.put(type, shortDescription + "\n\n" + details);

These messages can be very long, and also include HTML formatting. When viewing the report in GitLab (from a CodeClimate output) the message is difficult to read, and badly formatted.

Instead of including the details in the message field, the specifics map could be used. Or perhaps a new field added to Violation.

This would facilitate emitting the details in a more appropriate output field; for instance, in the CodeClimate's content field.

@tomasbjerre
Copy link
Owner

If it is removed from message, it would affect all tools using this library. So that is a pretty big thing to do.

Same with changing the Violation model, all tools would need to be adjusted.

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

No branches or pull requests

2 participants