Skip to content

fix(gate): collect README links from the prose, not from the code fences #72

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

Merged
msalvatti merged 1 commit into from
Aug 3, 2026
Merged

fix(gate): collect README links from the prose, not from the code fences #72

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 7 additions & 3 deletions scripts/check-published-surface.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,16 +218,20 @@ async function checkLinks() {
// a naive link regex captures the IMAGE — probing shields.io on every run and
// failing the build when it rate-limits, for a reason that is not ours. The
// image is stripped first so only the target remains.
const clickable = README.replace(/!\[[^\]]*\]\([^)]*\)/g, '')
//
// Collection starts from the prose for the same reason the anchor set does: an
// `<a href="${url}">` inside a fence is a string an example builds at runtime,
// not a link a reader can click, and the checker cannot resolve a placeholder.
const clickable = README_PROSE.replace(/!\[[^\]]*\]\([^)]*\)/g, '')
const links = new Set([
...[...clickable.matchAll(/\[[^\]]*\]\((https?:\/\/[^)\s]+)\)/g)].map((m) => m[1]),
...[...clickable.matchAll(/<a\s+href="(https?:\/\/[^"]+)"/g)].map((m) => m[1]),
])
// Both spellings: the section links are Markdown, but the header navigation is
// raw HTML. Collecting only the first left this README's nav bar unchecked.
const internal = new Set([
...[...README.matchAll(/\[[^\]]*\]\((#[^)\s]+)\)/g)].map((m) => m[1].toLowerCase()),
...[...README.matchAll(/<a\s+href="(#[^"]+)"/g)].map((m) => m[1].toLowerCase()),
...[...README_PROSE.matchAll(/\[[^\]]*\]\((#[^)\s]+)\)/g)].map((m) => m[1].toLowerCase()),
...[...README_PROSE.matchAll(/<a\s+href="(#[^"]+)"/g)].map((m) => m[1].toLowerCase()),
])

// Relative links are the ones most likely to rot — a file gets renamed and
Expand Down
Loading