{"id":28515058,"url":"https://github.com/percy/percy-testcafe","last_synced_at":"2026-05-26T18:01:28.119Z","repository":{"id":35033719,"uuid":"198860000","full_name":"percy/percy-testcafe","owner":"percy","description":"TestCafe client library for visual regression testing with Percy","archived":false,"fork":false,"pushed_at":"2025-06-30T15:31:57.000Z","size":913,"stargazers_count":8,"open_issues_count":7,"forks_count":4,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-07-03T12:57:24.056Z","etag":null,"topics":["percy","percy-sdk","testcafe","visual-testing"],"latest_commit_sha":null,"homepage":"https://docs.percy.io/docs/testcafe","language":"JavaScript","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/percy.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-07-25T15:46:57.000Z","updated_at":"2024-06-24T09:27:50.000Z","dependencies_parsed_at":"2024-04-29T13:29:43.892Z","dependency_job_id":"855dbf95-7d9f-4cd6-89ab-3bbec64deafa","html_url":"https://github.com/percy/percy-testcafe","commit_stats":{"total_commits":282,"total_committers":7,"mean_commits":"40.285714285714285","dds":0.1985815602836879,"last_synced_commit":"94cfe22e1808f99704762017a3c6dcc14aa00198"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/percy/percy-testcafe","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percy%2Fpercy-testcafe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percy%2Fpercy-testcafe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percy%2Fpercy-testcafe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percy%2Fpercy-testcafe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/percy","download_url":"https://codeload.github.com/percy/percy-testcafe/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percy%2Fpercy-testcafe/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263718277,"owners_count":23500805,"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":["percy","percy-sdk","testcafe","visual-testing"],"created_at":"2025-06-09T02:35:24.811Z","updated_at":"2026-05-26T18:01:23.075Z","avatar_url":"https://github.com/percy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @percy/testcafe\n[![Version](https://img.shields.io/npm/v/@percy/testcafe.svg)](https://www.npmjs.com/package/@percy/testcafe)\n![Test](https://github.com/percy/percy-testcafe/workflows/Test/badge.svg)\n\n[Percy](https://percy.io) visual testing for\n[TestCafe](https://www.devexpress.com/products/testcafestudio/).\n\n## Installation\n\n```sh-session\n$ npm install --save-dev @percy/cli @percy/testcafe\n```\n\n## Usage\n\nThis is an example test using the `percySnapshot` function.\n\n```javascript\nimport percySnapshot from '@percy/testcafe';\n\nfixture('MyFixture')\n  .page('http://devexpress.github.io/testcafe/example');\n\ntest('Test1', async t =\u003e {\n  await t.typeText('#developer-name', 'John Doe');\n  await percySnapshot(t, 'TestCafe Example');\n});\n```\n\nRunning the test above normally will result in the following log:\n\n```sh-session\n[percy] Percy is not running, disabling snapshots\n```\n\nWhen running with [`percy\nexec`](https://github.com/percy/cli/tree/master/packages/cli-exec#percy-exec), and your project's\n`PERCY_TOKEN`, a new Percy build will be created and snapshots will be uploaded to your project.\n\n```sh-session\n$ export PERCY_TOKEN=[your-project-token]\n$ percy exec -- testcafe chrome:headless tests\n[percy] Percy has started!\n[percy] Created build #1: https://percy.io/[your-project]\n[percy] Running \"testcafe chrome:headless tests\"\n\n Running tests in:\n - Chrome ...\n\n MyFixture\n[percy] Snapshot taken \"TestCafe Example\"\n ✓ Test1\n\n 1 passed (1s)\n\n[percy] Stopping percy...\n[percy] Finalized build #1: https://percy.io/[your-project]\n[percy] Done!\n```\n\n## Configuration\n\n`percySnapshot(t, name[, options])`\n\n- `t`(**required**) - The test controller instance passed from `test`\n- `name` (**required**) - The snapshot name; must be unique to each snapshot\n- `options` - [See per-snapshot configuration options](https://www.browserstack.com/docs/percy/take-percy-snapshots/overview#per-snapshot-configuration)\n\n## Upgrading\n\n### Automatically with `@percy/migrate`\n\nWe built a tool to help automate migrating to the new CLI toolchain! Migrating\ncan be done by running the following commands and following the prompts:\n\n``` shell\n$ npx @percy/migrate\n? Are you currently using @percy/testcafe? Yes\n? Install @percy/cli (required to run percy)? Yes\n? Migrate Percy config file? Yes\n? Upgrade SDK to @percy/testcafe@1.0.0? Yes\n```\n\nThis will automatically run the changes described below for you.\n\n### Manually\n\n#### Installing `@percy/cli`\n\nIf you're coming from a pre-2.0 version of this package, make sure to install `@percy/cli` after\nupgrading to retain any existing scripts that reference the Percy CLI command.\n\n```sh-session\n$ npm install --save-dev @percy/cli\n```\n\n#### Migrating Config\n\nIf you have a previous Percy configuration file, migrate it to the newest version with the\n[`config:migrate`](https://github.com/percy/cli/tree/master/packages/cli-config#percy-configmigrate-filepath-output) command:\n\n```sh-session\n$ percy config:migrate\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpercy%2Fpercy-testcafe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpercy%2Fpercy-testcafe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpercy%2Fpercy-testcafe/lists"}