@astrojs/markdown-remark 0.11.2 → 0.11.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @astrojs/markdown-remark
 
+## 0.11.3
+
+### Patch Changes
+
+- [#3638](https://github.com/withastro/astro/pull/3638) [`80c71c7c`](https://github.com/withastro/astro/commit/80c71c7c56d15dc05ec0c5a848130aad222d7d51) Thanks [@tony-sull](https://github.com/tony-sull)! - Fix: HTML comments in markdown code blocks should not be wrapped in JS comments
+
+* [#3612](https://github.com/withastro/astro/pull/3612) [`fca58cfd`](https://github.com/withastro/astro/commit/fca58cfd91b68501ec82350ab023170b208d8ce7) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Fix: "vpath" import error when building for netlify edge
+
+- [#3630](https://github.com/withastro/astro/pull/3630) [`48e67fe0`](https://github.com/withastro/astro/commit/48e67fe05398dc4b1fca12db36c1b37bb341277a) Thanks [@tony-sull](https://github.com/tony-sull)! - Encodes ampersand characters in code blocks
+
+* [#3620](https://github.com/withastro/astro/pull/3620) [`05aa7244`](https://github.com/withastro/astro/commit/05aa72442cd4512b94abdb39623e8caa2c1839b0) Thanks [@hippotastic](https://github.com/hippotastic)! - Remove extra newlines around Markdown components
+
 ## 0.11.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -2,6 +2,5 @@ import type { MarkdownRenderingOptions, MarkdownRenderingResult } from './types'
 export * from './types.js';
 export declare const DEFAULT_REMARK_PLUGINS: string[];
 export declare const DEFAULT_REHYPE_PLUGINS: never[];
-export declare function slug(value: string): string;
 /** Shared utility for rendering markdown */
 export declare function renderMarkdown(content: string, opts?: MarkdownRenderingOptions): Promise<MarkdownRenderingResult>;

package/dist/index.js

@@ -4,13 +4,13 @@ import rehypeEscape from "./rehype-escape.js";
 import rehypeExpressions from "./rehype-expressions.js";
 import rehypeIslands from "./rehype-islands.js";
 import rehypeJsx from "./rehype-jsx.js";
+import remarkEscape from "./remark-escape.js";
 import remarkMarkAndUnravel from "./remark-mark-and-unravel.js";
 import remarkMdxish from "./remark-mdxish.js";
 import remarkPrism from "./remark-prism.js";
 import scopedStyles from "./remark-scoped-styles.js";
 import remarkShiki from "./remark-shiki.js";
 import remarkUnwrap from "./remark-unwrap.js";
-import Slugger from "github-slugger";
 import rehypeRaw from "rehype-raw";
 import rehypeStringify from "rehype-stringify";
 import markdown from "remark-parse";
@@ -20,10 +20,6 @@ import { VFile } from "vfile";
 export * from "./types.js";
 const DEFAULT_REMARK_PLUGINS = ["remark-gfm", "remark-smartypants"];
 const DEFAULT_REHYPE_PLUGINS = [];
-const slugger = new Slugger();
-function slug(value) {
-  return slugger.slug(value);
-}
 async function renderMarkdown(content, opts = {}) {
   var _a;
   let {
@@ -38,7 +34,7 @@ async function renderMarkdown(content, opts = {}) {
   const scopedClassName = (_a = opts.$) == null ? void 0 : _a.scopedClassName;
   const isMDX = mode === "mdx";
   const { headers, rehypeCollectHeaders } = createCollectHeaders();
-  let parser = unified().use(markdown).use(isMDX ? [remarkMdxish, remarkMarkAndUnravel] : []).use([remarkUnwrap]);
+  let parser = unified().use(markdown).use(isMDX ? [remarkMdxish, remarkMarkAndUnravel] : []).use([remarkUnwrap, remarkEscape]);
   if (remarkPlugins.length === 0 && rehypePlugins.length === 0) {
     remarkPlugins = [...DEFAULT_REMARK_PLUGINS];
     rehypePlugins = [...DEFAULT_REHYPE_PLUGINS];
@@ -109,6 +105,5 @@ ${err.message}`;
 export {
   DEFAULT_REHYPE_PLUGINS,
   DEFAULT_REMARK_PLUGINS,
-  renderMarkdown,
-  slug
+  renderMarkdown
 };

package/dist/rehype-collect-headers.js

@@ -23,7 +23,7 @@ function createCollectHeaders() {
             return;
           }
           if (child.type === "raw") {
-            if (child.value.startsWith("\n<") || child.value.endsWith(">\n")) {
+            if (child.value.match(/^\n?<.*>\n?$/)) {
               return;
             }
           }

package/dist/rehype-escape.js

@@ -5,7 +5,7 @@ function rehypeEscape() {
       if (el.tagName === "code" || el.tagName === "pre") {
         el.properties["is:raw"] = true;
         visit(el, "raw", (raw) => {
-          raw.value = raw.value.replace(/</g, "&lt;").replace(/>/g, "&gt;");
+          raw.value = raw.value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
         });
       }
       return el;

package/dist/rehype-islands.js

@@ -22,7 +22,7 @@ const visit = _visit;
 function rehypeIslands() {
   return function(node) {
     return visit(node, "element", (el) => {
-      if (el.tagName == "astro-root") {
+      if (el.tagName == "astro-island") {
         visit(el, "text", (child, index, parent) => {
           if (child.type === "text") {
             if (parent && child.value.indexOf("<!--") > -1 && index != null) {

package/dist/rehype-jsx.js

@@ -36,13 +36,11 @@ function rehypeJsx() {
       }
       const openingTag = {
         type: "raw",
-        value: `
-<${node.name}${attrs}>`
+        value: `<${node.name}${attrs}>`
       };
       const closingTag = {
         type: "raw",
-        value: `</${node.name}>
-`
+        value: `</${node.name}>`
       };
       parent.children.splice(index, 1, openingTag, ...node.children, closingTag);
     });

package/dist/remark-escape.d.ts

@@ -0,0 +1 @@
+export default function remarkEscape(): (tree: any) => void;

package/dist/remark-escape.js

@@ -0,0 +1,13 @@
+import { visit } from "unist-util-visit";
+function remarkEscape() {
+  return (tree) => {
+    visit(tree, "code", removeCommentWrapper);
+    visit(tree, "inlineCode", removeCommentWrapper);
+  };
+  function removeCommentWrapper(node) {
+    node.value = node.value.replace(/{\/\*<!--/gs, "<!--").replace(/-->\*\/}/gs, "-->");
+  }
+}
+export {
+  remarkEscape as default
+};

package/dist/remark-unwrap.js

@@ -7,10 +7,10 @@ function remarkUnwrap() {
     insideAstroRoot = false;
     astroRootNodes.clear();
     visit(tree, "html", (node) => {
-      if (node.value.indexOf("<astro-root") > -1 && !insideAstroRoot) {
+      if (node.value.indexOf("<astro-island") > -1 && !insideAstroRoot) {
         insideAstroRoot = true;
       }
-      if (node.value.indexOf("</astro-root") > -1 && insideAstroRoot) {
+      if (node.value.indexOf("</astro-island") > -1 && insideAstroRoot) {
         insideAstroRoot = false;
       }
       astroRootNodes.add(node);

package/dist/ssr-utils.d.ts

@@ -0,0 +1,2 @@
+/** @see {@link "/packages/astro/vite-plugin-markdown"} */
+export declare function slug(value: string): string;

package/dist/ssr-utils.js

@@ -0,0 +1,8 @@
+import Slugger from "github-slugger";
+const slugger = new Slugger();
+function slug(value) {
+  return slugger.slug(value);
+}
+export {
+  slug
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/markdown-remark",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -13,7 +13,8 @@
   "homepage": "https://astro.build",
   "main": "./dist/index.js",
   "exports": {
-    ".": "./dist/index.js"
+    ".": "./dist/index.js",
+    "./ssr-utils": "./dist/ssr-utils.js"
   },
   "dependencies": {
     "@astrojs/micromark-extension-mdx-jsx": "^1.0.3",

package/src/index.ts

@@ -6,6 +6,7 @@ import rehypeEscape from './rehype-escape.js';
 import rehypeExpressions from './rehype-expressions.js';
 import rehypeIslands from './rehype-islands.js';
 import rehypeJsx from './rehype-jsx.js';
+import remarkEscape from './remark-escape.js';
 import remarkMarkAndUnravel from './remark-mark-and-unravel.js';
 import remarkMdxish from './remark-mdxish.js';
 import remarkPrism from './remark-prism.js';
@@ -13,7 +14,6 @@ import scopedStyles from './remark-scoped-styles.js';
 import remarkShiki from './remark-shiki.js';
 import remarkUnwrap from './remark-unwrap.js';
 
-import Slugger from 'github-slugger';
 import rehypeRaw from 'rehype-raw';
 import rehypeStringify from 'rehype-stringify';
 import markdown from 'remark-parse';
@@ -26,11 +26,6 @@ export * from './types.js';
 export const DEFAULT_REMARK_PLUGINS = ['remark-gfm', 'remark-smartypants'];
 export const DEFAULT_REHYPE_PLUGINS = [];
 
-const slugger = new Slugger();
-export function slug(value: string): string {
-	return slugger.slug(value);
-}
-
 /** Shared utility for rendering markdown */
 export async function renderMarkdown(
 	content: string,
@@ -52,7 +47,7 @@ export async function renderMarkdown(
 	let parser = unified()
 		.use(markdown)
 		.use(isMDX ? [remarkMdxish, remarkMarkAndUnravel] : [])
-		.use([remarkUnwrap]);
+		.use([remarkUnwrap, remarkEscape]);
 
 	if (remarkPlugins.length === 0 && rehypePlugins.length === 0) {
 		remarkPlugins = [...DEFAULT_REMARK_PLUGINS];

package/src/rehype-collect-headers.ts

@@ -25,7 +25,7 @@ export default function createCollectHeaders() {
 						return;
 					}
 					if (child.type === 'raw') {
-						if (child.value.startsWith('\n<') || child.value.endsWith('>\n')) {
+						if (child.value.match(/^\n?<.*>\n?$/)) {
 							return;
 						}
 					}

package/src/rehype-escape.ts

@@ -8,7 +8,7 @@ export default function rehypeEscape(): any {
 				// Visit all raw children and escape HTML tags to prevent Markdown code
 				// like "This is a `<script>` tag" from actually opening a script tag
 				visit(el, 'raw', (raw) => {
-					raw.value = raw.value.replace(/</g, '&lt;').replace(/>/g, '&gt;');
+					raw.value = raw.value.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
 				});
 			}
 			return el;

package/src/rehype-islands.ts

@@ -9,14 +9,14 @@ const visit = _visit as (
 ) => any;
 
 // This fixes some confusing bugs coming from somewhere inside of our Markdown pipeline.
-// `unist`/`remark`/`rehype` (not sure) often generate malformed HTML inside of <astro-root>
+// `unist`/`remark`/`rehype` (not sure) often generate malformed HTML inside of <astro-island>
 // For hydration to work properly, frameworks need the DOM to be the exact same on server/client.
 // This reverts some "helpful corrections" that are applied to our perfectly valid HTML!
 export default function rehypeIslands(): any {
 	return function (node: any): any {
 		return visit(node, 'element', (el) => {
-			// Bugs only happen inside of <astro-root> islands
-			if (el.tagName == 'astro-root') {
+			// Bugs only happen inside of <astro-island> islands
+			if (el.tagName == 'astro-island') {
 				visit(el, 'text', (child, index, parent) => {
 					if (child.type === 'text') {
 						// Sometimes comments can be trapped as text, which causes them to be escaped

package/src/rehype-jsx.ts

@@ -53,11 +53,11 @@ export default function rehypeJsx(): ReturnType<RehypePlugin> {
 			// wrapped by raw opening and closing tags
 			const openingTag = {
 				type: 'raw',
-				value: `\n<${node.name}${attrs}>`,
+				value: `<${node.name}${attrs}>`,
 			};
 			const closingTag = {
 				type: 'raw',
-				value: `</${node.name}>\n`,
+				value: `</${node.name}>`,
 			};
 			parent.children.splice(index, 1, openingTag, ...node.children, closingTag);
 		});

package/src/remark-escape.ts

@@ -0,0 +1,15 @@
+import type { Literal } from 'unist';
+import { visit } from 'unist-util-visit';
+
+// In code blocks, this removes the JS comment wrapper added to
+// HTML comments by vite-plugin-markdown.
+export default function remarkEscape() {
+	return (tree: any) => {
+		visit(tree, 'code', removeCommentWrapper);
+		visit(tree, 'inlineCode', removeCommentWrapper);
+	};
+
+	function removeCommentWrapper(node: Literal<string>) {
+		node.value = node.value.replace(/{\/\*<!--/gs, '<!--').replace(/-->\*\/}/gs, '-->');
+	}
+}

package/src/remark-unwrap.ts

@@ -8,7 +8,7 @@ const visit = _visit as (
 	callback?: (node: any, index: number, parent: any) => any
 ) => any;
 
-// Remove the wrapping paragraph for <astro-root> islands
+// Remove the wrapping paragraph for <astro-island> islands
 export default function remarkUnwrap() {
 	const astroRootNodes = new Set();
 	let insideAstroRoot = false;
@@ -19,10 +19,10 @@ export default function remarkUnwrap() {
 		astroRootNodes.clear();
 
 		visit(tree, 'html', (node) => {
-			if (node.value.indexOf('<astro-root') > -1 && !insideAstroRoot) {
+			if (node.value.indexOf('<astro-island') > -1 && !insideAstroRoot) {
 				insideAstroRoot = true;
 			}
-			if (node.value.indexOf('</astro-root') > -1 && insideAstroRoot) {
+			if (node.value.indexOf('</astro-island') > -1 && insideAstroRoot) {
 				insideAstroRoot = false;
 			}
 			astroRootNodes.add(node);

package/src/ssr-utils.ts

@@ -0,0 +1,8 @@
+/** Utilities used in deployment-ready SSR bundles */
+import Slugger from 'github-slugger';
+
+const slugger = new Slugger();
+/** @see {@link "/packages/astro/vite-plugin-markdown"} */
+export function slug(value: string): string {
+	return slugger.slug(value);
+}

package/test/components.test.js

@@ -49,7 +49,7 @@ describe('components', () => {
 	it('should normalize children', async () => {
 		const { code } = await renderMarkdown(`<Component bool={true}>Hello world!</Component>`, {});
 
-		chai.expect(code).to.equal(`\n<Component bool={true}>Hello world!</Component>\n`);
+		chai.expect(code).to.equal(`<Component bool={true}>Hello world!</Component>`);
 	});
 
 	it('should be able to nest components', async () => {
@@ -60,7 +60,7 @@ describe('components', () => {
 
 		chai
 			.expect(code)
-			.to.equal(`\n<Component bool={true}>\n<Component>Hello world!</Component>\n</Component>\n`);
+			.to.equal(`<Component bool={true}><Component>Hello world!</Component></Component>`);
 	});
 
 	it('should allow markdown without many spaces', async () => {
@@ -71,6 +71,6 @@ describe('components', () => {
 			{}
 		);
 
-		chai.expect(code).to.equal(`\n<Component><h1 id="hello-world">Hello world!</h1></Component>\n`);
+		chai.expect(code).to.equal(`<Component><h1 id="hello-world">Hello world!</h1></Component>`);
 	});
 });

package/test/expressions.test.js

@@ -1,5 +1,5 @@
 import { renderMarkdown } from '../dist/index.js';
-import chai from 'chai';
+import chai, { expect } from 'chai';
 
 describe('expressions', () => {
 	it('should be able to serialize bare expression', async () => {
@@ -11,7 +11,7 @@ describe('expressions', () => {
 	it('should be able to serialize expression inside component', async () => {
 		const { code } = await renderMarkdown(`<Component>{a}</Component>`, {});
 
-		chai.expect(code).to.equal(`\n<Component>{a}</Component>\n`);
+		chai.expect(code).to.equal(`<Component>{a}</Component>`);
 	});
 
 	it('should be able to serialize expression inside markdown', async () => {
@@ -71,6 +71,29 @@ describe('expressions', () => {
 			);
 	});
 
+	it('should be able to encode ampersand characters in code blocks', async () => {
+		const { code } = await renderMarkdown(
+			'The ampersand in `&nbsp;` must be encoded in code blocks.',
+			{}
+		);
+
+		chai
+			.expect(code)
+			.to.equal(
+				'<p>The ampersand in <code is:raw>&amp;nbsp;</code> must be encoded in code blocks.</p>'
+			);
+	});
+
+	it('should be able to encode ampersand characters in fenced code blocks', async () => {
+		const { code } = await renderMarkdown(`
+		\`\`\`md
+			The ampersand in \`&nbsp;\` must be encoded in code blocks.
+		\`\`\`
+		`);
+
+		chai.expect(code).to.match(/^<pre is:raw.*<code>.*The ampersand in `&amp;nbsp;`/);
+	});
+
 	it('should be able to serialize function expression', async () => {
 		const { code } = await renderMarkdown(
 			`{frontmatter.list.map(item => <p id={item}>{item}</p>)}`,
@@ -79,4 +102,22 @@ describe('expressions', () => {
 
 		chai.expect(code).to.equal(`{frontmatter.list.map(item => <p id={item}>{item}</p>)}`);
 	});
+
+	it('should unwrap HTML comments in inline code blocks', async () => {
+		const { code } = await renderMarkdown(`\`{/*<!-- HTML comment -->*/}\``);
+
+		chai.expect(code).to.equal('<p><code is:raw>&lt;!-- HTML comment --&gt;</code></p>');
+	});
+
+	it('should unwrap HTML comments in code fences', async () => {
+		const { code } = await renderMarkdown(
+			`
+			  \`\`\`
+				<!-- HTML comment -->
+				\`\`\`
+			`
+		);
+
+		chai.expect(code).to.match(/(?<!{\/\*)&lt;!-- HTML comment --&gt;(?!\*\/})/);
+	});
 });