Skip to content

Verify

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

9 modules

ModuleDescription
Oznacz zrzut ekranuRysuj oznaczone ramki na zrzutach ekranu, aby zaznaczyć różnice
Przechwyć style elementuPrzechwyć obliczone style z elementu przeglądarki
Porównaj stylePorównaj przechwycone style z oczekiwanymi wartościami
Pobierz styl z FigmaPobierz tokeny projektowe z Figma API (token pozostaje lokalnie)
Generuj raportGeneruj raport weryfikacji w HTML/JSON/Markdown
Załaduj zestaw zasadZaładuj zasady weryfikacji z pliku YAML
Uruchom weryfikacjęUruchom pełną weryfikację projektu: przechwyć → porównaj → raportuj
Uruchom weryfikację specyfikacjiDynamiczna weryfikacja specyfikacji - skomponuj dowolne moduły za pomocą YAML
Różnica wizualnaPorównaj wizualnie projekt referencyjny z witryną deweloperską, oznacz różnice

Modules

Oznacz zrzut ekranu

verify.annotate

Rysuj oznaczone ramki na zrzutach ekranu, aby zaznaczyć różnice

Parameters:

NameTypeRequiredDefaultDescription
image_pathstringYes-Ścieżka do obrazu zrzutu ekranu
annotationsarrayYes-Tablica adnotacji: [{label, x, y, szerokość, wysokość, kolor?, opis?}]
output_pathstringNo-Ścieżka wyjściowa dla oznaczonego obrazu (domyślnie: dodaje sufiks _annotated)

Output:

FieldTypeDescription
output_pathstringŚcieżka do oznaczonego obrazu
annotation_countintegerLiczba narysowanych adnotacji

Przechwyć style elementu

verify.capture

Przechwyć obliczone style z elementu przeglądarki

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

Porównaj style

verify.compare

Porównaj przechwycone style z oczekiwanymi wartościami

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

Pobierz styl z Figma

verify.figma

Pobierz tokeny projektowe z Figma API (token pozostaje lokalnie)

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

Generuj raport

verify.report

Generuj raport weryfikacji w 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

Załaduj zestaw zasad

verify.ruleset

Załaduj zasady weryfikacji z pliku YAML

Parameters:

NameTypeRequiredDefaultDescription
pathstringYes-Path to YAML ruleset file

Output:

FieldTypeDescription
rulesetobjectParsed ruleset
rules_countintegerNumber of rules

Uruchom weryfikację

verify.run

Uruchom pełną weryfikację projektu: przechwyć → porównaj → raportuj

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

Uruchom weryfikację specyfikacji

verify.spec

Dynamiczna weryfikacja specyfikacji - skomponuj dowolne moduły za pomocą YAML

Parameters:

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

Output:

FieldTypeDescription
passedboolean
summaryobject
resultsarray

Różnica wizualna

verify.visual_diff

Porównaj wizualnie projekt referencyjny z witryną deweloperską, oznacz różnice

Parameters:

NameTypeRequiredDefaultDescription
reference_urlstringYes-URL lub lokalna ścieżka obrazu projektu referencyjnego
dev_urlstringYes-URL witryny deweloperskiej do porównania
output_dirstringNo./verify-reports/visual-diffKatalog wyjściowy dla raportów
focus_areasarrayNo-Obszary do skupienia się (np. ["nagłówek", "formularz logowania"])
viewport_widthnumberNo1280Szerokość widoku przeglądarki
viewport_heightnumberNo800Wysokość widoku przeglądarki
modelstringNogpt-4oModel wizji do użycia
api_keystringNo-Klucz API OpenAI (lub użyj zmiennej środowiskowej OPENAI_API_KEY)

Output:

FieldTypeDescription
similarity_scorenumberProcent podobieństwa (0-100)
annotationsarrayLista oznaczonych różnic
annotated_imagestringŚcieżka do oznaczonego zrzutu ekranu
report_pathstringŚcieżka do raportu HTML
summarystringPodsumowanie różnic

Released under the Apache 2.0 License.