{"id":18291655,"url":"https://github.com/jvdieten/visual-check-testcafe","last_synced_at":"2025-04-05T10:31:04.613Z","repository":{"id":57392971,"uuid":"299737704","full_name":"jvdieten/visual-check-testcafe","owner":"jvdieten","description":"Testcafe plugin for testing visual regression testing multi-browser support","archived":false,"fork":false,"pushed_at":"2020-10-06T08:37:04.000Z","size":949,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-24T19:08:56.060Z","etag":null,"topics":["layout","testcafe-plugin","visual"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jvdieten.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-29T21:04:25.000Z","updated_at":"2022-05-05T10:17:03.000Z","dependencies_parsed_at":"2022-09-15T02:11:49.338Z","dependency_job_id":null,"html_url":"https://github.com/jvdieten/visual-check-testcafe","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jvdieten%2Fvisual-check-testcafe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jvdieten%2Fvisual-check-testcafe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jvdieten%2Fvisual-check-testcafe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jvdieten%2Fvisual-check-testcafe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jvdieten","download_url":"https://codeload.github.com/jvdieten/visual-check-testcafe/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247324570,"owners_count":20920675,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["layout","testcafe-plugin","visual"],"created_at":"2024-11-05T14:14:44.518Z","updated_at":"2025-04-05T10:31:03.803Z","avatar_url":"https://github.com/jvdieten.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![NPM](https://nodei.co/npm/visual-check-testcafe.png)](https://nodei.co/npm/visual-check-testcafe/)\n\n# visual-check-testcafe\n\nTestcafe plugin for testing visual regression backed by resemblejs image compare\n\n## Features\n\n- Fully integrated in test run\n- Concurrency support\n- Multi-browser support\n- Reporting including multi-browser\n\n## Installation\n\n```bash\nnpm install visual-check-testcafe --save-dev\n```\n\n## How to use\n\nYou can write a TestCafe test with automated visual testing like this.\n\n```js\nimport { visualCheck } from 'visual-check-testcafe';\n\nfixture `TestCafe tests with Visual compare`\n    .page `http://example.com`;\n\ntest('Automated visual testing', async t =\u003e {\n  await visualCheck(t, options);\n});\n\n```\n\n### Reporting\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"600\" height=\"400\" src=\"report.png\"\u003e\n\u003c/p\u003e\n\nReport will be located at .reports/visual-check-testcafe/report.html\n\n### Options\n```\nvisualCheck(t, options?)\n```\n\n- `options.label` \u0026mdash; Custom name for the taken snapshot\n- `options.timeout` \u0026mdash; Waiting time before taking snapshots\n- `options.selector` \u0026mdash; String, or `Selector()` to match on the DOM\n- `options.maxDiffPercentage`\u0026mdash; Default is 0.1 \n\n### Setup \nEach time you run tests with --setup-baseline it'll take the base screenshots.\nIt will report during test in the following way:\n\n```bash\nvisual-check-testcafe: Baseline {path} created\n```\n\nDuring a test run it can occur a baseline is not there. If you haven't provided \n the --setup-baseline your test will fail with the following message:\n\n```bash\nAssertionError: visual-check-testcafe: no baseline present, storing baseline for next run: expected 'no baseline' to be falsy\n      \n      + expected - actual\n      \n      -'no baseline'\n      +undefined\n```\n\n## RoadMap\n\n- Add configurable output folder\n- Add custom typings for testcontroller testRun\n- Add automated tests\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjvdieten%2Fvisual-check-testcafe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjvdieten%2Fvisual-check-testcafe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjvdieten%2Fvisual-check-testcafe/lists"}