Class DiffChecker

The DiffChecker class provides methods to compare two texts and generate structured diffs, grouped diffs, and unified diff outputs.

Index

Constructors

Properties

a b diffRun entries grouped options

Methods

computeDiff concat findGroups getASCIIDiff getCLIDiff getGroupedDiff getStructuredDiff lineDiff magnitude output preciseDiff text2lines tokenize

Constructors

constructor

new DiffChecker(a: string, b: string, opt?: DiffOptions): DiffChecker
Constructs a new DiffChecker instance for comparing two texts.
Parameters
- a: string
  The first (original) text
- b: string
  The second (modified) text
- Optionalopt: DiffOptions = {}
  Optional diff configuration
Returns DiffChecker
- Defined in utils/DiffChecker.ts:58

Properties

`Private` `Readonly`a

a: string

Original input texts and options

`Private` `Readonly`b

b: string

`Private`diffRun

diffRun: boolean = false

Flag to indicate if the diff has already been computed

`Private`entries

entries: DiffLine[] = []

Computed diff entries and groups

`Private`grouped

grouped: DiffGroup[] = []

`Private` `Readonly`options

options: Required<DiffOptions>

Methods

`Private`computeDiff

computeDiff(): void
Computes the diff between the two input texts and populates the entries and grouped arrays.

Returns void
- Defined in utils/DiffChecker.ts:116

`Private`concat

concat(input: string[]): string
Concatenates an array of tokens back into a string, respecting the diff mode.
Parameters
- input: string[]
  Array of tokens
Returns string
- Concatenated string
- Defined in utils/DiffChecker.ts:108

`Private`findGroups

findGroups(): void
Groups adjacent changed lines together, including context lines, and calculates group metrics.

Returns void
- Defined in utils/DiffChecker.ts:292

getASCIIDiff

getASCIIDiff(): string
Returns the unified diff as a plain ASCII string.

Returns string
- Unified diff (ASCII)
- Defined in utils/DiffChecker.ts:501

getCLIDiff

getCLIDiff(): string
Returns the unified diff as a CLI-colored string.

Returns string
- Unified diff (CLI colors)
- Defined in utils/DiffChecker.ts:508

getGroupedDiff

getGroupedDiff(): DiffGroup[]
Returns the grouped diff as an array of DiffGroup objects.

Returns DiffGroup[]
- Array of grouped diffs
- Defined in utils/DiffChecker.ts:494

getStructuredDiff

getStructuredDiff(): DiffLine[]
Returns the structured diff as an array of DiffLine objects.

Returns DiffLine[]
- Array of line-level diffs
- Defined in utils/DiffChecker.ts:487

`Private`lineDiff

lineDiff(a: string, b: string, line: number): void
Compares two lines and records their differences at the configured granularity.
Parameters
- a: string
  Line from the first text
- b: string
  Line from the second text
- line: number
  Line number
Returns void
- Defined in utils/DiffChecker.ts:137

`Private`magnitude

magnitude(del: number, ins: number, baseLen: number): string
Calculates the change magnitude string for a group or line.
Parameters
- del: number
  Number of deleted characters
- ins: number
  Number of inserted characters
- baseLen: number
  Base length for normalization
Returns string
- Magnitude string (e.g. "++-")
- Defined in utils/DiffChecker.ts:347

`Private`output

output(cli: boolean): string
Generates a unified diff output as a string, with optional CLI coloring.
Parameters
- cli: boolean
  If true, use CLI colors; otherwise, ASCII markup
Returns string
- Unified diff output
- Defined in utils/DiffChecker.ts:373

`Private`preciseDiff

preciseDiff(a: string, A: string, b: string, B: string): DiffEntry[]
Finds all minimal diff blocks between two tokenized strings, returning original text and positions.
Parameters
- a: string
  Original line (case preserved)
- A: string
  Original line (possibly lowercased)
- b: string
  Modified line (case preserved)
- B: string
  Modified line (possibly lowercased)
Returns DiffEntry[]
- Array of diff entries for this line
- Defined in utils/DiffChecker.ts:186

`Private`text2lines

text2lines(): { linesA: string[]; linesB: string[]; maxLen: number }
Splits both input texts into arrays of lines and returns them with the maximum line count.

Returns { linesA: string[]; linesB: string[]; maxLen: number }
- Defined in utils/DiffChecker.ts:82

`Private`tokenize

tokenize(input: string): string[]
Tokenizes a string according to the current diff mode (line or word).
Parameters
- input: string
  The string to tokenize
Returns string[]
- Array of tokens
- Defined in utils/DiffChecker.ts:95