/**
 * @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 each HTML document contains a `<title>`.
 * See base class in axe-audit.js for audit() implementation.
 */

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

class DocumentTitle extends AxeAudit {
  /**
   * @return {!AuditMeta}
   */
  static get meta() {
    return {
      name: 'document-title',
      description: 'Document has a `<title>` element',
      failureDescription: 'Document does not have a `<title>` element',
      helpText: 'Screen reader users use page titles to get an overview of the contents of ' +
          'the page. ' +
          '[Learn more](https://dequeuniversity.com/rules/axe/2.2/document-title?application=lighthouse).',
      requiredArtifacts: ['Accessibility'],
    };
  }
}

module.exports = DocumentTitle;

/**
 * @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 each HTML document contains a `<title>`.
 * See base class in axe-audit.js for audit() implementation.
 */

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

class DocumentTitle extends AxeAudit {
  /**
   * @return {!AuditMeta}
   */
  static get meta() {
    return {
      name: 'document-title',
      description: 'Document has a `<title>` element',
      failureDescription: 'Document doesn\'t have a `<title>` element',
      helpText: 'The title gives screen reader users an overview of the page, and search ' +
          'engine users rely on it heavily to determine if a page is relevant to their search. ' +
          '[Learn more](https://developers.google.com/web/tools/lighthouse/audits/title).',
      requiredArtifacts: ['Accessibility'],
    };
  }
}

module.exports = DocumentTitle;

update helpText for document.title audit (#4677)