lighthouse-core/audits/accessibility/list.js

/**
 * @license Copyright 2017 Google Inc. All Rights Reserved.
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 */
'use strict';

/**
 * @fileoverview Ensures that lists are structured correctly.
 * See base class in axe-audit.js for audit() implementation.
 */

const AxeAudit = require('./axe-audit');

class List extends AxeAudit {
  /**
   * @return {!AuditMeta}
   */
  static get meta() {
    return {
      name: 'list',
      description: 'Lists contain only `<li>` elements and script supporting elements ' +
          '(`<script>` and `<template>`).',
      failureDescription: 'Lists do not contain only `<li>` elements and script ' +
          'supporting elements (`<script>` and `<template>`).',
      helpText: 'Screen readers have a specific way of announcing lists. Ensuring proper list ' +
          'structure aids screen reader output. ' +
          '[Learn more](https://dequeuniversity.com/rules/axe/2.2/list?application=lighthouse).',
      requiredArtifacts: ['Accessibility'],
    };
  }
}

module.exports = List;