Class MetricsBuilder

constructor

• new MetricsBuilder(tsConfigFilePath?): MetricsBuilder

• Parameters

  • Optional tsConfigFilePath: string

  Returns MetricsBuilder

Optional Readonly tsConfigFilePath

withName

• withName(name): MetricsBuilder

• Filter classes by filename using regex pattern with glob support

  Parameters

  • name: Pattern

    String or regex pattern matching filenames only

  Returns MetricsBuilder

inFolder

• inFolder(folderPattern): MetricsBuilder

• Filter classes by folder path (without filename) using regex pattern with glob support

  Parameters

  • folderPattern: Pattern

  Returns MetricsBuilder

inPath

• inPath(path): MetricsBuilder

• Filter classes by full path using regex pattern with glob support

  Parameters

  • path: Pattern

    String or regex pattern matching full file paths

  Returns MetricsBuilder

forClassesMatching

• forClassesMatching(namePattern): MetricsBuilder

• Filter classes by name using regex pattern or by string with glob support

  Parameters

  • namePattern: Pattern

    String or regex pattern matching class names

  Returns MetricsBuilder

getFilter

• getFilter(): null | CompositeFilter

• Returns null | CompositeFilter

getFiltersAsFilterArray

• getFiltersAsFilterArray(): Filter[]

• Returns Filter[]

lcom

• lcom(): LCOMMetricsBuilder

• Configure LCOM (Lack of Cohesion of Methods) metrics

  Returns LCOMMetricsBuilder

distance

• distance(): DistanceMetricsBuilder

• Configure distance metrics (Abstractness, Instability, Distance from Main Sequence)

  Returns DistanceMetricsBuilder

count

• count(): CountMetricsBuilder

• Configure count metrics (Lines of Code, Methods, Fields, etc.)

  Returns CountMetricsBuilder

customMetric

• customMetric(name, description, calculation): CustomMetricsBuilder

• Configure custom metrics with user-defined calculation and assertion logic

  Parameters

  • name: string
  • description: string
  • calculation: CustomMetricCalculation

  Returns CustomMetricsBuilder