@astrojs/markdown-remark 0.14.0 → 0.14.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-@astrojs/markdown-remark:build: cache hit, replaying output 6f4b2d3bfc1168f3
+@astrojs/markdown-remark:build: cache hit, replaying output f2df71f430c1c421
 @astrojs/markdown-remark:build: 
-@astrojs/markdown-remark:build: > @astrojs/markdown-remark@0.14.0 build /home/runner/work/astro/astro/packages/markdown/remark
+@astrojs/markdown-remark:build: > @astrojs/markdown-remark@0.14.1 build /home/runner/work/astro/astro/packages/markdown/remark
 @astrojs/markdown-remark:build: > astro-scripts build "src/**/*.ts" && tsc -p tsconfig.json
 @astrojs/markdown-remark:build: 

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @astrojs/markdown-remark
 
+## 0.14.1
+
+### Patch Changes
+
+- [#4176](https://github.com/withastro/astro/pull/4176) [`2675b8633`](https://github.com/withastro/astro/commit/2675b8633c5d5c45b237ec87940d5eaf1bfb1b4b) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Support frontmatter injection for MD and MDX using remark and rehype plugins
+
+* [#4137](https://github.com/withastro/astro/pull/4137) [`471c6f784`](https://github.com/withastro/astro/commit/471c6f784e21399676c8b2002665ffdf83a1c59e) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Speed up internal markdown builds with new vite-plugin markdown
+
+- [#4169](https://github.com/withastro/astro/pull/4169) [`16034f0dd`](https://github.com/withastro/astro/commit/16034f0dd5b3683e9e022dbd413e85bd18d2b031) Thanks [@hippotastic](https://github.com/hippotastic)! - Fix double-escaping of non-highlighted code blocks in Astro-flavored markdown
+
 ## 0.14.0
 
 ### Minor Changes

package/dist/index.js

@@ -5,6 +5,7 @@ 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 { remarkInitializeAstroData } from "./remark-initialize-astro-data.js";
 import remarkMarkAndUnravel from "./remark-mark-and-unravel.js";
 import remarkMdxish from "./remark-mdxish.js";
 import remarkPrism from "./remark-prism.js";
@@ -33,7 +34,7 @@ async function renderMarkdown(content, opts) {
   const input = new VFile({ value: content, path: fileURL });
   const scopedClassName = (_a = opts.$) == null ? void 0 : _a.scopedClassName;
   const { headings, rehypeCollectHeadings } = createCollectHeadings();
-  let parser = unified().use(markdown).use(isAstroFlavoredMd ? [remarkMdxish, remarkMarkAndUnravel, remarkUnwrap, remarkEscape] : []);
+  let parser = unified().use(markdown).use(remarkInitializeAstroData).use(isAstroFlavoredMd ? [remarkMdxish, remarkMarkAndUnravel, remarkUnwrap, remarkEscape] : []);
   if (remarkPlugins.length === 0 && rehypePlugins.length === 0) {
     remarkPlugins = [...DEFAULT_REMARK_PLUGINS];
     rehypePlugins = [...DEFAULT_REHYPE_PLUGINS];
@@ -72,18 +73,18 @@ async function renderMarkdown(content, opts) {
   parser.use(
     isAstroFlavoredMd ? [rehypeJsx, rehypeExpressions, rehypeEscape, rehypeIslands, rehypeCollectHeadings] : [rehypeCollectHeadings, rehypeRaw]
   ).use(rehypeStringify, { allowDangerousHtml: true });
-  let result;
+  let vfile;
   try {
-    const vfile = await parser.process(input);
-    result = vfile.toString();
+    vfile = await parser.process(input);
   } catch (err) {
     err = prefixError(err, `Failed to parse Markdown file "${input.path}"`);
     console.error(err);
     throw err;
   }
   return {
-    metadata: { headings, source: content, html: result.toString() },
-    code: result.toString()
+    metadata: { headings, source: content, html: String(vfile.value) },
+    code: String(vfile.value),
+    vfile
   };
 }
 function prefixError(err, prefix) {

package/dist/rehype-escape.js

@@ -1,4 +1,4 @@
-import { visit } from "unist-util-visit";
+import { SKIP, visit } from "unist-util-visit";
 function escapeEntities(value) {
   return value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
 }
@@ -10,8 +10,8 @@ function rehypeEscape() {
         visit(el, "raw", (raw) => {
           raw.value = escapeEntities(raw.value);
         });
+        return SKIP;
       }
-      return el;
     });
   };
 }

package/dist/remark-initialize-astro-data.d.ts

@@ -0,0 +1,2 @@
+import type { VFile } from 'vfile';
+export declare function remarkInitializeAstroData(): (tree: any, vfile: VFile) => void;

package/dist/remark-initialize-astro-data.js

@@ -0,0 +1,10 @@
+function remarkInitializeAstroData() {
+  return function(tree, vfile) {
+    if (!vfile.data.astro) {
+      vfile.data.astro = { frontmatter: {} };
+    }
+  };
+}
+export {
+  remarkInitializeAstroData
+};

package/dist/types.d.ts

@@ -2,6 +2,7 @@ import type * as hast from 'hast';
 import type * as mdast from 'mdast';
 import type { ILanguageRegistration, IThemeRegistration, Theme } from 'shiki';
 import type * as unified from 'unified';
+import type { VFile } from 'vfile';
 export type { Node } from 'unist';
 export declare type RemarkPlugin<PluginParameters extends any[] = any[]> = unified.Plugin<PluginParameters, mdast.Root>;
 export declare type RemarkPlugins = (string | [string, any] | RemarkPlugin | [RemarkPlugin, any])[];
@@ -41,5 +42,6 @@ export interface MarkdownMetadata {
 }
 export interface MarkdownRenderingResult {
     metadata: MarkdownMetadata;
+    vfile: VFile;
     code: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/markdown-remark",
-  "version": "0.14.0",
+  "version": "0.14.1",
   "type": "module",
   "author": "withastro",
   "license": "MIT",

package/src/index.ts

@@ -7,6 +7,7 @@ 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 { remarkInitializeAstroData } from './remark-initialize-astro-data.js';
 import remarkMarkAndUnravel from './remark-mark-and-unravel.js';
 import remarkMdxish from './remark-mdxish.js';
 import remarkPrism from './remark-prism.js';
@@ -45,6 +46,7 @@ export async function renderMarkdown(
 
 	let parser = unified()
 		.use(markdown)
+		.use(remarkInitializeAstroData)
 		.use(isAstroFlavoredMd ? [remarkMdxish, remarkMarkAndUnravel, remarkUnwrap, remarkEscape] : []);
 
 	if (remarkPlugins.length === 0 && rehypePlugins.length === 0) {
@@ -99,10 +101,9 @@ export async function renderMarkdown(
 		)
 		.use(rehypeStringify, { allowDangerousHtml: true });
 
-	let result: string;
+	let vfile: VFile;
 	try {
-		const vfile = await parser.process(input);
-		result = vfile.toString();
+		vfile = await parser.process(input);
 	} catch (err) {
 		// Ensure that the error message contains the input filename
 		// to make it easier for the user to fix the issue
@@ -113,8 +114,9 @@ export async function renderMarkdown(
 	}
 
 	return {
-		metadata: { headings, source: content, html: result.toString() },
-		code: result.toString(),
+		metadata: { headings, source: content, html: String(vfile.value) },
+		code: String(vfile.value),
+		vfile,
 	};
 }
 

package/src/rehype-escape.ts

@@ -1,4 +1,4 @@
-import { visit } from 'unist-util-visit';
+import { SKIP, visit } from 'unist-util-visit';
 
 export function escapeEntities(value: string): string {
 	return value.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
@@ -14,8 +14,9 @@ export default function rehypeEscape(): any {
 				visit(el, 'raw', (raw) => {
 					raw.value = escapeEntities(raw.value);
 				});
+				// Do not visit children to prevent double escaping
+				return SKIP;
 			}
-			return el;
 		});
 	};
 }

package/src/remark-escape.ts

@@ -2,7 +2,7 @@ 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.
+// HTML comments by vite-plugin-markdown-legacy.
 export default function remarkEscape() {
 	return (tree: any) => {
 		visit(tree, 'code', removeCommentWrapper);

package/src/remark-initialize-astro-data.ts

@@ -0,0 +1,9 @@
+import type { VFile } from 'vfile';
+
+export function remarkInitializeAstroData() {
+	return function (tree: any, vfile: VFile) {
+		if (!vfile.data.astro) {
+			vfile.data.astro = { frontmatter: {} };
+		}
+	};
+}

package/src/types.ts

@@ -2,6 +2,7 @@ import type * as hast from 'hast';
 import type * as mdast from 'mdast';
 import type { ILanguageRegistration, IThemeRegistration, Theme } from 'shiki';
 import type * as unified from 'unified';
+import type { VFile } from 'vfile';
 
 export type { Node } from 'unist';
 
@@ -58,5 +59,6 @@ export interface MarkdownMetadata {
 
 export interface MarkdownRenderingResult {
 	metadata: MarkdownMetadata;
+	vfile: VFile;
 	code: string;
 }

package/test/entities.test.js

@@ -2,11 +2,22 @@ import { renderMarkdown } from '../dist/index.js';
 import { expect } from 'chai';
 
 describe('entities', () => {
-	const renderAstroMd = (text) => renderMarkdown(text, { isAstroFlavoredMd: false });
-
-	it('should not unescape entities', async () => {
-		const { code } = await renderAstroMd(`<i>This should NOT be italic</i>`);
+	it('should not unescape entities in regular Markdown', async () => {
+		const { code } = await renderMarkdown(`<i>This should NOT be italic</i>`, {
+			isAstroFlavoredMd: false,
+		});
 
 		expect(code).to.equal(`<p>&#x3C;i>This should NOT be italic&#x3C;/i></p>`);
 	});
+
+	it('should not escape entities in code blocks twice in Astro-flavored markdown', async () => {
+		const { code } = await renderMarkdown(`\`\`\`astro\n<h1>{x && x.name || ''}!</h1>\n\`\`\``, {
+			isAstroFlavoredMd: true,
+			syntaxHighlight: false,
+		});
+
+		expect(code).to.equal(
+			`<pre is:raw><code class="language-astro">&lt;h1&gt;{x &amp;&amp; x.name || ''}!&lt;/h1&gt;\n</code></pre>`
+		);
+	});
 });