Module: lib/Reporter

lib/Reporter

A module representing Reporter
Source:

Methods

<inner> add(path, messages, standard)

Add report per file
Parameters:
Name Type Description
path string
messages Array
standard string
Source:

<inner> define(factory)

Override AMD `define` function for RequireJS
Parameters:
Name Type Description
factory function
Source:

<inner> getData() → {Object[]}

Get all collected reports data
Source:
Returns:
Type
Object[]

<inner> interpretateMarkup(markup, highlight) → {string}

Replace [color:red]..[/color] with console color codes
Parameters:
Name Type Description
markup string
highlight boolean
Source:
Returns:
Type
string

<inner> loadFormatter(formatterName, options) → {Object}

Formatter factory
Parameters:
Name Type Description
formatterName string
options Object
Source:
Returns:
Type
Object

<inner> print(highlight, injectionContent) → {string}

Render report
Parameters:
Name Type Description
string | Object formatter
highlight boolean
injectionContent string OPTIONAL content to extend report body. Handy when we extend already existing checkstyle.xml
Source:
Returns:
report content
Type
string