Content

• Content
• Overview
• Description
• Xml report

Overview

Checkstyle can generate XML, SARIF and plain text reports of its findings.

Description

The source attribute of the error tag contains the fully qualified class name of the check that generated the violation.

When a custom ID is provided for a check, the format becomes: source="fully.qualified.ClassName#customId"

Xml report

The XML report schema is available at: checkstyle-report-1.0.0.xsd

Use this schema to validate XML output from Checkstyle's report generation.

Below is an example of a Checkstyle XML report:

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="10.0">
  <file name="com/puppycrawl/tools/checkstyle/Main.java">
    <error line="1" column="1" severity="error"
      message="Missing package-info.java file."
      source="com.puppycrawl.tools.checkstyle.checks.coding.MissingPackageInfoCheck"/>
  </file>
</checkstyle>