This repository has been archived by the owner on Dec 7, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 363
Add new audit rule that warns about bad page title #187
Open
krisskrr
wants to merge
3
commits into
GoogleChrome:master
Choose a base branch
from
krisskrr:page-title-test-02
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
22c0c88
page-title-test-02 Add new audit rule that warns about bad page title…
krisskrr 40ed4b3
page-title-test-02 fix audit script to query for title across scope, …
krisskrr 35aad78
page-title-test-02 fix the AX_TITLE_02 audit so it works post-closure…
krisskrr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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', | ||
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); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why this length and not something else? |
||
}, | ||
code: 'AX_TITLE_02' | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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; | ||
|
||
}); | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.