search

tomasbjerre / violations-lib

Java library for parsing report files from static code analysis.
Apache License 2.0
148 stars 39 forks source link

CodeClimateTransformer - HTML in FindBugs messages #168

Open PaulCormier opened 1 year ago

PaulCormier commented 1 year ago

This is related to #167.

The messages from the FindBugs parser contain HTML formatting, but the spec for the CodeClimate description format says "no HTML formatting."

If the FindBugs details message were removed from the description , this wouldn't be an issue, but if it were to be moved to the CodeClimate contents field, the HTML should be converted to markdown.

I have no particular suggestion for how to do the conversion, but at first glance, it looks like it's mostly paragraph tags (<p>) and <code> tags. The former could be replaced by two carriage returns, and the later by backticks.

tomasbjerre commented 1 year ago

Converting to markdown sounds like the way to go here.