Skip to content

Verify

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

9 modules

ModuleDescription
स्क्रीनशॉट पर टिप्पणी करेंस्क्रीनशॉट पर लेबल वाले बॉक्स बनाएं और अंतर चिह्नित करें
तत्व शैलियों को कैप्चर करेंब्राउज़र तत्व से गणना की गई शैलियों को कैप्चर करें
शैलियों की तुलना करेंकैप्चर की गई शैलियों की अपेक्षित मानों से तुलना करें
Figma शैली प्राप्त करेंFigma API से डिज़ाइन टोकन प्राप्त करें (टोकन स्थानीय रहता है)
रिपोर्ट उत्पन्न करेंHTML/JSON/Markdown में सत्यापन रिपोर्ट उत्पन्न करें
नियम सेट लोड करेंYAML फ़ाइल से सत्यापन नियम लोड करें
सत्यापन चलाएंपूर्ण डिज़ाइन सत्यापन चलाएं: कैप्चर → तुलना → रिपोर्ट
स्पेक सत्यापन चलाएंडायनामिक स्पेक सत्यापन - YAML के माध्यम से किसी भी मॉड्यूल को संयोजित करें
विज़ुअल अंतरसंदर्भ डिज़ाइन की विकास साइट से दृश्य तुलना करें, अंतर चिह्नित करें

Modules

स्क्रीनशॉट पर टिप्पणी करें

verify.annotate

स्क्रीनशॉट पर लेबल वाले बॉक्स बनाएं और अंतर चिह्नित करें

Parameters:

NameTypeRequiredDefaultDescription
image_pathstringYes-स्क्रीनशॉट छवि का पथ
annotationsarrayYes-टिप्पणियों की सूची: [{label, x, y, width, height, color?, description?}]
output_pathstringNo-टिप्पणी की गई छवि के लिए आउटपुट पथ (डिफ़ॉल्ट: _annotated उपसर्ग जोड़ता है)

Output:

FieldTypeDescription
output_pathstringटिप्पणी की गई छवि का पथ
annotation_countintegerबनाई गई टिप्पणियों की संख्या

तत्व शैलियों को कैप्चर करें

verify.capture

ब्राउज़र तत्व से गणना की गई शैलियों को कैप्चर करें

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

शैलियों की तुलना करें

verify.compare

कैप्चर की गई शैलियों की अपेक्षित मानों से तुलना करें

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 शैली प्राप्त करें

verify.figma

Figma API से डिज़ाइन टोकन प्राप्त करें (टोकन स्थानीय रहता है)

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

रिपोर्ट उत्पन्न करें

verify.report

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

नियम सेट लोड करें

verify.ruleset

YAML फ़ाइल से सत्यापन नियम लोड करें

Parameters:

NameTypeRequiredDefaultDescription
pathstringYes-Path to YAML ruleset file

Output:

FieldTypeDescription
rulesetobjectParsed ruleset
rules_countintegerNumber of rules

सत्यापन चलाएं

verify.run

पूर्ण डिज़ाइन सत्यापन चलाएं: कैप्चर → तुलना → रिपोर्ट

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

स्पेक सत्यापन चलाएं

verify.spec

डायनामिक स्पेक सत्यापन - YAML के माध्यम से किसी भी मॉड्यूल को संयोजित करें

Parameters:

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

Output:

FieldTypeDescription
passedboolean
summaryobject
resultsarray

विज़ुअल अंतर

verify.visual_diff

संदर्भ डिज़ाइन की विकास साइट से दृश्य तुलना करें, अंतर चिह्नित करें

Parameters:

NameTypeRequiredDefaultDescription
reference_urlstringYes-संदर्भ डिज़ाइन का URL या स्थानीय छवि पथ
dev_urlstringYes-तुलना के लिए विकास साइट का URL
output_dirstringNo./verify-reports/visual-diffरिपोर्ट्स के लिए आउटपुट डायरेक्टरी
focus_areasarrayNo-ध्यान केंद्रित करने के क्षेत्र (जैसे ["हेडर", "लॉगिन फॉर्म"])
viewport_widthnumberNo1280ब्राउज़र व्यूपोर्ट चौड़ाई
viewport_heightnumberNo800ब्राउज़र व्यूपोर्ट ऊँचाई
modelstringNogpt-4oउपयोग करने के लिए विज़न मॉडल
api_keystringNo-OpenAI API कुंजी (या OPENAI_API_KEY पर्यावरण वेरिएबल का उपयोग करें)

Output:

FieldTypeDescription
similarity_scorenumberसमानता प्रतिशत (0-100)
annotationsarrayटिप्पणी किए गए अंतरों की सूची
annotated_imagestringटिप्पणी की गई स्क्रीनशॉट का पथ
report_pathstringHTML रिपोर्ट का पथ
summarystringअंतर का सारांश

Released under the Apache 2.0 License.