@astrojs/markdown-remark 3.4.0 → 4.0.0-beta.0

package/dist/frontmatter-injection.d.ts

@@ -4,9 +4,3 @@ export declare class InvalidAstroDataError extends TypeError {
 }
 export declare function safelyGetAstroData(vfileData: Data): MarkdownAstroData | InvalidAstroDataError;
 export declare function setVfileFrontmatter(vfile: VFile, frontmatter: Record<string, any>): void;
-/**
- * @deprecated Use `setVfileFrontmatter` instead
- */
-export declare function toRemarkInitializeAstroData({ userFrontmatter, }: {
-    userFrontmatter: Record<string, any>;
-}): () => (tree: any, vfile: VFile) => void;

package/dist/frontmatter-injection.js

@@ -24,18 +24,8 @@ function setVfileFrontmatter(vfile, frontmatter) {
   vfile.data.astro ??= {};
   vfile.data.astro.frontmatter = frontmatter;
 }
-function toRemarkInitializeAstroData({
-  userFrontmatter
-}) {
-  return () => function(tree, vfile) {
-    if (!vfile.data.astro) {
-      vfile.data.astro = { frontmatter: userFrontmatter };
-    }
-  };
-}
 export {
   InvalidAstroDataError,
   safelyGetAstroData,
-  setVfileFrontmatter,
-  toRemarkInitializeAstroData
+  setVfileFrontmatter
 };

package/dist/index.d.ts

@@ -1,18 +1,13 @@
-import type { AstroMarkdownOptions, MarkdownProcessor, MarkdownRenderingOptions, MarkdownRenderingResult } from './types.js';
+import type { AstroMarkdownOptions, MarkdownProcessor } from './types.js';
 export { InvalidAstroDataError, setVfileFrontmatter } from './frontmatter-injection.js';
 export { rehypeHeadingIds } from './rehype-collect-headings.js';
 export { remarkCollectImages } from './remark-collect-images.js';
 export { remarkPrism } from './remark-prism.js';
 export { remarkShiki } from './remark-shiki.js';
+export { createShikiHighlighter, replaceCssVariables, type ShikiHighlighter } from './shiki.js';
 export * from './types.js';
-export declare const markdownConfigDefaults: Omit<Required<AstroMarkdownOptions>, 'drafts'>;
+export declare const markdownConfigDefaults: Required<AstroMarkdownOptions>;
 /**
  * Create a markdown preprocessor to render multiple markdown files
  */
 export declare function createMarkdownProcessor(opts?: AstroMarkdownOptions): Promise<MarkdownProcessor>;
-/**
- * Shared utility for rendering markdown
- *
- * @deprecated Use `createMarkdownProcessor` instead for better performance
- */
-export declare function renderMarkdown(content: string, opts: MarkdownRenderingOptions): Promise<MarkdownRenderingResult>;

package/dist/index.js

@@ -22,6 +22,7 @@ import { rehypeHeadingIds as rehypeHeadingIds2 } from "./rehype-collect-headings
 import { remarkCollectImages as remarkCollectImages2 } from "./remark-collect-images.js";
 import { remarkPrism as remarkPrism2 } from "./remark-prism.js";
 import { remarkShiki as remarkShiki2 } from "./remark-shiki.js";
+import { createShikiHighlighter, replaceCssVariables } from "./shiki.js";
 export * from "./types.js";
 const markdownConfigDefaults = {
   syntaxHighlight: "shiki",
@@ -102,31 +103,11 @@ async function createMarkdownProcessor(opts) {
           headings: result.data.__astroHeadings ?? [],
           imagePaths: result.data.imagePaths ?? /* @__PURE__ */ new Set(),
           frontmatter: astroData.frontmatter ?? {}
-        },
-        // Compat for `renderMarkdown` only. Do not use!
-        __renderMarkdownCompat: {
-          result
         }
       };
     }
   };
 }
