🐛 Make broken external link URL clickable in review comments#27
Merged
Conversation
Wrap the URL in angle brackets instead of a backtick code span so it renders as a clickable autolink in GitHub markdown, letting reviewers validate the dead link in one click.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
When HyperHawk reports a broken external link, the URL was wrapped in a backtick code span, which renders as non-clickable text.
This wraps it in angle brackets (
<url>) instead, so GitHub markdown renders it as a clickable autolink.Why
Reviewers can click straight through to validate the dead link in one click, rather than copy-pasting the URL out of a code span.
Changes
src/report.ts: external broken-link comment now emitsURL: <${link.url}>dist/index.js: rebuilt bundle (the committed bundle is what the Action runs)Internal/same-org file paths keep backticks, since those aren't clickable URLs.
Verification
npm run typecheckpassesnpm run test:snapshotpasses (snapshot's external errors are all auth/bot-blocked and skipped, so noURL:line is affected)