Class DistanceMetricsBuilder

constructor

• new DistanceMetricsBuilder(
      source?: string | MetricsBuilder,
  ): DistanceMetricsBuilder

  Parameters

  • Optionalsource: string | MetricsBuilder

  Returns DistanceMetricsBuilder

Optional ReadonlytsConfigFilePath

forFile

• forFile(fileName: string): DistanceMetricsBuilder

  Target a specific file for distance metrics analysis

  Parameters

  • fileName: string

  Returns DistanceMetricsBuilder

inFolder

• inFolder(folderPath: string): DistanceMetricsBuilder

  Target files in a specific folder for distance metrics analysis

  Parameters

  • folderPath: string

  Returns DistanceMetricsBuilder

abstractness

• abstractness(): DistanceThresholdBuilder

  Configure abstractness metric (A)

  Returns DistanceThresholdBuilder

instability

• instability(): DistanceThresholdBuilder

  Configure instability metric (I)

  Returns DistanceThresholdBuilder

distanceFromMainSequence

• distanceFromMainSequence(): DistanceThresholdBuilder

  Configure distance from main sequence metric (D)

  Returns DistanceThresholdBuilder

couplingFactor

• couplingFactor(): DistanceThresholdBuilder

  Configure coupling factor metric (CF)

  Returns DistanceThresholdBuilder

normalizedDistance

• normalizedDistance(): DistanceThresholdBuilder

  Configure normalized distance metric (ND)

  Returns DistanceThresholdBuilder

notInZoneOfPain

• notInZoneOfPain(): ZoneCondition

  Check if components are not in the Zone of Pain (concrete & stable)

  Returns ZoneCondition

notInZoneOfUselessness

• notInZoneOfUselessness(): ZoneCondition

  Check if components are not in the Zone of Uselessness (abstract & unstable)

  Returns ZoneCondition

summary

• summary(): Promise<DistanceMetricsSummary>

  Calculate comprehensive distance metrics summary

  Returns Promise<DistanceMetricsSummary>

exportAsHTML

• exportAsHTML(
      outputPath?: string,
      options?: Partial<ExportOptions>,
  ): Promise<void>

  Export distance metrics summary as HTML file

  Parameters

  • OptionaloutputPath: string
  • Optionaloptions: Partial<ExportOptions>

  Returns Promise<void>