fix: url tokenizer to not treat package version string as email (#280)

* fix: url tokenizer to not treat package version string as email * Add type --------- Co-authored-by: Puru <[email protected]> Co-authored-by: Puru Vijay <[email protected]>
sveltejs · May 10, 2024 · 5b13f8f · 5b13f8f
1 parent 3966cbe
commit 5b13f8f
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/.changeset/odd-waves-glow.md b/.changeset/odd-waves-glow.md
@@ -0,0 +1,5 @@
+---
+'@sveltejs/site-kit': patch
+---
+
+fix: url tokenizer to not treat package version string as email
diff --git a/packages/site-kit/src/lib/markdown/utils.js b/packages/site-kit/src/lib/markdown/utils.js
@@ -208,6 +208,19 @@ const default_renderer = {
 	}
 };
 
+/** @type {import('marked').TokenizerObject} */
+const tokenizer = {
+	url(src) {
+		// if `src` is a package version string, eg: [email protected]
+		// do not tokenize it as email
+		if (/@\d+\.\d+\.\d+/.test(src)) {
+			return undefined;
+		}
+		// else, use the default tokenizer behavior
+		return false;
+	}
+};
+
 /**
  * @param {string} markdown
  * @param {Partial<import('marked').Renderer>} renderer
@@ -217,7 +230,8 @@ export async function transform(markdown, renderer = {}) {
 		renderer: {
 			...default_renderer,
 			...renderer
-		}
+		},
+		tokenizer
 	});
 
 	return (await marked.parse(markdown)) ?? '';