Skip to main content

Module checkstyle

Module checkstyle 

Source
Expand description

Checkstyle 4.3 XML writer for OffenderRecord batches.

Checkstyle is the de-facto interchange format for Jenkins, SonarQube, GitLab, and most “warnings plugin” CI integrations. We emit a single XML document covering every offender, grouped by source path:

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="4.3">
  <file name="src/foo.rs">
    <error line="42" column="5" severity="warning"
           message="cyclomatic 17 exceeds limit 15"
           source="big-code-analysis.cyclomatic"/>
  </file>
</checkstyle>

XML escaping is hand-rolled because the surface is tiny (five entities in attribute values) and adding a new dependency is not worth it for that.

Functions§

write_checkstyle
Write Checkstyle 4.3 XML for offenders to writer.