@astrojs/markdown-remark 0.13.0 → 1.0.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-@astrojs/markdown-remark:build: cache hit, replaying output a1025d081834f1c0
-@astrojs/markdown-remark:build: 
-@astrojs/markdown-remark:build: > @astrojs/markdown-remark@0.13.0 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: 
+@astrojs/markdown-remark:build: cache hit, replaying output 08cb56cbe86045e2
+@astrojs/markdown-remark:build: 
+@astrojs/markdown-remark:build: > @astrojs/markdown-remark@1.0.0 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,39 @@
 # @astrojs/markdown-remark
 
+## 1.0.0
+
+### Major Changes
+
+- [`04ad44563`](https://github.com/withastro/astro/commit/04ad445632c67bdd60c1704e1e0dcbcaa27b9308) - > Astro v1.0 is out! Read the [official announcement post](https://astro.build/blog/astro-1/).
+
+  **No breaking changes**. This package is now officially stable and compatible with `astro@1.0.0`!
+
+### Patch Changes
+
+- Updated dependencies [[`04ad44563`](https://github.com/withastro/astro/commit/04ad445632c67bdd60c1704e1e0dcbcaa27b9308)]:
+  - @astrojs/prism@1.0.0
+
+## 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
+
+- [#4114](https://github.com/withastro/astro/pull/4114) [`64432bcb8`](https://github.com/withastro/astro/commit/64432bcb873efd0e4297c00fc9583a1fe516dfe7) Thanks [@Princesseuh](https://github.com/Princesseuh)! - Refactor `@astrojs/mdx` and `@astrojs/markdown-remark` to use `@astrojs/prism` instead of duplicating the code
+
+### Patch Changes
+
+- Updated dependencies [[`64432bcb8`](https://github.com/withastro/astro/commit/64432bcb873efd0e4297c00fc9583a1fe516dfe7)]:
+  - @astrojs/prism@0.7.0
+
 ## 0.13.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.d.ts

@@ -1 +1,2 @@
+export declare function escapeEntities(value: string): string;
 export default function rehypeEscape(): any;

package/dist/rehype-escape.js

@@ -1,17 +1,21 @@
-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;");
+}
 function rehypeEscape() {
   return function(node) {
     return visit(node, "element", (el) => {
       if (el.tagName === "code" || el.tagName === "pre") {
         el.properties["is:raw"] = true;
         visit(el, "raw", (raw) => {
-          raw.value = raw.value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+          raw.value = escapeEntities(raw.value);
         });
+        return SKIP;
       }
-      return el;
     });
   };
 }
 export {
-  rehypeEscape as default
+  rehypeEscape as default,
+  escapeEntities
 };

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/remark-prism.js

@@ -1,44 +1,12 @@
-import { addAstro } from "@astrojs/prism/internal";
-import Prism from "prismjs";
-import loadLanguages from "prismjs/components/index.js";
+import { runHighlighterWithAstro } from "@astrojs/prism/dist/highlighter";
 import { visit } from "unist-util-visit";
 const noVisit = /* @__PURE__ */ new Set(["root", "html", "text"]);
-const languageMap = /* @__PURE__ */ new Map([["ts", "typescript"]]);
-function runHighlighter(lang, code) {
-  let classLanguage = `language-${lang}`;
-  if (lang == null) {
-    lang = "plaintext";
-  }
-  const ensureLoaded = (language) => {
-    if (language && !Prism.languages[language]) {
-      loadLanguages([language]);
-    }
-  };
-  if (languageMap.has(lang)) {
-    ensureLoaded(languageMap.get(lang));
-  } else if (lang === "astro") {
-    ensureLoaded("typescript");
-    addAstro(Prism);
-  } else {
-    ensureLoaded("markup-templating");
-    ensureLoaded(lang);
-  }
-  if (lang && !Prism.languages[lang]) {
-    console.warn(`Unable to load the language: ${lang}`);
-  }
-  const grammar = Prism.languages[lang];
-  let html = code;
-  if (grammar) {
-    html = Prism.highlight(code, grammar, lang);
-  }
-  return { classLanguage, html };
-}
 function transformer(className) {
   return function(tree) {
     const visitor = (node) => {
       let { lang, value } = node;
       node.type = "html";
-      let { html, classLanguage } = runHighlighter(lang, value);
+      let { html, classLanguage } = runHighlighterWithAstro(lang, value);
       let classes = [classLanguage];
       if (className) {
         classes.push(className);

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.13.0",
+  "version": "1.0.0",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -17,18 +17,15 @@
   },
   "dependencies": {
     "@astrojs/micromark-extension-mdx-jsx": "^1.0.3",
-    "@astrojs/prism": "^0.6.1",
+    "@astrojs/prism": "^1.0.0",
     "acorn": "^8.7.1",
     "acorn-jsx": "^5.3.2",
-    "assert": "^2.0.0",
     "github-slugger": "^1.4.0",
     "mdast-util-mdx-expression": "^1.2.1",
     "mdast-util-mdx-jsx": "^1.2.0",
-    "mdast-util-to-string": "^3.1.0",
     "micromark-extension-mdx-expression": "^1.0.3",
     "micromark-extension-mdx-md": "^1.0.0",
     "micromark-util-combine-extensions": "^1.0.0",
-    "prismjs": "^1.28.0",
     "rehype-raw": "^6.1.1",
     "rehype-stringify": "^9.0.3",
     "remark-gfm": "^3.0.1",
@@ -47,9 +44,8 @@
     "@types/hast": "^2.3.4",
     "@types/mdast": "^3.0.10",
     "@types/mocha": "^9.1.1",
-    "@types/prismjs": "^1.26.0",
     "@types/unist": "^2.0.6",
-    "astro-scripts": "0.0.6",
+    "astro-scripts": "0.0.7",
     "chai": "^4.3.6",
     "micromark-util-types": "^1.0.2",
     "mocha": "^9.2.2"

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,8 @@
-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;');
+}
 
 export default function rehypeEscape(): any {
 	return function (node: any): any {
@@ -8,10 +12,11 @@ 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, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
+					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/remark-prism.ts

@@ -1,48 +1,7 @@
-import { addAstro } from '@astrojs/prism/internal';
-import Prism from 'prismjs';
-import loadLanguages from 'prismjs/components/index.js';
+import { runHighlighterWithAstro } from '@astrojs/prism/dist/highlighter';
 import { visit } from 'unist-util-visit';
 const noVisit = new Set(['root', 'html', 'text']);
 
-const languageMap = new Map([['ts', 'typescript']]);
-
-function runHighlighter(lang: string, code: string) {
-	let classLanguage = `language-${lang}`;
-
-	if (lang == null) {
-		lang = 'plaintext';
-	}
-
-	const ensureLoaded = (language: string) => {
-		if (language && !Prism.languages[language]) {
-			loadLanguages([language]);
-		}
-	};
-
-	if (languageMap.has(lang)) {
-		ensureLoaded(languageMap.get(lang)!);
-	} else if (lang === 'astro') {
-		ensureLoaded('typescript');
-		addAstro(Prism);
-	} else {
-		ensureLoaded('markup-templating'); // Prism expects this to exist for a number of other langs
-		ensureLoaded(lang);
-	}
-
-	if (lang && !Prism.languages[lang]) {
-		// eslint-disable-next-line no-console
-		console.warn(`Unable to load the language: ${lang}`);
-	}
-
-	const grammar = Prism.languages[lang];
-	let html = code;
-	if (grammar) {
-		html = Prism.highlight(code, grammar, lang);
-	}
-
-	return { classLanguage, html };
-}
-
 type MaybeString = string | null | undefined;
 
 /**  */
@@ -52,7 +11,7 @@ function transformer(className: MaybeString) {
 			let { lang, value } = node;
 			node.type = 'html';
 
-			let { html, classLanguage } = runHighlighter(lang, value);
+			let { html, classLanguage } = runHighlighterWithAstro(lang, value);
 			let classes = [classLanguage];
 			if (className) {
 				classes.push(className);

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

@@ -0,0 +1,23 @@
+import { renderMarkdown } from '../dist/index.js';
+import { expect } from 'chai';
+
+describe('entities', () => {
+	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>`
+		);
+	});
+});