Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Infrastructure: link-checker.js: Check if any of the known pageIds include the hash being checked for #2812

Merged
merged 3 commits into from
Oct 2, 2023
Merged

Infrastructure: link-checker.js: Check if any of the known pageIds include the hash being checked for #2812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8125707
Check if any of the known page ids include the hash being checked for
howard-e Sep 25, 2023
56d93db
Include clarifying comment
howard-e Sep 25, 2023
be464a0
Set up cases where unique hashes need to be handled
howard-e Oct 2, 2023
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
9 changes: 8 additions & 1 deletion .link-checker.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,16 @@ module.exports = {
'.carousel-image a',
],
},
hashCheckHandlers: [
{
name: 'github',
pattern: /^https:\/\/github\.com\/.*/,
matchHash: (ids, hash) =>
ids.includes(hash) || ids.includes(`user-content-${hash}`),
},
],
ignoreHashesOnExternalPagesMatchingRegex: [
// Some hash links are resolved with JS and are therefore difficult to check algorithmically
/^https:\/\/github\.com\/.*\/wiki\//,
/^https:\/\/html\.spec\.whatwg\.org\/multipage\//,
],
};
29 changes: 27 additions & 2 deletions scripts/link-checker.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,23 @@ async function checkLinks() {
return getLineNumber;
};

const checkPathForHash = (hrefOrSrc, ids = [], hash) => {
// On some websites, the ids may not exactly match the hash included
// in the link.
// For e.g. GitHub will prepend client facing ids with their own
// calculated value. A heading in a README for example could be
// 'Foo bar', navigated to with https://github.com/foo/bar#foo-bar,
// but GitHub calculates the actual markup id included in the document
// as being 'user-content-foo-bar' for its own page processing purposes.
//
// See https://github.com/w3c/aria-practices/issues/2809
const handler = options.hashCheckHandlers.find(({ pattern }) =>
pattern.test(hrefOrSrc)
);
if (handler) return handler.matchHash(ids, hash);
else return ids.includes(hash);
};

const countConsoleErrors = () => {
let errorCount = 0;

Expand Down Expand Up @@ -227,7 +244,11 @@ async function checkLinks() {

let matchesHash = true;
if (hash) {
matchesHash = !!matchingPage?.ids.includes(hash);
matchesHash = !!checkPathForHash(
pathMinusHash,
matchingPage?.ids,
hash
);
}

const isLinkBroken = !(
Expand Down Expand Up @@ -274,7 +295,11 @@ async function checkLinks() {
hrefOrSrc.match(pattern)
);

if (!isHashCheckingDisabled && hash && !pageData.ids.includes(hash)) {
if (
!isHashCheckingDisabled &&
hash &&
!checkPathForHash(hrefOrSrc, pageData.ids, hash)
) {
consoleError(
`Found broken external link on ${htmlPath}:${lineNumber}:${columnNumber}, ` +
'hash not found on page'
Expand Down