import FormatJSONModules from 'typhonjs-escomplex-commons/src/transform/formats/json/FormatJSONModules.js'

public class | source

FormatJSONModules

Provides a format transform for ESComplex ModuleReport / ProjectReport instances converting them to JSON that includes only the filePath, srcPath, and / or srcPathAlias of module report entries.

Member Summary

Public Members
public get	extension: string: string Gets the file extension.
public get	name: string: string Gets the format name.
public get	type: string: string Gets the format type.

Method Summary

Public Methods
public	formatReport(report: ClassReport \| MethodReport \| ModuleReport \| ProjectReport, options: object): string Formats a report as a JSON string with just module data.
public	isSupported(reportType: ReportType): boolean Returns whether a given ReportType is supported by this format transform.

Private Methods
private	_formatModule(moduleReport: ModuleReport): object Formats a module report as a JSON string.
private	_formatProject(projectReport: ProjectReport): object Formats a project report modules as a JSON string.

Public Members

public get extension: string: string source

Gets the file extension.

Return:

string

public get name: string: string source

Gets the format name.

Return:

string

public get type: string: string source

Gets the format type.

Return:

string

Public Methods

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

Formats a report as a JSON string with just module data.

Params:

Name	Type	Attribute	Description
report	ClassReport \| MethodReport \| ModuleReport \| ProjectReport		A report to format.
options	object		(Optional) One or more optional parameters passed to the formatter.

Name

Type

Attribute

Description

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:

Name	Type	Attribute	Description
spacing	number		(Optional) An integer defining the JSON output spacing.

Name

Type

Attribute

Description

spacing

number

(Optional) An integer defining the JSON output spacing.

public isSupported(reportType: ReportType): boolean source

Returns whether a given ReportType is supported by this format transform.

Params:

Name	Type	Attribute	Description
reportType	ReportType		A given report type.

Name

Type

Attribute

Description

reportType

ReportType

A given report type.

Return:

boolean

Private Methods

private _formatModule(moduleReport: ModuleReport): object source

Formats a module report as a JSON string. Please note that the exported JSON only contains data for ModuleReport instances contained in a ProjectReport.