{"id":20672101,"url":"https://github.com/workarea-commerce/workarea-a11y","last_synced_at":"2025-10-25T01:18:37.654Z","repository":{"id":56898456,"uuid":"203653111","full_name":"workarea-commerce/workarea-a11y","owner":"workarea-commerce","description":null,"archived":false,"fork":false,"pushed_at":"2020-04-15T19:07:55.000Z","size":44,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-18T01:18:32.870Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/workarea-commerce.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-21T19:42:09.000Z","updated_at":"2020-04-15T19:07:59.000Z","dependencies_parsed_at":"2022-08-21T02:20:22.372Z","dependency_job_id":null,"html_url":"https://github.com/workarea-commerce/workarea-a11y","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-a11y","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-a11y/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-a11y/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-a11y/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/workarea-commerce","download_url":"https://codeload.github.com/workarea-commerce/workarea-a11y/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242891304,"owners_count":20202324,"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":[],"created_at":"2024-11-16T20:32:02.716Z","updated_at":"2025-10-25T01:18:32.596Z","avatar_url":"https://github.com/workarea-commerce.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"Workarea A11y\n================================================================================\n\nA Workarea Commerce plugin that integrates [Deque's aXe Accessibility\nEngine](https://www.deque.com/axe/) into your project's test suite, failing\ntests for pages that are found containing WCAG offenses.\n\nCurrently this plugin:\n\n* is not configurable\n* only checks against Storefront\n* will fail CI builds until offenses are fixed\n* will fail your local tests until offenses are fixed\n* works for all versions of Workarea greater-than or equal to v3.0.0\n\nThis plugin is also intended to be used in tandem with the [aXe Chrome Developer\nTools](https://chrome.google.com/webstore/detail/axe/lhdoppojpmngadmnindnejefpokejbdd/related?hl=en-US)\nwhich can give you _much more insight_ into what's going on when you're trying\nto debug the offenses.\n\nGetting Started\n--------------------------------------------------------------------------------\n\nAdd the gem to your application's Gemfile:\n\n```ruby\n# ...\ngem 'workarea-a11y'\n# ...\n```\n\nUpdate your application's bundle.\n\n```bash\ncd path/to/application\nbundle\n```\n\nUsage\n--------------------------------------------------------------------------------\n\nInstall this plugin and run:\n\n```bash\nbin/rails workarea:test:storefront\n```\n\nOr push your branch up to your project's remote repository and check the CI build.\n\n\nGotchas\n--------------------------------------------------------------------------------\n\nThe aXe Chrome Developer Tools are run by the developer on-demand, which can\ndiffer from the automatic approach taken by this plugin. This means that your\nresults may vary when using both approaches in tandem. The Developer Tools will\noften uncover more offenses than the test suite integration so it is recommended\nthat both be used.\n\nThe Developer Tools can also be affected by other Chrome extensions. For\nexample, the LastPass Chrome Extension will apply an overlay to inputs of type\n'email' to show the user that LastPass may be able to interact with the field.\nUsing the Developer Tools, aXe will throw a warning because of this, since it is\nrun manually after the page and LastPass have loaded, whereas the test\nintegration will not have the LastPass extension loaded.\n\nThis plugins is also only able to test pages that the test suite covers. In this\nway it acts quite similarly to the v3.2.0 Duplicate ID checker feature in\nWorkarea.\n\nBe sure to keep these gotchas in mind while you work to stay efficient while\nworking through the reported offenses.\n\n\nWorkarea Commerce Documentation\n--------------------------------------------------------------------------------\n\nSee [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.\n\nLicense\n--------------------------------------------------------------------------------\n\nWorkarea A11Y is released under the [Business Software License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkarea-commerce%2Fworkarea-a11y","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fworkarea-commerce%2Fworkarea-a11y","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkarea-commerce%2Fworkarea-a11y/lists"}