storybook-a11y-report

用于 storybook-addon-a11y 的 CLI 工具。

storybook-a11y-report 已经不再维护，请改用 Storybook 测试运行器和 axe-playwright！

storybook-a11y-report 项目现已停止维护。请切换到 Storybook 测试运行器和 axe-playwright 进行可访问性测试。感谢所有在项目旅程中支持 storybook-a11y-report 的人。

报告示例

入门

先决条件

如果您已经在 Storybook 中开发并且 storybook-addon-a11y 正在工作，则此模块将起作用。如果未安装 storybook-addon-a11y，请从 本指南 开始。

安装/入门

# Locally in your project.
npm install -D storybook-a11y-report

# Or globally.
npm install -g storybook-a11y-report

# You will need to start Storybook before running this command.
npx storybook-a11y-report

选项

--include, -i   Name of stories to narrow down (supports minimatch)
--exclude, -e   Name of stories to ignore (supports minimatch)
--filter, -f    ID of A11y to narrow down
--omit, -o      ID of A11y to ignore
--exit, -q      The process will be terminated abnormally, if there is an a11y violation in the report result (mainly for CI)
--storybookUrl  URL of Storybook (default: 'https://127.0.0.1:6006')
--outDir        Directory to output the report file (default: '__report__')
--outputFormat  Format of the output report, supports md or html (default: md)

构建工具

• Storycrawler - 使用 Puppeteer 构建 Storybook 爬取工具的实用程序
• storybook-addon-a11y - 在 Storybook 中测试组件的用户可访问性
• minimatch - 一个最小的匹配实用程序

许可证

本项目使用 MIT 许可证授权 - 详情请参阅 LICENSE 文件。