-async function renderMarkdown(content, opts) {
-  const processor = await createMarkdownProcessor(opts);
-  const result = await processor.render(content, {
-    fileURL: opts.fileURL,
-    frontmatter: opts.frontmatter
-  });
-  return {
-    code: result.code,
-    metadata: {
-      headings: result.metadata.headings,
-      source: content,
-      html: result.code
-    },
-    vfile: result.__renderMarkdownCompat.result
-  };
-}
 function prefixError(err, prefix) {
   if (err?.message) {
     try {
@@ -147,11 +128,12 @@ ${err.message}`;
 export {
   InvalidAstroDataError2 as InvalidAstroDataError,
   createMarkdownProcessor,
+  createShikiHighlighter,
   markdownConfigDefaults,
   rehypeHeadingIds2 as rehypeHeadingIds,
   remarkCollectImages2 as remarkCollectImages,
   remarkPrism2 as remarkPrism,
   remarkShiki2 as remarkShiki,
-  renderMarkdown,
+  replaceCssVariables,
   setVfileFrontmatter2 as setVfileFrontmatter
 };

package/dist/internal.d.ts

@@ -1 +1 @@
-export { InvalidAstroDataError, safelyGetAstroData, toRemarkInitializeAstroData, } from './frontmatter-injection.js';
+export { InvalidAstroDataError, safelyGetAstroData } from './frontmatter-injection.js';

package/dist/internal.js

@@ -1,10 +1,5 @@
-import {
-  InvalidAstroDataError,
-  safelyGetAstroData,
-  toRemarkInitializeAstroData
-} from "./frontmatter-injection.js";
+import { InvalidAstroDataError, safelyGetAstroData } from "./frontmatter-injection.js";
 export {
   InvalidAstroDataError,
-  safelyGetAstroData,
-  toRemarkInitializeAstroData
+  safelyGetAstroData
 };

package/dist/remark-shiki.d.ts

@@ -1,2 +1,2 @@
 import type { RemarkPlugin, ShikiConfig } from './types.js';
-export declare function remarkShiki({ langs, theme, experimentalThemes, wrap, }?: ShikiConfig): ReturnType<RemarkPlugin>;
+export declare function remarkShiki(config?: ShikiConfig): ReturnType<RemarkPlugin>;

package/dist/remark-shiki.js

@@ -1,84 +1,19 @@
-import { bundledLanguages, getHighlighter } from "shikiji";
 import { visit } from "unist-util-visit";
-const ASTRO_COLOR_REPLACEMENTS = {
-  "#000001": "var(--astro-code-color-text)",
-  "#000002": "var(--astro-code-color-background)",
-  "#000004": "var(--astro-code-token-constant)",
-  "#000005": "var(--astro-code-token-string)",
-  "#000006": "var(--astro-code-token-comment)",
-  "#000007": "var(--astro-code-token-keyword)",
-  "#000008": "var(--astro-code-token-parameter)",
-  "#000009": "var(--astro-code-token-function)",
-  "#000010": "var(--astro-code-token-string-expression)",
-  "#000011": "var(--astro-code-token-punctuation)",
-  "#000012": "var(--astro-code-token-link)"
-};
-const COLOR_REPLACEMENT_REGEX = new RegExp(
-  `(${Object.keys(ASTRO_COLOR_REPLACEMENTS).join("|")})`,
-  "g"
-);
-const highlighterCacheAsync = /* @__PURE__ */ new Map();
-function remarkShiki({
-  langs = [],
-  theme = "github-dark",
-  experimentalThemes = {},
-  wrap = false
-} = {}) {
-  const themes = experimentalThemes;
-  const cacheId = Object.values(themes).map((t) => typeof t === "string" ? t : t.name ?? "").join(",") + (typeof theme === "string" ? theme : theme.name ?? "") + langs.map((l) => l.name ?? l.id).join(",");
-  let highlighterAsync = highlighterCacheAsync.get(cacheId);
-  if (!highlighterAsync) {
-    highlighterAsync = getHighlighter({
-      langs: langs.length ? langs : Object.keys(bundledLanguages),
-      themes: Object.values(themes).length ? Object.values(themes) : [theme]
-    });
-    highlighterCacheAsync.set(cacheId, highlighterAsync);
-  }
+import { createShikiHighlighter } from "./shiki.js";
+function remarkShiki(config) {
+  let highlighterAsync;
   return async (tree) => {
+    highlighterAsync ??= createShikiHighlighter(config);
     const highlighter = await highlighterAsync;
     visit(tree, "code", (node) => {
-      let lang;
-      if (typeof node.lang === "string") {
-        const langExists = highlighter.getLoadedLanguages().includes(node.lang);
-        if (langExists) {
-          lang = node.lang;
-        } else {
-          console.warn(`The language "${node.lang}" doesn't exist, falling back to plaintext.`);
-          lang = "plaintext";
-        }
-      } else {
-        lang = "plaintext";
-      }
-      let themeOptions = Object.values(themes).length ? { themes } : { theme };
-      let html = highlighter.codeToHtml(node.value, { ...themeOptions, lang });
-      html = html.replace(/<pre class="(.*?)shiki(.*?)"/, `<pre class="$1astro-code$2"`);
-      if (node.lang === "diff") {
-        html = html.replace(
-          /<span class="line"><span style="(.*?)">([\+|\-])/g,
-          '<span class="line"><span style="$1"><span style="user-select: none;">$2</span>'
-        );
-      }
-      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;"'
-        );
-      }
-      const themeName = typeof theme === "string" ? theme : theme.name;
-      if (themeName === "css-variables") {
-        html = html.replace(/style="(.*?)"/g, (m) => replaceCssVariables(m));
-      }
+      const lang = typeof node.lang === "string" ? node.lang : "plaintext";
+      const html = highlighter.highlight(node.value, lang);
       node.type = "html";
       node.value = html;
       node.children = [];
     });
   };
 }
