如何向pa11y-ci添加规则?

时间:2018-05-23 05:22:01

标签: automated-tests accessibility wcag wcag2.0 pa11y

我需要自定义pa11y使用的规则集。 例如,假设我想关注WCAG2A但想要添加WCAG2AA的一些规则。

我在.pa11yci文件中尝试过这样的配置:

{
"defaults": {
    "standard": "WCAG2A",
    "rules": ["WCAG2AA.Principle1.Guideline1_1.1_1_1.H30.2"],
    "hideElements": "",
    "ignore": [],
    "includeWarnings": true,
    "timeout": 5000,
    "threshold": 0
},
"urls": [
    {
        "url": "https://www.ecster.se",
        "actions": [

        ]
    }]

}

但我只能在控制台中得到这个:

    Error: Evaluation failed: Error: WCAG2AA.Principle1.Guideline1_1.1_1_1.H30.2 is not a valid WCAG 2.0 rule
   at configureHtmlCodeSniffer (<anonymous>:60:13)
   at runPa11y (<anonymous>:30:3)

我从这里得到了我的rulenames: https://github.com/pa11y/pa11y/wiki/HTML-CodeSniffer-Rules

使用最新版本的pa11y-ci:2.1.1。

2 个答案:

答案 0 :(得分:2)

查看{{3}},看起来好像需要引用没有标准的规则。

E.g。 Principle1.Guideline1_1.1_1_1.H30.2,而非WCAG2AA.Principle1.Guideline1_1.1_1_1.H30.2

值得注意的是,您作为示例使用的指南已经存在于WCAG2A和WCAG2AA中。可能值得尝试使用仅存在于AA及以上的产品,例如Principle3.Guideline3_1.3_1_2.H58.1.Lang

答案 1 :(得分:-1)

您应该拥有一个rules属性,其中包含要包含的一组规则。

...
"rules": [ "standard.you.wish.to.include",...],
...