Pint severity levels are not mapped to checkstyle severity levels in checkstyle export

[sboschman]

The severity level exported in checkstyle xml format is the pint severity (pint code) / pint severity levels). So Bug and Informational are exported as severity level values in the checkstyle xml.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="4.3">
  <file name="rule.yaml">
    <error line="289" severity="Information" message="..."></error>
...

On the other hand the defined severity levels for checkstyle are: ignore, info, warning and error.

This requires some post pint modifications on the resulting pint checkstyle xml to be able to use the xml as input for other tools, e.g. reviewdog. As these tools expect the checkstyle severity levels and are unable to handle to pint severity levels.

My suggestion is to add a simple severity mapping in the checkstyle export:

pint severity	checkstyle severity
Bug	error
Warning	warning
Informational	info

[prymitive]

That code was added in #1129, I don't use checkstyle so have no idea if it works or not.
It's been a year and nobody cared about this so I'm leaning towards removing checkstyle reported from the code since it seems to be broken and there are no tests that would validate if the produced output is valid or not.

[sboschman]

In essence the checkstyle output format works fine. We run yamllint together with Pint on our rules, using reviewdog for gh PR reporting all this time. We have some sed magic to do the severity mapping in post. So, it is just a small issue with checkstyle output imo.

Btw it does seem there is a test for the ckeckstyle reporter.

Would a PR to address the severity mapping for checkstyle help to keep the checkstyle output option in Pint? Would be a shame to throw away all the work done in #1129 .

[prymitive]

Btw it does seem there is a test for the ckeckstyle reporter.

That test only tests that the output produced didn't change, it does not validate if the output is valid & correct.

Would a PR to address the severity mapping for checkstyle help to keep the checkstyle output option in Pint?

Yes, if you know what the actual output should be then fixing it is easy and hopefully enough.