{"id":27935292,"url":"https://github.com/spitfiresatya/accessibility-html-reporter","last_synced_at":"2025-05-07T06:15:36.413Z","repository":{"id":32791129,"uuid":"142688599","full_name":"SpitfireSatya/accessibility-html-reporter","owner":"SpitfireSatya","description":"An html reporter for Accessibility which uses Access-sniff","archived":false,"fork":false,"pushed_at":"2022-12-07T21:54:04.000Z","size":282,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-07T06:15:32.954Z","etag":null,"topics":["accessibility","html-report"],"latest_commit_sha":null,"homepage":null,"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/SpitfireSatya.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":null,"security":null,"support":null}},"created_at":"2018-07-28T15:32:28.000Z","updated_at":"2020-07-13T04:51:40.000Z","dependencies_parsed_at":"2023-01-14T22:14:36.758Z","dependency_job_id":null,"html_url":"https://github.com/SpitfireSatya/accessibility-html-reporter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpitfireSatya%2Faccessibility-html-reporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpitfireSatya%2Faccessibility-html-reporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpitfireSatya%2Faccessibility-html-reporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpitfireSatya%2Faccessibility-html-reporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpitfireSatya","download_url":"https://codeload.github.com/SpitfireSatya/accessibility-html-reporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252824153,"owners_count":21809715,"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","html-report"],"created_at":"2025-05-07T06:15:35.560Z","updated_at":"2025-05-07T06:15:36.407Z","avatar_url":"https://github.com/SpitfireSatya.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# accessibility-html-reporter\nA small module which runs Access sniff on the given source glob and generates a simple HTML report.\n\n## Installation\n\nInstall accessibility-html-reporter locally and add it to the dev dependancies\n```bash\nnpm install accessibility-html-reporter --save-dev\n```\n\n## Usage\n\nSimple require the module in your script/gulp task and invoke it with the desired config\n\n```js\nconst accessibilityHtmlReporter = require('accessibility-html-reporter');\n\naccessibilityHtmlReporter({/*config*/}, callback);\n\n```\n\nand you're done!!\n\n## Config\n\nThe accessibility-html-reporter takes the following config object and the default values are as below\n\n```js\nconfig: {\n  srcFiles: ['**/*.html'], // array of files to test\n\n  accessibilityLevel: 'WCAG2AAA', // one of WCAG2A, WCAG2AA, WCAG2AAA, and Section508\n  ignore: [], // rules to ignore eg. ['WCAG2A.Principle3.Guideline3_1.3_1_1.H57.2']\n  verbose: false, // Verbose output\n  force: true, // do not throw an error if errors found\n  browser: false, // false = jsdom, true = phantomJS\n  maxBuffer: 500 * 1024, // set buffer size\n\n  fileName: 'accessibility-report', // name of json and html file generated\n  reportLocation: 'reports/accessibility' // folder where report should be written\n}\n```\n\n## Sample Report\n\n![This is what the report looks like](sample.jpg?raw=true \"Sample Report\")\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspitfiresatya%2Faccessibility-html-reporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspitfiresatya%2Faccessibility-html-reporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspitfiresatya%2Faccessibility-html-reporter/lists"}