References

Class Summary

Static Public Class Summary
public	ASTData Defines the output data from parsing an AST tree.
public	ASTParser `ASTParser` is a fork of `Astring`.
public	ASTState
public	ASTUtil
public	AbstractFormatText Provides the base text format transform for ModuleReport / ProjectReport instances.
public	AbstractReport Provides several helper methods to work with method oriented data stored as `this.methodAggregate` in `ClassReport` / `ModuleReport` and directly in `ClassMethodReport` / `ModuleMethodReport`.
public	AbstractSyntaxLoader Provides the base implementation for all syntax loader plugins which automatically associates member methods to syntax definitions invoking the method with escomplex settings and assigning the result to the same name as the method.
public	AbstractTextMatrix Provides the base text format transform for ProjectReport matrix list entries.
public	AggregateMethodReport Provides the aggregate report object which stores base data pertaining to a single method / function or cumulative aggregate data for a ModuleReport / ClassReport.
public	AnalyzeError Provides a wrapper for analysis errors stored in the `errors` array for each report type.
public	ClassMethodReport Provides the class method report object which stores data pertaining to a single method / function.
public	ClassReport Provides the class report object which stores data pertaining to a single ES6 class.
public	Enum This is an abstract class that is not intended to be used directly.
public	FormatJSON Provides a format transform for ESComplex report instances converting them to a JSON string.
public	FormatJSONCheckstyle Provides a format transform for ESComplex ModuleReport / ProjectReport instances converting them to JSON that corresponds to the XML checkstyle format.
public	FormatJSONMinimal Provides a format transform for ESComplex ModuleReport / ProjectReport instances converting them to JSON with minimal metrics.
public	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.
public	FormatMarkdown Provides a format transform for ModuleReport / ProjectReport instances converting them to a markdown string.
public	FormatMarkdownAdjacency Provides a format transform for ModuleReport / ProjectReport instances converting a matrix list into markdown.
public	FormatMarkdownMinimal Provides a format transform for ModuleReport / ProjectReport instances converting them to markdown with minimal metrics.
public	FormatMarkdownModules Provides a format transform for ModuleReport / ProjectReport instances converting them to markdown with just modules.
public	FormatMarkdownVisibility Provides a format transform for ModuleReport / ProjectReport instances converting a matrix list into markdown.
public	FormatText Provides a format transform for ModuleReport / ProjectReport instances converting them to plain text.
public	FormatTextAdjacency Provides a format transform for ModuleReport / ProjectReport instances converting a matrix list into plain text.
public	FormatTextMinimal Provides a format transform for ModuleReport / ProjectReport instances converting them to plain text with just modules.
public	FormatTextModules Provides a format transform for ModuleReport / ProjectReport instances converting them to plain text with just modules.
public	FormatTextVisibility Provides a format transform for ModuleReport / ProjectReport instances converting a matrix list into plain text.
public	HalsteadArray Provides a wrapper around an array of Halstead property object hashes which should contain an `identifier` field and potentially a `filter` field.
public	HalsteadAverage Provides all the averaged Halstead metric data.
public	HalsteadData Provides all Halstead metric data / parameters.
public	MathUtil Provides common math utilities.
public	MethodAverage Provides all the averaged method metric data.
public	MethodReport Provides the method report object which stores data pertaining to a single method / function.
public	ModuleAverage Provides all the averaged module metric data.
public	ModuleMethodReport Provides the module method report object which stores data pertaining to a single method / function.
public	ModuleReport Provides the module report object which stores data pertaining to a single file / module being processed.
public	ObjectUtil Provides common object manipulation utilities.
public	ProjectReport Provides the default project report object which stores data pertaining to all modules / files contained.
public	ReportType
public	SafeEntry Defines the parameters for a safe string object lookup.
public	StringUtil Provides common string utilities.
public	Trait Provides a wrapper around a data field which may be an array, function or other primitive value.
public	TraitHalstead Provides a wrapper around a data object hash which should contain an `identifier` field and potentially a `filter` field which is a function.
public	TraitUtil
public	TransformFormat

Function Summary

Static Public Function Summary
public	actualize(lloc: function \| number, cyclomatic: function \| number, operators: function \| string \| Array, operands: function \| string \| Array, ignoreKeys: function \| string \| Array, newScope: function \| string, dependencies: function \| object \| Array): {lloc: Trait, cyclomatic: Trait, operators: HalsteadArray, operands: HalsteadArray, ignoreKeys: Trait, newScope: Trait, dependencies: Trait} Provides a helper method to format core traits for escomplex processing.