-function replaceCssVariables(str) {
-  return str.replace(COLOR_REPLACEMENT_REGEX, (match) => ASTRO_COLOR_REPLACEMENTS[match] || match);
-}
 export {
   remarkShiki
 };

package/dist/shiki.d.ts

@@ -0,0 +1,7 @@
+import type { ShikiConfig } from './types.js';
+export interface ShikiHighlighter {
+    highlight(code: string, lang?: string, options?: {
+        inline?: boolean;
+    }): string;
+}
+export declare function createShikiHighlighter({ langs, theme, experimentalThemes, wrap, }?: ShikiConfig): Promise<ShikiHighlighter>;

package/dist/shiki.js

@@ -0,0 +1,104 @@
+import { bundledLanguages, getHighlighter } from "shikiji";
+import { visit } from "unist-util-visit";
+const ASTRO_COLOR_REPLACEMENTS = {
+  "#000001": "var(--astro-code-color-text)",
+  "#000002": "var(--astro-code-color-background)",
+  "#000004": "var(--astro-code-token-constant)",
+  "#000005": "var(--astro-code-token-string)",
+  "#000006": "var(--astro-code-token-comment)",
+  "#000007": "var(--astro-code-token-keyword)",
+  "#000008": "var(--astro-code-token-parameter)",
+  "#000009": "var(--astro-code-token-function)",
+  "#000010": "var(--astro-code-token-string-expression)",
+  "#000011": "var(--astro-code-token-punctuation)",
+  "#000012": "var(--astro-code-token-link)"
+};
+const COLOR_REPLACEMENT_REGEX = new RegExp(
+  `(${Object.keys(ASTRO_COLOR_REPLACEMENTS).join("|")})`,
+  "g"
+);
+async function createShikiHighlighter({
+  langs = [],
+  theme = "github-dark",
+  experimentalThemes = {},
+  wrap = false
+} = {}) {
+  const themes = experimentalThemes;
+  const highlighter = await getHighlighter({
+    langs: langs.length ? langs : Object.keys(bundledLanguages),
+    themes: Object.values(themes).length ? Object.values(themes) : [theme]
+  });
+  const loadedLanguages = highlighter.getLoadedLanguages();
+  return {
+    highlight(code, lang = "plaintext", options) {
+      if (lang !== "plaintext" && !loadedLanguages.includes(lang)) {
+        console.warn(`[Shiki] The language "${lang}" doesn't exist, falling back to "plaintext".`);
+        lang = "plaintext";
+      }
+      const themeOptions = Object.values(themes).length ? { themes } : { theme };
+      const inline = options?.inline ?? false;
+      return highlighter.codeToHtml(code, {
+        ...themeOptions,
+        lang,
+        transforms: {
+          pre(node) {
+            if (inline) {
+              node.tagName = "code";
+            }
+            const classValue = node.properties.class ?? "";
+            const styleValue = node.properties.style ?? "";
+            node.properties.class = classValue.replace(/shiki/g, "astro-code");
+            if (wrap === false) {
+              node.properties.style = styleValue + "; overflow-x: auto;";
+            } else if (wrap === true) {
+              node.properties.style = styleValue + "; overflow-x: auto; white-space: pre-wrap; word-wrap: break-word;";
+            }
+          },
+          line(node) {
+            if (lang === "diff") {
+              const innerSpanNode = node.children[0];
+              const innerSpanTextNode = innerSpanNode?.type === "element" && innerSpanNode.children?.[0];
+              if (innerSpanTextNode && innerSpanTextNode.type === "text") {
+                const start = innerSpanTextNode.value[0];
+                if (start === "+" || start === "-") {
+                  innerSpanTextNode.value = innerSpanTextNode.value.slice(1);
+                  innerSpanNode.children.unshift({
+                    type: "element",
+                    tagName: "span",
+                    properties: { style: "user-select: none;" },
+                    children: [{ type: "text", value: start }]
+                  });
+                }
+              }
+            }
+          },
+          code(node) {
+            if (inline) {
+              return node.children[0];
+            }
+          },
+          root(node) {
+            if (Object.values(experimentalThemes).length) {
+              return;
+            }
+            const themeName = typeof theme === "string" ? theme : theme.name;
+            if (themeName === "css-variables") {
+              visit(node, "element", (child) => {
+                if (child.properties?.style) {
+                  child.properties.style = replaceCssVariables(child.properties.style);
+                }
+              });
+            }
+          }
+        }
+      });
+    }
+  };
+}
+function replaceCssVariables(str) {
+  return str.replace(COLOR_REPLACEMENT_REGEX, (match) => ASTRO_COLOR_REPLACEMENTS[match] || match);
+}
+export {
+  createShikiHighlighter,
+  replaceCssVariables
+};

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 import type * as hast from 'hast';
 import type * as mdast from 'mdast';
