{"id":15662909,"url":"https://github.com/ahmadnassri/node-nightwatch-accessibility","last_synced_at":"2025-07-07T12:07:11.871Z","repository":{"id":37919064,"uuid":"98388686","full_name":"ahmadnassri/node-nightwatch-accessibility","owner":"ahmadnassri","description":"Nightwatch.js utility assertion for accessibility testing with aXe","archived":false,"fork":false,"pushed_at":"2025-01-07T20:53:44.000Z","size":911,"stargazers_count":18,"open_issues_count":4,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-09T12:08:47.505Z","etag":null,"topics":["axe","lib","nightwatch","node"],"latest_commit_sha":null,"homepage":"","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/ahmadnassri.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["ahmadnassri"]}},"created_at":"2017-07-26T06:40:13.000Z","updated_at":"2025-01-07T20:53:47.000Z","dependencies_parsed_at":"2023-12-08T16:28:49.844Z","dependency_job_id":"e66f8b0a-1f13-4282-917a-c9482b7773f8","html_url":"https://github.com/ahmadnassri/node-nightwatch-accessibility","commit_stats":{"total_commits":208,"total_committers":8,"mean_commits":26.0,"dds":"0.28365384615384615","last_synced_commit":"e4ab2598fcda3d397dc64710e3d64c9dcff21f85"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"purl":"pkg:github/ahmadnassri/node-nightwatch-accessibility","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadnassri%2Fnode-nightwatch-accessibility","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadnassri%2Fnode-nightwatch-accessibility/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadnassri%2Fnode-nightwatch-accessibility/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadnassri%2Fnode-nightwatch-accessibility/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ahmadnassri","download_url":"https://codeload.github.com/ahmadnassri/node-nightwatch-accessibility/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadnassri%2Fnode-nightwatch-accessibility/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264075630,"owners_count":23553508,"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":["axe","lib","nightwatch","node"],"created_at":"2024-10-03T13:34:53.614Z","updated_at":"2025-07-07T12:07:11.821Z","avatar_url":"https://github.com/ahmadnassri.png","language":"JavaScript","funding_links":["https://github.com/sponsors/ahmadnassri"],"categories":[],"sub_categories":[],"readme":"# Nightwatch Accessibility\n\nNightwatch.js utility assertion for accessibility testing with aXe.\n\n[![license][license-img]][license-url]\n[![release][release-img]][release-url]\n[![semantic][semantic-img]][semantic-url]\n\n## Install\n\n``` bash\nnpm install nightwatch-accessibility\n```\n\n## Usage\n\n### Nightwatch \\\u003e= 2.x\n\nadd `nightwatch-accessibility` to the plugins array\n\n``` js\n{\n  plugins: ['nightwatch-accessibility']\n}\n```\n\n### Nightwatch \\\u003c= 1.x\n\n``` js\n{\n  custom_commands_path: [\"./node_modules/nightwatch-accessibility/nightwatch/commands\"],\n  custom_assertions_path: [\"./node_modules/nightwatch-accessibility/nightwatch/assertions\"]\n}\n```\n\nUse in your tests:\n\n``` js\nmodule.exports = {\n  'Test': function (browser) {\n    browser\n      // initiate aXe\n      .initAccessibility() \n\n      // execute accessibility check\n      .assert.accessibility('#app', {\n        verbose: true,\n        rules: {\n          'color-contrast': { enabled: false }\n        }\n      })\n  }\n}\n```\n\n## API\n\n### `browser.initAccessibility()`\n\nInjects the [`aXe`][] library into the current test page.\n\n### `browser.assert.accessibility(context, options)`\n\nAnalyzes the defined `context` against applied `aXe` rules\n\n| Name          | Type     | Default  | Description               |\n|---------------|----------|----------|---------------------------|\n| **`context`** | `String` | `'html'` | [aXe Context][] Parameter |\n| **`options`** | `Object` | `null`   | [aXe Options][] Parameter |\n\n\u003e In addition to the standard `options`:\n\n- `options.verbose` set to `true` will log all successful `aXe` tests.\n- `options.timeout` configures the nightwatch timeout, default value is `500 milliseconds`\n\n  [`aXe`]: https://www.npmjs.com/package/axe-core\n  [aXe Context]: https://github.com/dequelabs/axe-core/blob/master/doc/API.md#context-parameter\n  [aXe Options]: https://github.com/dequelabs/axe-core/blob/master/doc/API.md#options-parameter\n\n----\n\u003e Author: [Ahmad Nassri](https://www.ahmadnassri.com/) \u0026bull;\n\u003e Twitter: [@AhmadNassri](https://twitter.com/AhmadNassri)\n\n[license-url]: LICENSE\n[license-img]: https://badgen.net/github/license/ahmadnassri/node-nightwatch-accessibility\n\n[release-url]: https://github.com/ahmadnassri/node-nightwatch-accessibility/releases\n[release-img]: https://badgen.net/github/release/ahmadnassri/node-nightwatch-accessibility\n\n[semantic-url]: https://github.com/ahmadnassri/node-nightwatch-accessibility/actions?query=workflow%3Arelease\n[semantic-img]: https://badgen.net/badge/📦/semantically%20released/blue\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmadnassri%2Fnode-nightwatch-accessibility","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fahmadnassri%2Fnode-nightwatch-accessibility","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmadnassri%2Fnode-nightwatch-accessibility/lists"}