-
Notifications
You must be signed in to change notification settings - Fork 0
Add copy current URL as markdown link on artifact page #68
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.
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
Merged
Changes from all commits
Commits
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 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /** | ||
| * Escape characters that would break a markdown inline link label. | ||
| */ | ||
| function escapeMarkdownLinkLabel(label: string): string { | ||
| return label.replace(/\\/g, "\\\\").replace(/\[/g, "\\[").replace(/\]/g, "\\]"); | ||
| } | ||
|
|
||
| /** | ||
| * Format a markdown link destination, wrapping URLs that contain characters | ||
| * which would prematurely terminate a parenthesized destination (e.g. `)`). | ||
| */ | ||
| function formatMarkdownDestination(href: string): string { | ||
| if (!/[()\s]/.test(href)) { | ||
| return href; | ||
| } | ||
|
|
||
| const safeHref = href.replace(/</g, "%3C").replace(/>/g, "%3E"); | ||
| return `<${safeHref}>`; | ||
| } | ||
|
|
||
| /** | ||
| * Format a markdown inline link from a label and destination URL. | ||
| */ | ||
| export function formatMarkdownLink(label: string, href: string): string { | ||
| const trimmedLabel = label.trim() || href; | ||
| return `[${escapeMarkdownLinkLabel(trimmedLabel)}](${formatMarkdownDestination(href)})`; | ||
| } |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| import { describe, expect, it } from "vitest"; | ||
| import { formatMarkdownLink } from "@/lib/markdown-link"; | ||
|
|
||
| describe("formatMarkdownLink", () => { | ||
| it("formats a standard inline link", () => { | ||
| expect(formatMarkdownLink("Viewer bootstrap", "https://example.com/#agent-render=v1.plain.abc")).toBe( | ||
| "[Viewer bootstrap](https://example.com/#agent-render=v1.plain.abc)", | ||
| ); | ||
| }); | ||
|
|
||
| it("escapes brackets in the label", () => { | ||
| expect(formatMarkdownLink("Sprint [draft]", "https://example.com/")).toBe( | ||
| "[Sprint \\[draft\\]](https://example.com/)", | ||
| ); | ||
| }); | ||
|
|
||
| it("falls back to the URL when the label is blank", () => { | ||
| expect(formatMarkdownLink(" ", "https://example.com/")).toBe("[https://example.com/](https://example.com/)"); | ||
| }); | ||
|
|
||
| it("wraps destinations containing closing parentheses in angle brackets", () => { | ||
| const href = "https://example.com/#agent-render=v1.arx.1.payload)more"; | ||
| expect(formatMarkdownLink("Arx sample", href)).toBe(`[Arx sample](<${href}>)`); | ||
| }); | ||
|
|
||
| it("percent-encodes angle brackets inside wrapped destinations", () => { | ||
| const href = "https://example.com/path?x=a)b>c"; | ||
| expect(formatMarkdownLink("Wrapped", href)).toBe("[Wrapped](<https://example.com/path?x=a)b%3Ec>)"); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
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.
escapeMarkdownLinkLabelescapes\→\\before handling brackets; without a test for this path a regression (e.g. dropping the first.replace) would go undetected, and artifact filenames from Windows paths can legitimately contain backslashes.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!