class

Report::PMD

Inherits CLI::Macros < Report < Reference < Object

The json-format output from the PMD source code analyzer.

Constructors

new(category : String, name : String, files : Array(ReportFile))

from_path(path : Path) : Enumerable(Report)

is_candidate?(filename : String) : Bool

category

The category this report is grouped in.

The string should be below ~20 characters to prevent the sidebar from overflowing.

name

The name displayed for this report.

The string should be below ~20 characters to prevent the sidebar from overflowing.

render(io : IO) : Nil

The json-format output from the PMD source code analyzer.

status

The status of this report.

This will control the successful-test-count in the report header, filtering options and an indicator next to the test in the sidebar.