import CliReporter from '@ls-age/esdoc-coverage/src/lib/CliReporter.js'

public class | source

CliReporter

Reporter → CliReporter

A reporter that prints an ASCII table with all files and their coverage values.

Constructor Summary

Public Constructor
public	constructor() Creates a new CliReporter.

Public Members
public	table: cli-table~Table The table to print.

Public Methods
public	addRow(name: string, success: boolean, actual: number, expected: number, uncoveredLines: number[]) Adds a row to the table
public	finish(): Promise<Error, String> Adds a summary row to the table and prints it.
public	report(filename: string, success: boolean, actual: number, expected: number, uncoveredLines: number[]) Reports the coverage of a file.

From class Reporter
public	actual: number Number of covered identifiers.
public	expected: number Total number of identifiers.
public	notCoveredFiles: number The number of files processed but nut covered.
public	numberOfFiles: number The number of files processed.
public	success: boolean If the report has a failure.
public	finish(): Promise<Error, String> Called once all files have been processed.
public	report(filename: string, success: boolean, actual: number, expected: number, uncoveredLines: number[]) Reports the coverage of a file.

Creates a new CliReporter.

The table to print.

Adds a row to the table

Name	Type	Attribute	Description
name	string		Name of the row.
success	boolean		If the file's documentation coverage meets the threshold.
actual	number		Number of documented identifiers.
expected	number		Number of expected identifiers.
uncoveredLines	number[]		Array of line numbers not documented.

Adds a summary row to the table and prints it. Also sets the process exit code to 1 if the threshold was not met.

Resolved with the report or an error.

Reports the coverage of a file.

Name	Type	Attribute	Description
filename	string		Name of the file.
success	boolean		If the file's documentation coverage meets the threshold.
actual	number		Number of documented identifiers.
expected	number		Number of expected identifiers.
uncoveredLines	number[]		Array of line numbers not documented.