Interface: CompareResult
Defined in: packages/uimatch-cli/src/types/index.ts:547
Comparison result
Properties
report
report: object;
Defined in: packages/uimatch-cli/src/types/index.ts:549
artifacts?
optional artifacts: object;
artifacts.diffPngB64
diffPngB64: string;
artifacts.figmaPngB64
figmaPngB64: string;
artifacts.implPngB64
implPngB64: string;
dimensions?
optional dimensions: object;
dimensions.adjusted
adjusted: boolean;
dimensions.compared
compared: object;
dimensions.compared.height
height: number;
dimensions.compared.width
width: number;
dimensions.contentRect?
optional contentRect: object;
Content rectangle coordinates (x1, y1, x2, y2) in the compared image space. Present when size adjustment creates padding and content areas differ.
dimensions.contentRect.x1
x1: number;
dimensions.contentRect.x2
x2: number;
dimensions.contentRect.y1
y1: number;
dimensions.contentRect.y2
y2: number;
dimensions.figma
figma: object;
dimensions.figma.height
height: number;
dimensions.figma.width
width: number;
dimensions.impl
impl: object;
dimensions.impl.height
height: number;
dimensions.impl.width
width: number;
dimensions.sizeMode
sizeMode: "scale" | "strict" | "pad" | "crop";
meta?
optional meta: object;
Additional metadata about the comparison
meta.figmaAutoRoi?
optional figmaAutoRoi: object;
Auto-ROI detection metadata (when figmaAutoRoi is enabled)
meta.figmaAutoRoi.applied
applied: boolean;
meta.figmaAutoRoi.from?
optional from: string;
meta.figmaAutoRoi.to?
optional to: string;
meta.figmaRootDimensionConstraints?
optional figmaRootDimensionConstraints: FigmaRootDimensionConstraint[];
Root dimension semantics retained when expectedSpec is bootstrapped in this run. A caller-supplied expectedSpec does not contain enough source information to populate it.
metrics
metrics: object;
metrics.colorDeltaEAvg
colorDeltaEAvg: number;
metrics.contentCoverage?
optional contentCoverage: number;
metrics.contentPixels?
optional contentPixels: number;
metrics.dfs
dfs: number;
metrics.pixelDiffRatio
pixelDiffRatio: number;
metrics.pixelDiffRatioContent?
optional pixelDiffRatioContent: number;
qualityGate?
optional qualityGate: QualityGateResult;
Quality gate evaluation result. Backwards-compatible JSON structure with additional fields for advanced metrics.
styleDiffs
styleDiffs: StyleDiff[];
styleSummary?
optional styleSummary: StyleSummary;
textMatch?
optional textMatch: object;
Text matching result (when textCheck is enabled)
textMatch.caseSensitive
caseSensitive: boolean;
textMatch.details?
optional details: object;
textMatch.details.extra?
optional extra: string[];
textMatch.details.missing?
optional missing: string[];
textMatch.enabled
enabled: boolean;
textMatch.equal
equal: boolean;
textMatch.figma
figma: object;
textMatch.figma.normalized
normalized: string;
textMatch.figma.raw
raw: string;
textMatch.impl
impl: object;
textMatch.impl.normalized
normalized: string;
textMatch.impl.raw
raw: string;
textMatch.match
match: "exact" | "contains" | "ratio";
textMatch.minRatio
minRatio: number;
textMatch.mode
mode: "self" | "descendants";
textMatch.normalize
normalize: "none" | "nfkc" | "nfkc_ws";
textMatch.ratio
ratio: number;
summary
summary: string;
Defined in: packages/uimatch-cli/src/types/index.ts:548