@astrojs/markdown-remark 0.7.0-next.1 → 0.8.1

package/.turbo/turbo-build.log

@@ -0,0 +1,5 @@
+@astrojs/markdown-remark:build: cache hit, replaying output 5817ab166c77bc86
+@astrojs/markdown-remark:build: 
+@astrojs/markdown-remark:build: > @astrojs/markdown-remark@0.8.1 build /Users/fks/Code/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,30 @@
 # @astrojs/markdown-remark
 
+## 0.8.1
+
+### Patch Changes
+
+- [#2971](https://github.com/withastro/astro/pull/2971) [`ad3c3916`](https://github.com/withastro/astro/commit/ad3c391696c5b9cc350a22831717682e73e25776) Thanks [@JuanM04](https://github.com/JuanM04)! - Escape expressions when mode == 'md'
+
+## 0.8.0
+
+### Minor Changes
+
+- [`e425f896`](https://github.com/withastro/astro/commit/e425f896b668d98033ad3b998b50c1f28bc7f6ee) Thanks [@FredKSchott](https://github.com/FredKSchott)! - Update config options to resepect [RFC0019](https://github.com/withastro/rfcs/blob/main/proposals/0019-config-finalization.md)
+
+## 0.7.0
+
+### Minor Changes
+
+- [#2824](https://github.com/withastro/astro/pull/2824) [`0a3d3e51`](https://github.com/withastro/astro/commit/0a3d3e51a66af80fa949ba0f5e2104439d2be634) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Change shiki to our default markdown syntax highlighter. This includes updates to all relevant starter projects that used Prism-specific styles.
+
+### Patch Changes
+
+- [#2870](https://github.com/withastro/astro/pull/2870) [`d763ec18`](https://github.com/withastro/astro/commit/d763ec183ea391ad79ca16bf2b2e76848fc1180c) Thanks [@FredKSchott](https://github.com/FredKSchott)! - Fix a shiki performance issue affecting large sites
+
+- Updated dependencies [[`2db97f10`](https://github.com/withastro/astro/commit/2db97f10dc50f9498413181b78c477fe8833895b)]:
+  - @astrojs/prism@0.4.1
+
 ## 0.7.0-next.1
 
 ### Patch Changes
@@ -174,10 +199,10 @@
 
   ```js
   export default {
-  	markdownOptions: {
-  		remarkPlugins: ['remark-slug', ['remark-autolink-headings', { behavior: 'prepend' }]],
-  		rehypePlugins: ['rehype-slug', ['rehype-autolink-headings', { behavior: 'prepend' }]],
-  	},
+    markdownOptions: {
+      remarkPlugins: ['remark-slug', ['remark-autolink-headings', { behavior: 'prepend' }]],
+      rehypePlugins: ['rehype-slug', ['rehype-autolink-headings', { behavior: 'prepend' }]],
+    },
   };
   ```
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import type { AstroMarkdownOptions, MarkdownRenderingOptions } from './types';
-export { AstroMarkdownOptions, MarkdownRenderingOptions };
+import type { AstroMarkdownOptions, MarkdownRenderingOptions, ShikiConfig, Plugin } from './types';
+export { AstroMarkdownOptions, MarkdownRenderingOptions, ShikiConfig, Plugin };
 /** Internal utility for rendering a full markdown file and extracting Frontmatter data */
 export declare function renderMarkdownWithFrontmatter(contents: string, opts?: MarkdownRenderingOptions | null): Promise<{
     frontmatter: {

package/dist/index.js

@@ -52,7 +52,7 @@ async function renderMarkdown(content, opts) {
   const isMDX = mode === "mdx";
   const { headers, rehypeCollectHeaders } = createCollectHeaders();
   await Promise.all([loadRemarkExpressions(), loadRemarkJsx()]);
-  let parser = unified().use(markdown).use(isMDX ? [remarkJsx] : []).use(isMDX ? [remarkExpressions] : []).use([remarkUnwrap]);
+  let parser = unified().use(markdown).use(isMDX ? [remarkJsx, remarkExpressions] : []).use([remarkUnwrap]);
   if (remarkPlugins.length === 0 && rehypePlugins.length === 0) {
     remarkPlugins = [...DEFAULT_REMARK_PLUGINS];
     rehypePlugins = [...DEFAULT_REHYPE_PLUGINS];
@@ -70,11 +70,19 @@ async function renderMarkdown(content, opts) {
   } else if (syntaxHighlight === "prism") {
     parser.use([remarkPrism(scopedClassName)]);
   }
-  parser.use([[markdownToHtml, { allowDangerousHtml: true, passThrough: ["raw", "mdxTextExpression", "mdxJsxTextElement", "mdxJsxFlowElement"] }]]);
+  parser.use([
+    [
+      markdownToHtml,
+      {
+        allowDangerousHtml: true,
+        passThrough: ["raw", "mdxTextExpression", "mdxJsxTextElement", "mdxJsxFlowElement"]
+      }
+    ]
+  ]);
   loadedRehypePlugins.forEach(([plugin, opts2]) => {
     parser.use([[plugin, opts2]]);
   });
-  parser.use(isMDX ? [rehypeJsx] : []).use(isMDX ? [rehypeExpressions] : []).use(isMDX ? [] : [rehypeRaw]).use(isMDX ? [rehypeEscape] : []).use(rehypeIslands);
+  parser.use(isMDX ? [rehypeJsx, rehypeExpressions] : [rehypeRaw]).use(rehypeEscape).use(rehypeIslands);
   let result;
   try {
     const vfile = await parser.use([rehypeCollectHeaders]).use(rehypeStringify, { allowDangerousHtml: true }).process(content);

package/dist/rehype-islands.js

@@ -26,7 +26,10 @@ function rehypeIslands() {
         visit(el, "text", (child, index, parent) => {
           if (child.type === "text") {
             if (parent && child.value.indexOf("<!--") > -1 && index != null) {
-              parent.children.splice(index, 1, __spreadProps(__spreadValues({}, child), { type: "comment", value: child.value.replace("<!--", "").replace("-->", "").trim() }));
+              parent.children.splice(index, 1, __spreadProps(__spreadValues({}, child), {
+                type: "comment",
+                value: child.value.replace("<!--", "").replace("-->", "").trim()
+              }));
               return [SKIP, index];
             }
             child.value = child.value.replace(/\n+/g, "");

package/dist/remark-prism.js

@@ -1,6 +1,6 @@
 import { visit } from "unist-util-visit";
 import Prism from "prismjs";
-import { addAstro } from "@astrojs/prism";
+import { addAstro } from "@astrojs/prism/internal";
 import loadLanguages from "prismjs/components/index.js";
 const noVisit = /* @__PURE__ */ new Set(["root", "html", "text"]);
 const languageMap = /* @__PURE__ */ new Map([["ts", "typescript"]]);

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 import type * as unified from 'unified';
 import type { ShikiConfig } from './remark-shiki';
+export { ShikiConfig };
 export declare type Plugin = string | [string, any] | unified.Plugin | [unified.Plugin, any];
 export interface AstroMarkdownOptions {
     mode?: 'md' | 'mdx';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/markdown-remark",
-  "version": "0.7.0-next.1",
+  "version": "0.8.1",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -16,7 +16,7 @@
     ".": "./dist/index.js"
   },
   "dependencies": {
-    "@astrojs/prism": "^0.4.1-next.0",
+    "@astrojs/prism": "^0.4.1",
     "assert": "^2.0.0",
     "github-slugger": "^1.4.0",
     "gray-matter": "^4.0.3",

package/src/index.ts

@@ -1,4 +1,4 @@
-import type { AstroMarkdownOptions, MarkdownRenderingOptions } from './types';
+import type { AstroMarkdownOptions, MarkdownRenderingOptions, ShikiConfig, Plugin } from './types';
 
 import createCollectHeaders from './rehype-collect-headers.js';
 import scopedStyles from './remark-scoped-styles.js';
@@ -20,10 +20,13 @@ import rehypeStringify from 'rehype-stringify';
 import rehypeRaw from 'rehype-raw';
 import matter from 'gray-matter';
 
-export { AstroMarkdownOptions, MarkdownRenderingOptions };
+export { AstroMarkdownOptions, MarkdownRenderingOptions, ShikiConfig, Plugin };
 
 /** Internal utility for rendering a full markdown file and extracting Frontmatter data */
-export async function renderMarkdownWithFrontmatter(contents: string, opts?: MarkdownRenderingOptions | null) {
+export async function renderMarkdownWithFrontmatter(
+	contents: string,
+	opts?: MarkdownRenderingOptions | null
+) {
 	const { data: frontmatter, content } = matter(contents);
 	const value = await renderMarkdown(content, opts);
 	return { ...value, frontmatter };
@@ -47,8 +50,7 @@ export async function renderMarkdown(content: string, opts?: MarkdownRenderingOp
 
 	let parser = unified()
 		.use(markdown)
-		.use(isMDX ? [remarkJsx] : [])
-		.use(isMDX ? [remarkExpressions] : [])
+		.use(isMDX ? [remarkJsx, remarkExpressions] : [])
 		.use([remarkUnwrap]);
 
 	if (remarkPlugins.length === 0 && rehypePlugins.length === 0) {
@@ -73,22 +75,31 @@ export async function renderMarkdown(content: string, opts?: MarkdownRenderingOp
 		parser.use([remarkPrism(scopedClassName)]);
 	}
 
-	parser.use([[markdownToHtml as any, { allowDangerousHtml: true, passThrough: ['raw', 'mdxTextExpression', 'mdxJsxTextElement', 'mdxJsxFlowElement'] }]]);
+	parser.use([
+		[
+			markdownToHtml as any,
+			{
+				allowDangerousHtml: true,
+				passThrough: ['raw', 'mdxTextExpression', 'mdxJsxTextElement', 'mdxJsxFlowElement'],
+			},
+		],
+	]);
 
 	loadedRehypePlugins.forEach(([plugin, opts]) => {
 		parser.use([[plugin, opts]]);
 	});
 
 	parser
-		.use(isMDX ? [rehypeJsx] : [])
-		.use(isMDX ? [rehypeExpressions] : [])
-		.use(isMDX ? [] : [rehypeRaw])
-		.use(isMDX ? [rehypeEscape] : [])
+		.use(isMDX ? [rehypeJsx, rehypeExpressions] : [rehypeRaw])
+		.use(rehypeEscape)
 		.use(rehypeIslands);
 
 	let result: string;
 	try {
-		const vfile = await parser.use([rehypeCollectHeaders]).use(rehypeStringify, { allowDangerousHtml: true }).process(content);
+		const vfile = await parser
+			.use([rehypeCollectHeaders])
+			.use(rehypeStringify, { allowDangerousHtml: true })
+			.process(content);
 		result = vfile.toString();
 	} catch (err) {
 		console.error(err);

package/src/rehype-islands.ts

@@ -2,7 +2,11 @@ import { SKIP, visit as _visit } from 'unist-util-visit';
 
 // This is a workaround.
 // It fixes a compatibility issue between different, incompatible ASTs given by plugins to Unist
-const visit = _visit as (node: any, type: string, callback?: (node: any, index: number, parent: any) => any) => any;
+const visit = _visit as (
+	node: any,
+	type: string,
+	callback?: (node: any, index: number, parent: any) => any
+) => 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>
@@ -18,7 +22,11 @@ export default function rehypeIslands(): any {
 						// Sometimes comments can be trapped as text, which causes them to be escaped
 						// This casts them back to real HTML comments
 						if (parent && child.value.indexOf('<!--') > -1 && index != null) {
-							parent.children.splice(index, 1, { ...child, type: 'comment', value: child.value.replace('<!--', '').replace('-->', '').trim() });
+							parent.children.splice(index, 1, {
+								...child,
+								type: 'comment',
+								value: child.value.replace('<!--', '').replace('-->', '').trim(),
+							});
 							return [SKIP, index];
 						}
 						// For some reason `rehype` likes to inject extra linebreaks,

package/src/remark-prism.ts

@@ -1,6 +1,6 @@
 import { visit } from 'unist-util-visit';
 import Prism from 'prismjs';
-import { addAstro } from '@astrojs/prism';
+import { addAstro } from '@astrojs/prism/internal';
 import loadLanguages from 'prismjs/components/index.js';
 const noVisit = new Set(['root', 'html', 'text']);
 
@@ -56,7 +56,9 @@ function transformer(className: MaybeString) {
 			if (className) {
 				classes.push(className);
 			}
-			node.value = `<pre class="${classes.join(' ')}"><code is:raw class="${classLanguage}">${html}</code></pre>`;
+			node.value = `<pre class="${classes.join(
+				' '
+			)}"><code is:raw class="${classLanguage}">${html}</code></pre>`;
 			return node;
 		};
 		return visit(tree, 'code', visitor);

package/src/remark-shiki.ts

@@ -37,7 +37,10 @@ export interface ShikiConfig {
  */
 const highlighterCacheAsync = new Map<string, Promise<shiki.Highlighter>>();
 
-const remarkShiki = async ({ langs = [], theme = 'github-dark', wrap = false }: ShikiConfig, scopedClassName?: string | null) => {
+const remarkShiki = async (
+	{ langs = [], theme = 'github-dark', wrap = false }: ShikiConfig,
+	scopedClassName?: string | null
+) => {
 	const cacheID: string = typeof theme === 'string' ? theme : theme.name;
 	let highlighterAsync = highlighterCacheAsync.get(cacheID);
 	if (!highlighterAsync) {
@@ -63,15 +66,24 @@ const remarkShiki = async ({ langs = [], theme = 'github-dark', wrap = false }:
 			// &lt;span class=&quot;line&quot;
 
 			// Replace "shiki" class naming with "astro" and add "is:raw".
-			html = html.replace('<pre class="shiki"', `<pre is:raw class="astro-code${scopedClassName ? ' ' + scopedClassName : ''}"`);
+			html = html.replace(
+				'<pre class="shiki"',
+				`<pre is:raw class="astro-code${scopedClassName ? ' ' + scopedClassName : ''}"`
+			);
 			// Replace "shiki" css variable naming with "astro".
-			html = html.replace(/style="(background-)?color: var\(--shiki-/g, 'style="$1color: var(--astro-code-');
+			html = html.replace(
+				/style="(background-)?color: var\(--shiki-/g,
+				'style="$1color: var(--astro-code-'
+			);
 			// Handle code wrapping
 			// if wrap=null, do nothing.
 			if (wrap === false) {
 				html = html.replace(/style="(.*?)"/, 'style="$1; overflow-x: auto;"');
 			} else if (wrap === true) {
-				html = html.replace(/style="(.*?)"/, 'style="$1; overflow-x: auto; white-space: pre-wrap; word-wrap: break-word;"');
+				html = html.replace(
+					/style="(.*?)"/,
+					'style="$1; overflow-x: auto; white-space: pre-wrap; word-wrap: break-word;"'
+				);
 			}
 
 			// Apply scopedClassName to all nested lines

package/src/remark-unwrap.ts

@@ -2,7 +2,11 @@ import { visit as _visit, SKIP } from 'unist-util-visit';
 
 // This is a workaround.
 // It fixes a compatibility issue between different, incompatible ASTs given by plugins to Unist
-const visit = _visit as (node: any, type: string, callback?: (node: any, index: number, parent: any) => any) => any;
+const visit = _visit as (
+	node: any,
+	type: string,
+	callback?: (node: any, index: number, parent: any) => any
+) => any;
 
 // Remove the wrapping paragraph for <astro-root> islands
 export default function remarkUnwrap() {
@@ -33,6 +37,8 @@ export default function remarkUnwrap() {
 	};
 
 	function containsAstroRootNode(node: any) {
-		return node.children.map((child: any) => astroRootNodes.has(child)).reduce((all: boolean, v: boolean) => (all ? all : v), false);
+		return node.children
+			.map((child: any) => astroRootNodes.has(child))
+			.reduce((all: boolean, v: boolean) => (all ? all : v), false);
 	}
 }

package/src/types.ts

@@ -1,5 +1,6 @@
 import type * as unified from 'unified';
 import type { ShikiConfig } from './remark-shiki';
+export { ShikiConfig };
 
 export type Plugin = string | [string, any] | unified.Plugin | [unified.Plugin, any];