Skip to content

Verify

Visual verification, Figma comparison, style capture, and report generation.

9 modules

ModuleDescription
Anotar CapturaDibuja cuadros delimitadores etiquetados en capturas de pantalla para marcar diferencias
Capturar Estilos del ElementoCaptura estilos calculados del elemento del navegador
Comparar EstilosCompara los estilos capturados con los valores esperados
Obtener Estilo de FigmaObtén tokens de diseño desde la API de Figma (el token permanece local)
Generar InformeGenera un informe de verificación en HTML/JSON/Markdown
Cargar Conjunto de ReglasCarga reglas de verificación desde un archivo YAML
Ejecutar VerificaciónEjecuta verificación de diseño completa: capturar → comparar → informar
Ejecutar Verificación de EspecificacionesVerificación de especificaciones dinámicas - compón cualquier módulo a través de YAML
Diferencia VisualCompara visualmente el diseño de referencia con el sitio de desarrollo, anota diferencias

Modules

Anotar Captura

verify.annotate

Dibuja cuadros delimitadores etiquetados en capturas de pantalla para marcar diferencias

Parameters:

NameTypeRequiredDefaultDescription
image_pathstringYes-Ruta a la imagen de la captura de pantalla
annotationsarrayYes-Arreglo de anotaciones: [{label, x, y, width, height, color?, description?}]
output_pathstringNo-Ruta de salida para la imagen anotada (por defecto: añade sufijo _annotated)

Output:

FieldTypeDescription
output_pathstringRuta a la imagen anotada
annotation_countintegerNúmero de anotaciones dibujadas

Capturar Estilos del Elemento

verify.capture

Captura estilos calculados del elemento del navegador

Parameters:

NameTypeRequiredDefaultDescription
urlstringYes-URL to capture from
selectorstringYes-CSS selector
wait_forstringNo-Wait for selector before capture
viewport_widthnumberNo1280Viewport width
viewport_heightnumberNo800Viewport height

Output:

FieldTypeDescription
elementobjectCaptured element with styles
foundbooleanWhether element was found

Comparar Estilos

verify.compare

Compara los estilos capturados con los valores esperados

Parameters:

NameTypeRequiredDefaultDescription
actualobjectYes-Captured element styles (from verify.capture)
expectedobjectYes-Expected styles to compare against
selectorstringNo-Selector for reporting
size_tolerancenumberNo2.0Tolerance for size (px)
spacing_tolerancenumberNo2.0Tolerance for spacing (px)
font_size_tolerancenumberNo1.0Tolerance for font size (px)
color_tolerancenumberNo5Tolerance for color (0-255)
check_typographybooleanNoTrueCheck typography
check_colorsbooleanNoTrueCheck colors
check_spacingbooleanNoTrueCheck spacing
check_sizingbooleanNoFalseCheck sizing

Output:

FieldTypeDescription
passedbooleanWhether comparison passed
violationsarrayList of violations found
error_countnumberNumber of errors
warning_countnumberNumber of warnings

Obtener Estilo de Figma

verify.figma

Obtén tokens de diseño desde la API de Figma (el token permanece local)

Parameters:

NameTypeRequiredDefaultDescription
file_idstringYes-Figma file key (from URL)
node_idstringNo-Specific node ID to fetch
node_namestringNo-Find node by name
tokenstringNo-Figma token (or use FIGMA_TOKEN env var)

Output:

FieldTypeDescription
nodeobjectFigma node data
styleobjectExtracted style

Generar Informe

verify.report

Genera un informe de verificación en HTML/JSON/Markdown

Parameters:

NameTypeRequiredDefaultDescription
resultsarrayYes-Comparison results from verify.compare
namestringNoverify-reportReport name
urlstringNo-URL that was verified
formatstringNohtmlOutput format (html, json, markdown, all)
output_dirstringNo./verify-reportsOutput directory
screenshotsarrayNo-Screenshot paths to include

Output:

FieldTypeDescription
report_pathstringPath to generated report
summaryobjectSummary statistics

Cargar Conjunto de Reglas

verify.ruleset

Carga reglas de verificación desde un archivo YAML

Parameters:

NameTypeRequiredDefaultDescription
pathstringYes-Path to YAML ruleset file

Output:

FieldTypeDescription
rulesetobjectParsed ruleset
rules_countintegerNumber of rules

Ejecutar Verificación

verify.run

Ejecuta verificación de diseño completa: capturar → comparar → informar

Parameters:

NameTypeRequiredDefaultDescription
urlstringYes-URL to verify
selectorsarrayNo-CSS selectors to verify
ruleset_pathstringNo-Path to YAML ruleset file
expected_stylesobjectNo-Expected styles per selector
figma_file_idstringNo-Figma file ID for comparison
figma_tokenstringNo-Figma token (or FIGMA_TOKEN env)
figma_mappingobjectNo-Selector to Figma node mapping
output_dirstringNo./verify-reportsOutput directory
report_formatstringNohtmlReport format
take_screenshotbooleanNoTrueCapture screenshot
viewport_widthnumberNo1280Viewport width
viewport_heightnumberNo800Viewport height

Output:

FieldTypeDescription
passedbooleanOverall verification passed
summaryobjectSummary statistics
report_pathstringPath to generated report

Example: Example

yaml
url: http://localhost:3000
selectors: ["button[type=\"submit\"]", "input[type=\"email\"]"]

Example: Example

yaml
url: http://localhost:3000
selectors: ["button.primary"]
figma_file_id: abc123xyz
figma_mapping: {"button.primary": "Primary Button"}

Example: Example

yaml
url: http://localhost:3000
ruleset_path: ./design-rules.yaml

Ejecutar Verificación de Especificaciones

verify.spec

Verificación de especificaciones dinámicas - compón cualquier módulo a través de YAML

Parameters:

NameTypeRequiredDefaultDescription
ruleset_pathstringNo-Path to YAML ruleset file
rulesetobjectNo-Inline ruleset object

Output:

FieldTypeDescription
passedboolean
summaryobject
resultsarray

Diferencia Visual

verify.visual_diff

Compara visualmente el diseño de referencia con el sitio de desarrollo, anota diferencias

Parameters:

NameTypeRequiredDefaultDescription
reference_urlstringYes-URL o ruta local de la imagen de diseño de referencia
dev_urlstringYes-URL del sitio de desarrollo para comparar
output_dirstringNo./verify-reports/visual-diffDirectorio de salida para informes
focus_areasarrayNo-Áreas a enfocar (ej. ["encabezado", "formulario de inicio de sesión"])
viewport_widthnumberNo1280Ancho del viewport del navegador
viewport_heightnumberNo800Altura del viewport del navegador
modelstringNogpt-4oModelo de visión a usar
api_keystringNo-Clave API de OpenAI (o usa la variable de entorno OPENAI_API_KEY)

Output:

FieldTypeDescription
similarity_scorenumberPorcentaje de similitud (0-100)
annotationsarrayLista de diferencias anotadas
annotated_imagestringRuta a la captura de pantalla anotada
report_pathstringRuta al informe HTML
summarystringResumen de diferencias

Released under the Apache 2.0 License.