Skip to content
This repository has been archived by the owner on Dec 7, 2022. It is now read-only.

Add new audit rule that warns about bad page title #187

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions src/audits/PageWithBadTitle.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// Copyright 2015 Google Inc.
//
// 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.

goog.require('axs.AuditRules');
goog.require('axs.constants.Severity');

axs.AuditRules.addRule({
name: 'pageWithBadTitle',
heading: 'The web page should have a title less than 66 characters long and does not contain bad characters',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you explain the reasoning behind this rule?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This suggested rule is to help users that depend on screen readers to browse the web;
Comes from a list of minor issues, collected by an accessibility expert who uses a screen reader on a daily basis;
I do not have any demographics research done on such a thing though;
I left the severity to a warning.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kristapsmelderis can you be more specific about the genesis of this rule? Is there a corresponding standard that drove this out? Why 66 characters?

I'm hesistant to merge this unless there's a convention or standard backing it up.

url: 'https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#TODO-WIKIENTRY',
severity: axs.constants.Severity.WARNING,
relevantElementMatcher: function(element) {
return element.tagName.toLowerCase() == "title";
},
test: function(title) {
var titleText = title.textContent;
var badChars = /([-/\\]|[.]$)/;
return titleText.length > 65 || badChars.test(titleText);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this length and not something else?

},
code: 'AX_TITLE_02'
});
65 changes: 65 additions & 0 deletions test/audits/page-with-bad-title-test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
module("Page titles");

test("Page title must be less than 66 characters in length", function() {
var rule = axs.AuditRules.getRule('pageWithBadTitle');

// Save the existing title for later use
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the code here is self-explanatory, so these comments aren't necessary.

var originalTitle = document.title;

// Text that will replace the existing title for testing needs
var badTitle = "Hello, i am a text that is used for testing of this page, 12345678";

// Replace title with the bad title
document.title = badTitle;

// This test fails because title is longer than 65 characters
equal(rule.run().result,
axs.constants.AuditResult.FAIL);

// Tidy up, revert the title to its original state
document.title = originalTitle;

});

test("Page title must not end with '.'", function() {
var rule = axs.AuditRules.getRule('pageWithBadTitle');

// Save the existing title for later use
var originalTitle = document.title;

// Text that will replace the existing title for testing needs
var badTitle = "Hello, i am a text that is used for testing of this page, 123456.";

// Replace title with the bad title
document.title = badTitle;

// This test fails because the title ends with '.' (a full stop)
equal(rule.run().result,
axs.constants.AuditResult.FAIL);

// Tidy up, revert the title to its original state
document.title = originalTitle;

});

test("Page title must not contain '/', '\\' or '-' (slash, backslash or hyphen)", function() {
var rule = axs.AuditRules.getRule('pageWithBadTitle');

// Save the existing title for later use
var originalTitle = document.title;

// Text that will replace the existing title for testing needs
var badTitle = "Hello - i am a text \\ that is used for testing of this page / 12";

// Replace title with the bad title
document.title = badTitle;

// This test fails because the title contains '/', '\' or '-' (slash, backslash or hyphen)
equal(rule.run().result,
axs.constants.AuditResult.FAIL);

// Tidy up, revert the title to its original state
document.title = originalTitle;

});