Skip to content

Verify

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

9 modules

ModuleDescription
Ekran Görüntüsünü AçıklayınEkran görüntülerinde farklılıkları işaretlemek için etiketli sınırlayıcı kutular çizin
Eleman Stillerini YakalaTarayıcı elemanından hesaplanan stilleri yakala
Stilleri KarşılaştırYakalanan stilleri beklenen değerlerle karşılaştır
Figma Stili AlFigma API'den tasarım tokenlarını al (token yerel kalır)
Rapor OluşturHTML/JSON/Markdown formatında doğrulama raporu oluştur
Kural Setini YükleYAML dosyasından doğrulama kurallarını yükle
Doğrulamayı ÇalıştırTam tasarım doğrulaması çalıştır: yakala → karşılaştır → raporla
Spesifikasyon Doğrulamasını ÇalıştırDinamik spesifikasyon doğrulaması - herhangi bir modülü YAML ile birleştir
Görsel FarkReferans tasarımı ile geliştirici sitesini görsel olarak karşılaştırın, farklılıkları açıklayın

Modules

Ekran Görüntüsünü Açıklayın

verify.annotate

Ekran görüntülerinde farklılıkları işaretlemek için etiketli sınırlayıcı kutular çizin

Parameters:

NameTypeRequiredDefaultDescription
image_pathstringYes-Ekran görüntüsü resminin yolu
annotationsarrayYes-Açıklama dizisi: [{label, x, y, genişlik, yükseklik, renk?, açıklama?}]
output_pathstringNo-Açıklamalı görüntü için çıkış yolu (varsayılan: _annotated eki ekler)

Output:

FieldTypeDescription
output_pathstringAçıklamalı görüntünün yolu
annotation_countintegerÇizilen açıklama sayısı

Eleman Stillerini Yakala

verify.capture

Tarayıcı elemanından hesaplanan stilleri yakala

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

Stilleri Karşılaştır

verify.compare

Yakalanan stilleri beklenen değerlerle karşılaştır

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

Figma Stili Al

verify.figma

Figma API'den tasarım tokenlarını al (token yerel kalır)

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

Rapor Oluştur

verify.report

HTML/JSON/Markdown formatında doğrulama raporu oluştur

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

Kural Setini Yükle

verify.ruleset

YAML dosyasından doğrulama kurallarını yükle

Parameters:

NameTypeRequiredDefaultDescription
pathstringYes-Path to YAML ruleset file

Output:

FieldTypeDescription
rulesetobjectParsed ruleset
rules_countintegerNumber of rules

Doğrulamayı Çalıştır

verify.run

Tam tasarım doğrulaması çalıştır: yakala → karşılaştır → raporla

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

Spesifikasyon Doğrulamasını Çalıştır

verify.spec

Dinamik spesifikasyon doğrulaması - herhangi bir modülü YAML ile birleştir

Parameters:

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

Output:

FieldTypeDescription
passedboolean
summaryobject
resultsarray

Görsel Fark

verify.visual_diff

Referans tasarımı ile geliştirici sitesini görsel olarak karşılaştırın, farklılıkları açıklayın

Parameters:

NameTypeRequiredDefaultDescription
reference_urlstringYes-Referans tasarımının URL'si veya yerel resim yolu
dev_urlstringYes-Karşılaştırılacak geliştirme sitesinin URL'si
output_dirstringNo./verify-reports/visual-diffRaporlar için çıkış dizini
focus_areasarrayNo-Odaklanılacak alanlar (örneğin ["başlık", "giriş formu"])
viewport_widthnumberNo1280Tarayıcı görünüm alanı genişliği
viewport_heightnumberNo800Tarayıcı görünüm alanı yüksekliği
modelstringNogpt-4oKullanılacak görsel model
api_keystringNo-OpenAI API anahtarı (veya OPENAI_API_KEY ortam değişkenini kullanın)

Output:

FieldTypeDescription
similarity_scorenumberBenzerlik yüzdesi (0-100)
annotationsarrayAçıklamalı farklılıkların listesi
annotated_imagestringAçıklamalı ekran görüntüsünün yolu
report_pathstringHTML raporunun yolu
summarystringFarklılıkların özeti

Released under the Apache 2.0 License.