使用 Codelyzer 审核 Angular 应用的可访问性

想让所有人都能访问您的 Angular 网站吗?来对地方了!

确保您的应用具有无障碍功能,意味着所有用户(包括有特殊需求的用户)都可以使用该应用并了解该应用的内容。根据世界卫生报告,有超过 10 亿人(约占全球人口的 15%)患有某种形式的残疾。因此,任何开发项目都应优先考虑无障碍功能

在本博文中,您将学习如何向 Angular 应用的构建流程添加 codelyzer 的无障碍功能检查。这样一来,您就可以在编写代码时直接在文本编辑器中捕获无障碍功能 bug。

使用 Codelyzer 检测无法访问的元素

codelyzer 是一款基于 TSLint 的工具,用于检查 Angular TypeScript 项目是否遵循一组 lint 规则。默认情况下,使用 Angular 命令行界面 (CLI) 设置的项目包含 codelyzer。

Codelyzer 有超过 50 条规则用于检查 Angular 应用是否遵循了最佳实践。其中,大约有 10 条规则可用于强制执行无障碍标准。如需了解 Codelyzer 提供的各种无障碍功能检查及其理由,请参阅 Codelyzer 中新的无障碍功能规则一文。

目前,所有无障碍规则都处于实验阶段,默认处于停用状态。您可以通过将其添加到 TSLint 配置文件 (tslint.json) 来启用它们:

{
  "rulesDirectory": [
    "codelyzer"
  ],
  "rules": {
    ...,
    "template-accessibility-alt-text": true,
    "template-accessibility-elements-content": true,
    "template-accessibility-label-for": true,
    "template-accessibility-tabindex-no-positive": true,
    "template-accessibility-table-scope": true,
    "template-accessibility-valid-aria": true,
    "template-click-events-have-key-events": true,
    "template-mouse-events-have-key-events": true,
    "template-no-autofocus": true,
    "template-no-distracting-elements": true
  }
}

TSLint 适用于所有热门文本编辑器和 IDE。如需将其与 VSCode 搭配使用,请安装 TSLint 插件。在 WebStorm 中,TSLint 默认处于启用状态。对于其他编辑器,请参阅 TSLint 自述文件

设置好 Codelyzer 的无障碍功能检查后,当您编写代码时,系统会显示一个弹出式窗口,其中会显示 TypeScript 文件或内嵌模板中的无障碍功能错误:

文本编辑器中 Codelyzer 弹出式窗口的屏幕截图。
显示表单元素标签错误的 Codelyzer 弹出式窗口。

要对整个项目(包括外部模板)执行 lint 请求,请使用 ng lint 命令:

使用 Angular CLI 执行 lint 请求

补充 Codelyzer

Lighthouse 是另一个可用于在 Angular 应用中强制执行无障碍做法的工具。Codelyzer 和 Lighthouse 的主要区别在于执行检查的时间。Codelyzer 在开发时会对应用进行静态分析,而不会运行应用。这意味着,在开发期间,您可以通过文本编辑器或终端获得直接反馈。相比之下,Lighthouse 实际上会运行您的应用并使用动态分析执行一系列检查。

这两种工具在开发流程中都很有用。Lighthouse 可执行检查,因而可扩大覆盖面;而 Codelyzer 可通过在文本编辑器中获取持续反馈,更快地进行迭代。

在持续集成中强制执行无障碍功能检查

在持续集成 (CI) 中引入静态无障碍功能检查可以大幅增强您的开发流程。借助 Codelyzer,您可以通过对每次代码修改(例如,针对每个新的拉取请求)运行 ng lint,轻松强制执行某些无障碍规则或其他做法。

这样,即使您不继续进行代码审核,CI 也可以告诉您是否存在任何无障碍功能违规行为。

总结

如需改进 Angular 应用的无障碍功能,请执行以下操作:

  1. 在 Codelyzer 中启用实验性无障碍功能规则。
  2. 使用 Angular CLI 对整个项目执行无障碍功能 lint 检查。
  3. 修复了 Codelyzer 报告的所有无障碍功能问题。
  4. 考虑在运行时使用 Lighthouse 进行无障碍功能审核。