-
Notifications
You must be signed in to change notification settings - Fork 4.9k
fix(web): make Windows file links clickable #6237
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
Closed
peculiarnewbie
wants to merge
4
commits into
pingdotgg:main
from
peculiarnewbie:fix/windows-markdown-file-links
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
6717343
fix(web): make Windows file links clickable
peculiarnewbie fd31c7f
fix(web): normalize Windows link separators
peculiarnewbie 71371ee
Merge branch 'main' into fix/windows-markdown-file-links
peculiarnewbie 2e03244
fix(web): normalize encoded Windows link keys
peculiarnewbie 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
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,56 @@ | ||
| import { renderToStaticMarkup } from "react-dom/server"; | ||
| import ReactMarkdown, { defaultUrlTransform } from "react-markdown"; | ||
| import rehypeSanitize, { defaultSchema } from "rehype-sanitize"; | ||
| import { describe, expect, it } from "vite-plus/test"; | ||
|
|
||
| import { remarkRewriteWindowsFileLinks, rewriteMarkdownFileUriHref } from "./markdown-links"; | ||
|
|
||
| const sanitizeSchema = { | ||
| ...defaultSchema, | ||
| protocols: { | ||
| ...defaultSchema.protocols, | ||
| href: [...(defaultSchema.protocols?.href ?? []), "file"], | ||
| }, | ||
| } satisfies Parameters<typeof rehypeSanitize>[0]; | ||
|
|
||
| function renderMarkdown(markdown: string): string { | ||
| return renderToStaticMarkup( | ||
| <ReactMarkdown | ||
| remarkPlugins={[remarkRewriteWindowsFileLinks]} | ||
| rehypePlugins={[[rehypeSanitize, sanitizeSchema]]} | ||
| urlTransform={(href) => rewriteMarkdownFileUriHref(href) ?? defaultUrlTransform(href)} | ||
| > | ||
| {markdown} | ||
| </ReactMarkdown>, | ||
| ); | ||
| } | ||
|
|
||
| describe("Windows markdown file link rendering", () => { | ||
| it("preserves a drive-path href through HTML sanitization", () => { | ||
| const path = "C:/Users/mike/dev-stuff/t3code/apps/web/src/markdown-links.ts"; | ||
|
|
||
| expect(renderMarkdown(`[markdown-links.ts](${path}) is open above.`)).toContain( | ||
| `<a href="${path}">markdown-links.ts</a>`, | ||
| ); | ||
| }); | ||
|
|
||
| it("canonicalizes a backslash drive-path href through HTML sanitization", () => { | ||
| const path = "C:\\Users\\mike\\dev-stuff\\t3code\\apps\\web\\src\\markdown-links.ts"; | ||
|
|
||
| expect(renderMarkdown(`[markdown-links.ts](${path}) is open above.`)).toContain( | ||
| '<a href="C:/Users/mike/dev-stuff/t3code/apps/web/src/markdown-links.ts">markdown-links.ts</a>', | ||
| ); | ||
| }); | ||
|
|
||
| it("percent-encodes a unicode drive-path href through HTML sanitization", () => { | ||
| const path = "C:/Users/mike/dev-stuff/文档/apps/web/src/markdown-links.ts"; | ||
|
|
||
| expect(renderMarkdown(`[markdown-links.ts](${path}) is open above.`)).toContain( | ||
| '<a href="C:/Users/mike/dev-stuff/%E6%96%87%E6%A1%A3/apps/web/src/markdown-links.ts">markdown-links.ts</a>', | ||
| ); | ||
| }); | ||
|
|
||
| it("still removes unsafe schemes", () => { | ||
| expect(renderMarkdown("[unsafe](javascript:alert(1))")).not.toContain("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
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.
Uh oh!
There was an error while loading. Please reload this page.