class Report::PMD

Overview

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

Included Modules

Extended Modules

Defined in:

report/pmd.cr

Constructors

Class Method Summary

Instance Method Summary

Macros inherited from module CLI::Macros

footer(text) footer, header(text) header, option(long_flag, description, &block)
option(short_flag, long_flag, description, &block) option

Instance methods inherited from class Report

category : String category, id : Int32 id, name : String name, render(io : IO) : Nil render, status : Status status

Class methods inherited from class Report

create_sequential_id : Int32 create_sequential_id

Macros inherited from class Report

patterns(*filenames) patterns

Constructor Detail

def self.new(category : String, name : String, files : Array(ReportFile)) #

[View source]

Class Method Detail

def self.from_path(path : Path) : Enumerable(Report) #

[View source]
def self.is_candidate?(filename : String) : Bool #

[View source]

Instance Method Detail

def category : String #
Description copied from class Report

The category this report is grouped in.

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


[View source]
def name : String #
Description copied from class Report

The name displayed for this report.

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


[View source]
def render(io : IO) : Nil #

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


[View source]
def status : Status #
Description copied from class Report

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.


[View source]