Add function for escaping all markdown special characters #10478
+215
−142
Conversation
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
joelverhagen
reviewed
Jun 2, 2025
joelverhagen
reviewed
Jun 2, 2025
joelverhagen
reviewed
Jun 2, 2025
erdembayar
reviewed
Jul 18, 2025
| @@ -12,6 +13,11 @@ namespace NuGet.Services.Messaging.Email | |||
| /// </summary> | |||
| public abstract class MarkdownEmailBuilder : EmailBuilder | |||
| { | |||
| private static readonly IReadOnlyList<string> SpecialMarkdownChars = | |||
There was a problem hiding this comment.
We're doing kind of double for loop, could we do small perf improvement?
private static readonly HashSet<char> SpecialMarkdownChars = new()
{
'\\', '`', '*', '_', '{', '}', '[', ']', '<', '>', '(', ')', '#', '+', '-', '.', '!', '|'
};
erdembayar
reviewed
Jul 18, 2025
| @@ -40,5 +46,20 @@ protected override string GetHtmlBody() | |||
| { | |||
| return Markdown.ToHtml(GetMarkdownBody()); | |||
| } | |||
|
|
|||
| public static string EscapeMarkdown(string text) | |||
There was a problem hiding this comment.
We can do single for loop.
public static string EscapeMarkdown(string text)
{
if (string.IsNullOrEmpty(text))
return text;
StringBuilder sb = new(text.Length + 10); // preallocate a bit more
foreach (char c in text)
{
if (SpecialMarkdownChars.Contains(c))
sb.Append('\\');
sb.Append(c);
}
return sb.ToString();
}
erdembayar
reviewed
Jul 18, 2025
| private static readonly IReadOnlyList<string> SpecialMarkdownChars = | ||
| [ | ||
| "\\", "`", "*", "_", "{", "}", "[", "]", "<", ">", "(", ")", "#", "+", "-", ".", "!", "|" | ||
| ]; |
There was a problem hiding this comment.
It would be great to include link where you got the list of special characters for the reference.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We aren't correctly escaping the markdown in several of the emails we send. This is especially problematic in emails which reference packages that contain underscores in the ID as the URLs we send are invalid (underscore in markdown is for italics). I fixed this issue in a few common emails, but didn't want to do a full pass as there are a lot of emails and that's out of scope for the specific issue being addressed.
Report Abuse
Before
After
Contact Support (own package)
Before
After
Upload Package
Before
After
Contact Package Owner
Before
After
Addresses #1635