Module reporter.html

Info:

  • Copyright: 2020 wesen
  • Release: 0.1
  • License: MIT
  • Author: wesen

Class HtmlReporter

HtmlReporter.totalCoverageData The Total coverage data
HtmlReporter.writer The Writer that generates HTML files from the Total coverage data
HtmlReporter:new (_luacovConfigurationTable) Reporter constructor.
HtmlReporter:on_start () Stub method called before reporting.
HtmlReporter:on_empty_line (_filePath, _lineNumber, _line) Stub method called for each empty source line and other lines that can't be hit.
HtmlReporter:on_mis_line (_filePath, _lineNumber, _line) Stub method called for each missed source line.
HtmlReporter:on_hit_line (_filePath, _lineNumber, _line, _numberOfHits) Stub method called for each hit source line.
HtmlReporter:on_end_file (_filePath, _numberOfHits, _numberOfMisses) Stub method called after a file has been processed.
HtmlReporter:on_end () Stub method called after reporting.


Class HtmlReporter

Luacov Reporter that generates HTML files to visualize the coverage of lines, files and directories.
HtmlReporter.totalCoverageData
The Total coverage data
  • totalCoverageData CoverageData.Total
HtmlReporter.writer
The Writer that generates HTML files from the Total coverage data
  • writer Writer
HtmlReporter:new (_luacovConfigurationTable)
Reporter constructor.

Parameters:

  • _luacovConfigurationTable table The luacov configuration table

Returns:

    Reporter The HtmlReporter instance
HtmlReporter:on_start ()
Stub method called before reporting.
HtmlReporter:on_empty_line (_filePath, _lineNumber, _line)
Stub method called for each empty source line and other lines that can't be hit.

Parameters:

  • _filePath string The file path
  • _lineNumber int The line number of the line
  • _line string The content of the line
HtmlReporter:on_mis_line (_filePath, _lineNumber, _line)
Stub method called for each missed source line.

Parameters:

  • _filePath string The file path
  • _lineNumber int The line number of the line
  • _line string The content of the line
HtmlReporter:on_hit_line (_filePath, _lineNumber, _line, _numberOfHits)
Stub method called for each hit source line.

Parameters:

  • _filePath string The file path
  • _lineNumber int The line number of the line
  • _line string The content of the line
  • _numberOfHits int The number of times the line was executed
HtmlReporter:on_end_file (_filePath, _numberOfHits, _numberOfMisses)
Stub method called after a file has been processed.

Parameters:

  • _filePath string The file path
  • _numberOfHits int The total number of hits in the file
  • _numberOfMisses int The total number of misses in the file
HtmlReporter:on_end ()
Stub method called after reporting.
generated by LDoc 1.4.6 Last updated 2020-06-01 14:04:23