解决Sitespeed.io中Axe规则配置的JSON格式问题

在Sitespeed.io项目中，当用户尝试通过JSON配置文件来设置Axe可访问性测试规则时，遇到了一个关键的技术问题。这个问题涉及到JSON配置中的连字符规则ID被自动转换为驼峰式命名，导致Axe测试无法正常运行。

问题背景

Axe是一个流行的网页可访问性测试工具，它提供了大量预定义的测试规则。这些规则ID通常包含连字符，例如"empty-heading"、"heading-order"等。当用户尝试在Sitespeed.io的配置文件中指定这些规则时，系统会自动将连字符命名的规则ID转换为驼峰式命名（如"empty-heading"变为"emptyHeading"），这会导致Axe无法识别这些规则。

问题表现

用户在配置文件中指定了如下内容：

{
  "axe": {
    "run": {
      "runOnly": {
        "type": "tag",
        "values": ["wcag2a", "wcag2aa", "wcag21aa", "wcag22aa"]
      },
      "rules": {
        "empty-heading": { "enabled": true }
      }
    }
  }
}

但实际运行时，系统会生成包含两个版本的规则配置：

{
  "rules": {
    "empty-heading": {"enabled": true},
    "emptyHeading": {"enabled": true}
  }
}

这种重复配置会导致Axe测试超时失败，因为Axe无法识别自动生成的驼峰式规则名称。

临时解决方案

在官方修复此问题之前，用户可以采用以下临时解决方案：

1. 直接在测试脚本中配置Axe选项：避免使用JSON配置文件，改为在测试脚本中直接设置Axe配置参数。

context.options.axe = {
  enable: true,
  run: {
    runOnly: {
      type: "tag",
      values: ["wcag2a", "wcag2aa", "wcag21aa", "wcag22aa"]
    },
    rules: {
      "aria-allowed-role": { enabled: true },
      "empty-heading": { enabled: true },
      "heading-order": { enabled: true }
    }
  }
};

这种方法可以绕过JSON配置文件的自动转换问题，确保规则ID保持原始格式。

技术原理

这个问题的根源在于Sitespeed.io的配置解析机制。系统在处理JSON配置时，会自动将连字符分隔的键名转换为JavaScript常用的驼峰式命名。这种转换对于大多数配置项是合理的，但在处理Axe规则ID时却产生了问题，因为Axe严格要求规则ID必须保持原始格式。

官方修复

项目维护者已经确认这是一个需要修复的问题，并计划在下一个主要版本中解决。修复方案是禁用对Axe配置的驼峰式命名转换，确保规则ID保持原样传递到Axe引擎。

最佳实践建议

1. 对于Axe规则配置，优先考虑在脚本中直接设置而非通过JSON配置文件
2. 检查所有包含连字符的规则ID，确保它们没有被意外转换
3. 关注Sitespeed.io的版本更新，及时升级到包含此修复的版本
4. 在测试脚本中添加日志输出，验证最终的Axe配置是否符合预期

这个问题提醒我们，在使用自动化工具时，需要特别注意工具间的接口兼容性，特别是当涉及到严格的ID命名约定时。通过理解问题的本质和可用的解决方案，用户可以更有效地配置和使用Sitespeed.io进行可访问性测试。