Class MetricsBuilder

constructor

• new MetricsBuilder(tsConfigFilePath?: string): MetricsBuilder

  Parameters

  • OptionaltsConfigFilePath: string

  Returns MetricsBuilder

Optional ReadonlytsConfigFilePath

withName

• withName(name: Pattern, options?: PatternOptions): MetricsBuilder

  Filter classes by filename using regex pattern with glob support

  Parameters

  • name: Pattern

    String or regex pattern matching filenames only

  • Optionaloptions: PatternOptions

  Returns MetricsBuilder

inFolder

• inFolder(folderPattern: Pattern, options?: PatternOptions): MetricsBuilder

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

  Parameters

  • folderPattern: Pattern
  • Optionaloptions: PatternOptions

  Returns MetricsBuilder

inPath

• inPath(path: Pattern, options?: PatternOptions): MetricsBuilder

  Filter classes by full path using regex pattern with glob support

  Parameters

  • path: Pattern

    String or regex pattern matching full file paths

  • Optionaloptions: PatternOptions

  Returns MetricsBuilder

forClassesMatching

• forClassesMatching(
      namePattern: Pattern,
      options?: PatternOptions,
  ): MetricsBuilder

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

  Parameters

  • namePattern: Pattern

    String or regex pattern matching class names

  • Optionaloptions: PatternOptions

  Returns MetricsBuilder

getFilter

• getFilter(): CompositeFilter | null

  Returns CompositeFilter | null

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: string,
      description: string,
      calculation: CustomMetricCalculation,
  ): CustomMetricsBuilder

  Configure custom metrics with user-defined calculation and assertion logic

  Parameters

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

  Returns CustomMetricsBuilder