{"id":22538130,"url":"https://github.com/cfpb/node-wcag","last_synced_at":"2025-04-09T20:15:08.689Z","repository":{"id":31279343,"uuid":"34841251","full_name":"cfpb/node-wcag","owner":"cfpb","description":"WCAG and Section 508 accessibility audits from the command line.","archived":false,"fork":false,"pushed_at":"2017-06-06T16:35:49.000Z","size":359,"stargazers_count":32,"open_issues_count":7,"forks_count":9,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-04-09T20:15:01.851Z","etag":null,"topics":["wcag"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cfpb.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-30T07:44:00.000Z","updated_at":"2024-12-08T16:43:03.000Z","dependencies_parsed_at":"2022-09-09T07:40:30.944Z","dependency_job_id":null,"html_url":"https://github.com/cfpb/node-wcag","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fnode-wcag","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fnode-wcag/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fnode-wcag/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cfpb%2Fnode-wcag/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cfpb","download_url":"https://codeload.github.com/cfpb/node-wcag/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248103872,"owners_count":21048245,"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":["wcag"],"created_at":"2024-12-07T11:10:21.271Z","updated_at":"2025-04-09T20:15:08.601Z","avatar_url":"https://github.com/cfpb.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node-wcag [![Build Status](https://secure.travis-ci.org/cfpb/node-wcag.png?branch=master)](http://travis-ci.org/cfpb/node-wcag) [![Coverage Status](https://coveralls.io/repos/cfpb/node-wcag/badge.svg)](https://coveralls.io/r/cfpb/node-wcag)\n\nWCAG and Section 508 accessibility audits from the command line or as a traditional node module.\n\n![WCAG Screenshot](https://raw.githubusercontent.com/cfpb/node-wcag/master/screenshot.png)\n\n## CLI installation\n\n```sh\n$ npm install wcag --global\n```\n\n## CLI usage\n\nFirst, get a free [AChecker API ID](http://achecker.ca/register.php). Then:\n\n```sh\n$ wcag wikipedia.org --id=\u003cachecker id\u003e\n```\n\nAlso works against localhost:\n\n```sh\n$ wcag localhost:8000 --id=\u003cachecker id\u003e\n```\n\n### Options\n\n#### id\n\nType: `string`  \n\nYour free [AChecker API ID](http://achecker.ca).\n\n```sh\n$ wcag wikipedia.org --id=845cc0a8435cb0a766396a8c56399a43df0c843\n```\n\nIf an `id` is not passed on the command line,\nthe tool will check for an `ACHECKER_ID` environment variable.\n\n#### guide\n\nType: `string`  \nChoices: `508`, `WCAG1-A`, `WCAG1-AA`, `WCAG1-AAA`, `WCAG2-A`, `WCAG2-AA`, `WCAG2-AAA`, `BITV1`, `STANCA`\nDefault: `WCAG2-AA`\n\nThe accessbility guideline to validate against.\n\n```sh\n$ wcag wikipedia.org --id=\u003cachecker id\u003e --guide=508\n$ wcag wikipedia.org --id=\u003cachecker id\u003e --guide=BITV1\n```\n\n## Module installation\n\n```sh\n$ npm install wcag\n```\n\n## Module usage\n\n```javascript\n\nvar wcag = require('wcag');\nvar options = {\n  id: '69f6ea6a9e30b37c3d341d3b716df218f8942c0e',\n  uri: 'http://contolini.github.io/node-wcag/test/fixtures/whitehouse.html',\n  guide: 'WCAG2-AA'\n};\n\nwcag(options, function (error, data) {\n  if (error) {\n    console.error(error);\n  } else {\n    console.log(data);\n  }\n});\n```\n\nThe example will return [this output](data/output.json)\n\n### Options\n\n#### id\n\nType: `string`  \nRequired: true\nYour free [AChecker API ID](http://achecker.ca).\n\n#### uri\n\nType: `string`\nRequired: true\nURL for the page you want to validate\n\n#### guide\n\nType: `string`\nRequired: false\nChoices: `508`, `WCAG1-A`, `WCAG1-AA`, `WCAG1-AAA`, `WCAG2-A`, `WCAG2-AA`, `WCAG2-AAA`, `BITV1`, `STANCA`\nDefault: `WCAG2-AA`\n\nThe accessbility guideline to validate against.\n\n## Contributing\n\nPlease read the [Contributing guidelines](CONTRIBUTING.md).\n\n### Running node-wcag locally\n\nTo contribute code, fork this repo, clone it down to your machine and use npm link:\n\n```sh\n$ npm uninstall -g wcag\n$ cd node-wcag\n$ npm link\n$ wcag whatever.com\n```\n\n### Running tests\n\nWe are using [nodeunit](https://github.com/caolan/nodeunit) to test.\nTo run tests, first install nodeunit and any dependencies via npm:\n\n```sh\nnpm install\n```\n\nRun tests with:\n\n```sh\nnpm test\n```\n\n## License\n\nThe project is in the public domain within the United States, and\ncopyright and related rights in the work worldwide are waived through\nthe [CC0 1.0 Universal public domain dedication](http://creativecommons.org/publicdomain/zero/1.0/).\n\nAll contributions to this project will be released under the CC0\ndedication. By submitting a pull request, you are agreeing to comply\nwith this waiver of copyright interest.\n\nSoftware source code previously released under an open source license and then modified by CFPB staff is considered a \"joint work\" (see 17 USC § 101); it is partially copyrighted, partially public domain, and as a whole is protected by the copyrights of the non-government authors and must be released according to the terms of the original open-source license.\n\nFor further details, please see: http://www.consumerfinance.gov/developers/sourcecodepolicy/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfpb%2Fnode-wcag","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcfpb%2Fnode-wcag","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfpb%2Fnode-wcag/lists"}