Home Manual Reference Source Test Repository 
import AbstractFormatText from 'typhonjs-escomplex-commons/src/transform/formats/text/AbstractFormatText.js'
public class | source

AbstractFormatText

Direct Subclass:

FormatText, FormatText

Indirect Subclass:

FormatMarkdown, FormatMarkdown

Provides the base text format transform for ModuleReport / ProjectReport instances.

Constructor Summary

Public Constructor
public

constructor(headers: object, keys: object)

Initializes instance storing default headers / keys.

Member Summary

Private Members
private
private

_keys: *

Method Summary

Public Methods
public

Formats a report as plain text.
Protected Methods
protected

_formatProject(projectReport: ProjectReport, options: object): string

Formats a project report as plain text.
Private Methods
private

_formatClass(classReport: ClassReport, options: object, prepend: string): string

Formats a class report.
private

_formatClasses(classReports: Array<ClassReport>, options: object, prepend: string): string

Formats a module reports methods array.
private

_formatEntries(report: object, entries: Array<string> | Array<string | StringUtil.SafeEntry>, prepend: string, parentPrepend: string): string | Array<string>

Formats entries for a given report based on an array of accessor entries.
private

_formatMethod(methodReport: MethodReport, options: object, prepend: string, isModule: boolean): string

Formats a method report.
private

_formatMethods(methodReports: Array<ClassMethodReport | ClassMethodReport>, options: object, prepend: string, isModule: boolean): string

Formats a module reports methods array.
private

_formatModule(report: ModuleReport, options: object): string

Formats a module report as plain text.
private

_formatModuleReport(moduleReport: ModuleReport, reportsAvailable: boolean, options: object): string

Formats a module report.
private

_formatProjectReport(projectReport: ProjectReport, options: object): string

Formats a project report.

Public Constructors

public constructor(headers: object, keys: object) source

Initializes instance storing default headers / keys.

Params:

NameTypeAttributeDescription
headers object

An object hash of header entries formatted for StringUtil.safeStringsObject.
keys object

An object hash of key entries formatted for StringUtil.safeStringsObject.

Private Members

private _headers: * source

private _keys: * source

Public Methods

public formatReport(report: ClassReport | MethodReport | ModuleReport | ProjectReport, options: object): string source

Formats a report as plain text.

Params:

NameTypeAttributeDescription
report ClassReport | MethodReport | ModuleReport | ProjectReport

A report to format.
options object

(Optional) One or more optional parameters passed to the formatter.

Return:

string

Return Properties:

NameTypeAttributeDescription
spacing number

(Optional) An integer defining the JSON output spacing.

Protected Methods

protected _formatProject(projectReport: ProjectReport, options: object): string source

Formats a project report as plain text.

Params:

NameTypeAttributeDescription
projectReport ProjectReport

A project report.
options object

(Optional) One or more optional parameters passed to the formatter.

Return:

string

Return Properties:

NameTypeAttributeDescription
classReport string

An entry key found in the class report to output.
methodReport string

An entry key found in the method report to output.
moduleReport string

An entry key found in the module report to output.

Private Methods

private _formatClass(classReport: ClassReport, options: object, prepend: string): string source

Formats a class report.

Params:

NameTypeAttributeDescription
classReport ClassReport

A class report.
options object

(Optional) One or more optional parameters passed to the formatter.
prepend string

(Optional) A string to prepend; default: ''.

Return:

string

Return Properties:

NameTypeAttributeDescription
classReport string

An entry key found in the class report to output.
methodReport string

An entry key found in the method report to output.

private _formatClasses(classReports: Array<ClassReport>, options: object, prepend: string): string source

Formats a module reports methods array.

Params:

NameTypeAttributeDescription
classReports Array<ClassReport>

An array of ClassReport instances to format.
options object

(Optional) One or more optional parameters passed to the formatter.
prepend string

(Optional) A string to prepend; default: ''.

Return:

string

Return Properties:

NameTypeAttributeDescription
classReport string

An entry key found in the class report to output.
methodReport string

An entry key found in the method report to output.

private _formatEntries(report: object, entries: Array<string> | Array<string | StringUtil.SafeEntry>, prepend: string, parentPrepend: string): string | Array<string> source

Formats entries for a given report based on an array of accessor entries.

Params:

NameTypeAttributeDescription
report object

A class / method report.
entries Array<string> | Array<string | StringUtil.SafeEntry>

(Optional) One or more optional entries to format.
prepend string

(Optional) A string to prepend; default: ''.
parentPrepend string

(Optional) The parent prepend string used for entries that are arrays with more than one entry; default: ''.

Return:

string | Array<string>

private _formatMethod(methodReport: MethodReport, options: object, prepend: string, isModule: boolean): string source

Formats a method report.

Params:

NameTypeAttributeDescription
methodReport MethodReport

A method report.
options object

(Optional) One or more optional parameters passed to the formatter.
prepend string

(Optional) A string to prepend; default: ''.
isModule boolean

(Optional) Indicates module scope; default: true.

Return:

string

Return Properties:

NameTypeAttributeDescription
methodReport string

An entry key found in the method report to output.

private _formatMethods(methodReports: Array<ClassMethodReport | ClassMethodReport>, options: object, prepend: string, isModule: boolean): string source

Formats a module reports methods array.

Params:

NameTypeAttributeDescription
methodReports Array<ClassMethodReport | ClassMethodReport>

An array of method report instances to format.
options object

(Optional) One or more optional parameters passed to the formatter.
prepend string

(Optional) A string to prepend; default: ''.
isModule boolean

(Optional) Indicates module scope; default: true.

Return:

string

Return Properties:

NameTypeAttributeDescription
methodReport string

An entry key found in the method report to output.

private _formatModule(report: ModuleReport, options: object): string source

Formats a module report as plain text.

Params:

NameTypeAttributeDescription
report ModuleReport

A module report.
options object

(Optional) One or more optional parameters passed to the formatter.

Return:

string

Return Properties:

NameTypeAttributeDescription
classReport string

An entry key found in the class report to output.
methodReport string

An entry key found in the method report to output.
moduleReport string

An entry key found in the module report to output.

private _formatModuleReport(moduleReport: ModuleReport, reportsAvailable: boolean, options: object): string source

Formats a module report.

Params:

NameTypeAttributeDescription
moduleReport ModuleReport

A module report.
reportsAvailable boolean

Indicates that the report metric data is available.
options object

(Optional) One or more optional parameters passed to the formatter.

Return:

string

Return Properties:

NameTypeAttributeDescription
classReport string

Entry keys found in the class report to output.
methodReport string

Entry keys found in the method report to output.
moduleReport string

Entry keys found in the module report to output.

private _formatProjectReport(projectReport: ProjectReport, options: object): string source

Formats a project report.

Params:

NameTypeAttributeDescription
projectReport ProjectReport

A project report.
options object

(Optional) One or more optional parameters passed to the formatter.

Return:

string

Return Properties:

NameTypeAttributeDescription
projectReport string

Entry keys found in the ProjectReport to output.