{"id":13341442,"url":"https://github.com/helen-dikareva/axe-testcafe","last_synced_at":"2025-09-23T22:30:34.246Z","repository":{"id":21652868,"uuid":"93528488","full_name":"helen-dikareva/axe-testcafe","owner":"helen-dikareva","description":"The helper for using Axe in TestCafe tests","archived":false,"fork":false,"pushed_at":"2020-06-11T23:55:47.000Z","size":66,"stargazers_count":36,"open_issues_count":6,"forks_count":13,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-10-01T18:10:10.716Z","etag":null,"topics":["accessibility","axe","e2e","end-to-end-testing","functional-testing","test","testcafe","testing-tools","web-accessibility"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/helen-dikareva.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-06T14:36:14.000Z","updated_at":"2022-07-05T13:38:25.000Z","dependencies_parsed_at":"2022-08-08T05:00:10.443Z","dependency_job_id":null,"html_url":"https://github.com/helen-dikareva/axe-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/helen-dikareva%2Faxe-testcafe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helen-dikareva%2Faxe-testcafe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helen-dikareva%2Faxe-testcafe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helen-dikareva%2Faxe-testcafe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/helen-dikareva","download_url":"https://codeload.github.com/helen-dikareva/axe-testcafe/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221249552,"owners_count":16784962,"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":["accessibility","axe","e2e","end-to-end-testing","functional-testing","test","testcafe","testing-tools","web-accessibility"],"created_at":"2024-07-29T19:25:26.182Z","updated_at":"2025-09-23T22:30:33.699Z","avatar_url":"https://github.com/helen-dikareva.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# axe-testcafe\r\nThe TestCafe module that allows you to use the [aXe](https://github.com/dequelabs/axe-core) accessibility engine in TestCafe tests.\r\n\r\n## Installation\r\n\r\n```bash\r\nnpm install axe-core axe-testcafe --save-dev\r\n```\r\n\r\n## How to use\r\n\r\nYou can write a TestCafe test with automated accessibility checks like this.\r\n\r\n```js\r\nimport { axeCheck, createReport } from 'axe-testcafe';\r\n\r\nfixture `TestCafe tests with Axe`\r\n    .page `http://example.com`;\r\n\r\ntest('Automated accessibility testing', async t =\u003e {\r\n    const { error, violations } = await axeCheck(t);\r\n    await t.expect(violations.length === 0).ok(createReport(violations));\r\n});\r\n```\r\n\r\nIf any accessibility issues are found, you will see a detailed report generated by the `createReport` function.\r\n\r\n![Accessibility errors](https://github.com/helen-dikareva/axe-testcafe/blob/master/errors.png)\r\n\r\n## aXe options\r\n\r\nThe `axe-testcafe` module allows you to define the `context` and `options` [axe.run parameters](https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axerun) in a TestCafe test.\r\n\r\n```js\r\ntest('Automated accessibility testing', async () =\u003e {\r\n    const axeContext = { exclude: [['select']] };\r\n    const axeOptions = { rules: { 'html-has-lang': { enabled: false } } };\r\n    const { error, violations } = await axeCheck(t, axeContext, axeOptions);\r\n    await t.expect(violations.length === 0).ok(createReport(violations));\r\n});\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelen-dikareva%2Faxe-testcafe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhelen-dikareva%2Faxe-testcafe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelen-dikareva%2Faxe-testcafe/lists"}