@github/axe-github

中文文档
0.8.1发布于 2025/10/03MITTypeScriptESM + CJS零依赖近 30 天下载 15万

自定义规则和配置建议 axe-core gitHub 项目的库

中文使用文档
文档目录4 节
  1. 自定义规则
  2. 配置
  3. 基本用途
  4. 剧作家配置

轴- github

自定义规则和配置建议 axe-core gitHub 项目的库.

自定义规则

这些是本套件中的自定义规则:

  • aria-attribute-is-valid
  • autofocus-in-dialog
  • avoid-both-disabled-and-aria-disabled
  • empty-summary
  • menuitem-should-be-interactive
  • nested-forms
  • redundant-aria-label-aria-labelledby
  • submit-reset-button-must-be-in-form

配置

我们建议运行 axe-core 默认值.

基本用途

import 'axe-core'
import customRules from '@github/axe-github'

axe.configure(customRules)
axe.run(...)

剧作家配置

对于此库中的自定义规则,其相关的检查功能不能序列到 a 剧作家 页 次 要配置轴, 您需要加载和评价 configure-browser.ts 在页面上下文中。 Axe 在配置前应该在页面上加载.

const configSrc = fs.readFileSync(
  require.resolve('@github/axe-github/configure-browser'),
  'utf8'
)

page.evaluate((configSrc) => {
  window.eval(configSrc)
}, configSrc)

版本与发布记录

@github/axe-github 共发布 7 个版本,首次发布于 2023/01/25;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.8.1latest2025/10/031.1 年前
0.7.02024/07/292 年前
0.6.12023/09/213 年前
0.5.02023/03/233 年前
0.4.02023/02/113 年前
0.3.02023/01/253 年前

关于 @github/axe-github 的常见问题

@github/axe-github 是什么?

自定义规则和配置建议 axe-core gitHub 项目的库

如何安装 @github/axe-github?

在项目目录运行 npm install @github/axe-github,或使用 pnpm add / yarn add / bun add。

@github/axe-github 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@github/axe-github 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@github/axe-github 可以商用吗?

@github/axe-github 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@github/axe-github 的下载量有多少?

根据 npm 官方下载统计,@github/axe-github 在 2026/10/17 – 2026/11/15 这 30 天内被下载 149,995 次,日均约 5,000 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@github/axe-github 还在维护吗?

最新版本 0.8.1 发布于 2025/10/03(1.1 年前);至今共发布 7 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/01/25。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。