Function: compareText()

function compareText(
   expected, 
   actual, 
   opts): TextDiff;

Defined in: packages/uimatch-core/src/utils/text-diff.ts:101

Compare two texts with normalization and similarity analysis.

This function performs multi-level text comparison:

1. Raw string equality check
2. Normalized equality check (NFKC, whitespace, case)
3. Similarity scoring for partial matches

Parameters

expected

string

The expected text (e.g., from Figma design)

actual

string

The actual text (e.g., from implementation)

opts

TextCompareOptions = {}

Comparison options

Returns

TextDiff

Detailed comparison result

Examples

const diff = compareText('Sign in', 'SIGN  IN');
// {
//   kind: 'whitespace-or-case-only',
//   equalRaw: false,
//   equalNormalized: true,
//   similarity: 1.0
// }

const diff = compareText('Email address', 'E-mail adress');
// {
//   kind: 'mismatch',
//   equalRaw: false,
//   equalNormalized: false,
//   similarity: 0.74
// }