{"id":20908913,"url":"https://github.com/burnworks/axe-auto-reporter","last_synced_at":"2025-12-28T22:31:07.175Z","repository":{"id":203748553,"uuid":"710315656","full_name":"burnworks/axe-auto-reporter","owner":"burnworks","description":"Automated accessibility testing script using @axe-core/puppeteer, outputting results as HTML.","archived":false,"fork":false,"pushed_at":"2025-02-03T06:31:57.000Z","size":260,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-03T07:30:43.484Z","etag":null,"topics":["a11y","a11y-testing","accessibility","axe-core"],"latest_commit_sha":null,"homepage":"","language":"HTML","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/burnworks.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-26T13:02:19.000Z","updated_at":"2025-02-03T06:31:01.000Z","dependencies_parsed_at":"2024-11-18T14:09:48.103Z","dependency_job_id":"14167c7b-e0ba-4ca6-9999-55f125cdebf0","html_url":"https://github.com/burnworks/axe-auto-reporter","commit_stats":null,"previous_names":["burnworks/axe-auto-reporter"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burnworks%2Faxe-auto-reporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burnworks%2Faxe-auto-reporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burnworks%2Faxe-auto-reporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burnworks%2Faxe-auto-reporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/burnworks","download_url":"https://codeload.github.com/burnworks/axe-auto-reporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243301128,"owners_count":20269286,"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":["a11y","a11y-testing","accessibility","axe-core"],"created_at":"2024-11-18T14:09:21.414Z","updated_at":"2025-12-28T22:31:07.169Z","avatar_url":"https://github.com/burnworks.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# axe-auto-reporter\n\nAutomated accessibility testing script using @axe-core/puppeteer, outputting results as HTML. \n\n[@axe-core/puppeteer](https://github.com/dequelabs/axe-core-npm/blob/develop/packages/puppeteer/README.md) を使用して、テキストファイルで作成した URL リストに対して自動的にアクセシビリティテストを実行し、その結果を HTML ファイルとして保存するスクリプトです。\n\n## Requirements\n\nNode.js version 22.x or newer.\n\nNode.js 22.x 以上をご利用ください。\n\n## Getting Started\n\nInstall Node.js if you haven't already.\n\n```sh\ngit clone https://github.com/burnworks/axe-auto-reporter.git\ncd axe-auto-reporter\nnpm install\n```\n\n### Create `urls.txt`\n\nRename `urls.sample.txt` to `urls.txt` and edit it to create a list of URLs you wish to test. Separate each URL with a newline.\n\n`urls.sample.txt` を `urls.txt` にリネームした上で編集し、テストを実行したいURLのリストを作ってください。URL は改行で区切ります。\n\n### Run Tests\n\n```sh\nnode axe-auto-reporter.mjs\n```\nor\n\n```sh\nnpm run check\n```\n\nWhen you run the test, a `results` directory will be created, and the test results will be stored inside. Tests are organized by the date and time they were executed, with HTML files saved in the `html` directory and JSON files in the `json` directory.\n\nテストを実行すると `results` ディレクトリが作成され、その中にテスト結果が保存されます。  \nテストは実行した日時ごとにディレクトリ分けされ、さらに HTML ファイルは `html` ディレクトリに、JSON ファイルは `json` ディレクトリに保存されます。  \nJSON ファイルにはテスト結果のすべてが入っていますので、これを使用して他のデータを作ったりすることもできます。\n\n#### CSV report mode\n\nTo export CSV reports instead of HTML, you can execute:\n\nHTML レポートの代わりに CSV 形式のレポートを 1 ファイルで取得したい場合は、次のように実行します。\n\n```sh\nnode axe-auto-reporter.mjs --mode csv\n```\nor\n\n```sh\nnpm run checkcsv\n```\n\nThis creates the usual JSON files and additionally writes `report.csv` in each run directory. HTML reports and screenshots are skipped in this mode.\n\n通常どおり JSON ファイルが作成され、加えて結果ディレクトリ直下に `report.csv` が保存されます。このモードでは HTML レポートとスクリーンショットの出力はスキップされます。\n\n## Configuration\n\nThe configuration file is config.mjs. You can set the following items:\n\n| Property | Default | Description |\n| -------- | ------- | ----------- |\n| `urlList` | `urls.txt` | list of URLs. |\n| `locale` | `ja` | `ja`（日本語） or `en` (English) |\n| `tags` | `'wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa', 'wcag22aa', 'best-practice'` | Axe-core Tags setting. For more details, please refer to the [Axe Javascript Accessibility API](https://github.com/dequelabs/axe-core/blob/master/doc/API.md#axe-core-tags)\n| `mode` | `pc` | `pc` or `mobile`. If you set the value to `pc`, the defaultViewport for puppeteer will be `width: 1024, height: 768`. If set to `mobile`, it will be `width: 375, height: 812`. |\n\n`config.mjs` に設定が記述されています。必要に応じて変更してください。\n\n## Caution !\n\nAttempting to run automated tests on too many URLs may not work properly and has the potential to impose excessive load on the destination server. If this happens, please reduce the number of URLs in urls.txt.  \nThe program is configured to allow only 1 connection per domain, with a 3-second interval between requests (both values can be changed in the configuration file).\n\nあまりに多くの URL に対して自動テストを実行しようとするとうまく行かないかもしれませんし、接続先のサーバに過剰な負荷をかけてしまう可能性があります。  \nその場合は `urls.txt` に入れる URL の数を減らすなどしてください。\n\nプログラム的には同一ドメインに対する接続数は 1、アクセス間隔は 3 秒になるようにしてあります（設定ファイルで変更可能）\n\n## Report sample\n\n下記はレポートのサンプル画像です。\n\n![レポートのサンプル画像](./assets/axe-auto-reporter-sample-v1.2.0.png \"レポートのサンプル画像\")\n\n## Tailwind CSS\n\nTailwind CSS is used to generate the stylesheet for the HTML template. It does not affect the functionality of the script.\n\nTailwind CSS は HTML テンプレートのスタイルシートを生成するために使用しています。スクリプトの動作には関係ありません。つまり、本スクリプトを使用するだけであれば Tailwind CSS はインストール不要です。\n\n***\n\n## 関連リポジトリ\n\nこの axe-auto-reporter をベースに、ブラウザで操作、閲覧可能なダッシュボードツールを公開しています。\n\n- [burnworks/axe-auto-reporter-web: An automated accessibility test report dashboard using @axe-core/puppeteer.](https://github.com/burnworks/axe-auto-reporter-web)\n\n## アクセシビリティチェックをご希望の企業様へ\n\n何らかの理由で Node.js 実行環境が構築できないが本スクリプトを使用したアクセシビリティチェックを自社サイトに対して実行したいとお考えの企業様。\n\nバーンワークス株式会社では低コストで自動アクセシビリティチェックを実施しますので、お気軽にお問い合わせください。\n\n- [自動アクセシビリティチェックサービス - バーンワークス株式会社](https://burnworks.com/service/accessibility-auto-check/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fburnworks%2Faxe-auto-reporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fburnworks%2Faxe-auto-reporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fburnworks%2Faxe-auto-reporter/lists"}