-import type { one as Handler, all as Handlers, Options as RemarkRehypeOptions } from 'remark-rehype';
+import type { Options as RemarkRehypeOptions } from 'remark-rehype';
 import type { BuiltinTheme, LanguageRegistration, ThemeRegistration, ThemeRegistrationRaw } from 'shikiji';
 import type * as unified from 'unified';
 import type { VFile } from 'vfile';
@@ -12,10 +12,7 @@ export type RemarkPlugin<PluginParameters extends any[] = any[]> = unified.Plugi
 export type RemarkPlugins = (string | [string, any] | RemarkPlugin | [RemarkPlugin, any])[];
 export type RehypePlugin<PluginParameters extends any[] = any[]> = unified.Plugin<PluginParameters, hast.Root>;
 export type RehypePlugins = (string | [string, any] | RehypePlugin | [RehypePlugin, any])[];
-export type RemarkRehype = Omit<RemarkRehypeOptions, 'handlers' | 'unknownHandler'> & {
-    handlers?: typeof Handlers;
-    handler?: typeof Handler;
-};
+export type RemarkRehype = RemarkRehypeOptions;
 export interface ShikiConfig {
     langs?: LanguageRegistration[];
     theme?: BuiltinTheme | ThemeRegistration | ThemeRegistrationRaw;
@@ -23,7 +20,6 @@ export interface ShikiConfig {
     wrap?: boolean | null;
 }
 export interface AstroMarkdownOptions {
-    drafts?: boolean;
     syntaxHighlight?: 'shiki' | 'prism' | false;
     shikiConfig?: ShikiConfig;
     remarkPlugins?: RemarkPlugins;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/markdown-remark",
-  "version": "3.4.0",
+  "version": "4.0.0-beta.0",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -20,33 +20,33 @@
     "dist"
   ],
   "peerDependencies": {
-    "astro": "^3.0.0"
+    "astro": "^4.0.0-beta.0"
   },
   "dependencies": {
     "@astrojs/prism": "^3.0.0",
     "github-slugger": "^2.0.0",
-    "import-meta-resolve": "^3.0.0",
+    "import-meta-resolve": "^4.0.0",
     "mdast-util-definitions": "^6.0.0",
-    "rehype-raw": "^6.1.1",
-    "rehype-stringify": "^9.0.4",
-    "remark-gfm": "^3.0.1",
-    "remark-parse": "^10.0.2",
-    "remark-rehype": "^10.1.0",
+    "rehype-raw": "^7.0.0",
+    "rehype-stringify": "^10.0.0",
+    "remark-gfm": "^4.0.0",
+    "remark-parse": "^11.0.0",
+    "remark-rehype": "^11.0.0",
     "remark-smartypants": "^2.0.0",
-    "shikiji": "^0.6.8",
-    "unified": "^10.1.2",
-    "unist-util-visit": "^4.1.2",
-    "vfile": "^5.3.7"
+    "shikiji": "^0.6.13",
+    "unified": "^11.0.4",
+    "unist-util-visit": "^5.0.0",
+    "vfile": "^6.0.1"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.5",
-    "@types/estree": "^1.0.1",
-    "@types/hast": "^2.3.5",
-    "@types/mdast": "^3.0.12",
-    "@types/mocha": "^10.0.1",
-    "@types/unist": "^2.0.7",
+    "@types/chai": "^4.3.10",
+    "@types/estree": "^1.0.5",
+    "@types/hast": "^3.0.3",
+    "@types/mdast": "^4.0.3",
+    "@types/mocha": "^10.0.4",
+    "@types/unist": "^3.0.2",
     "chai": "^4.3.7",
-    "mdast-util-mdx-expression": "^1.3.2",
+    "mdast-util-mdx-expression": "^2.0.0",
     "mocha": "^10.2.0",
     "astro-scripts": "0.0.14"
   },