@astrojs/markdown-remark 6.0.0-beta.1 → 6.0.0-beta.3

package/dist/frontmatter.d.ts

@@ -1 +1,20 @@
 export declare function isFrontmatterValid(frontmatter: Record<string, any>): boolean;
+export declare function extractFrontmatter(code: string): string | undefined;
+export interface ParseFrontmatterOptions {
+    /**
+     * How the frontmatter should be handled in the returned `content` string.
+     * - `preserve`: Keep the frontmatter.
+     * - `remove`: Remove the frontmatter.
+     * - `empty-with-spaces`: Replace the frontmatter with empty spaces. (preserves sourcemap line/col/offset)
+     * - `empty-with-lines`: Replace the frontmatter with empty line breaks. (preserves sourcemap line/col)
+     *
+     * @default 'remove'
+     */
+    frontmatter: 'preserve' | 'remove' | 'empty-with-spaces' | 'empty-with-lines';
+}
+export interface ParseFrontmatterResult {
+    frontmatter: Record<string, any>;
+    rawFrontmatter: string;
+    content: string;
+}
+export declare function parseFrontmatter(code: string, options?: ParseFrontmatterOptions): ParseFrontmatterResult;

package/dist/frontmatter.js

@@ -1,3 +1,4 @@
+import yaml from "js-yaml";
 function isFrontmatterValid(frontmatter) {
   try {
     JSON.stringify(frontmatter);
@@ -6,6 +7,43 @@ function isFrontmatterValid(frontmatter) {
   }
   return typeof frontmatter === "object" && frontmatter !== null;
 }
+const frontmatterRE = /^---(.*?)^---/ms;
+function extractFrontmatter(code) {
+  return frontmatterRE.exec(code)?.[1];
+}
+function parseFrontmatter(code, options) {
+  const rawFrontmatter = extractFrontmatter(code);
+  if (rawFrontmatter == null) {
+    return { frontmatter: {}, rawFrontmatter: "", content: code };
+  }
+  const parsed = yaml.load(rawFrontmatter);
+  const frontmatter = parsed && typeof parsed === "object" ? parsed : {};
+  let content;
+  switch (options?.frontmatter ?? "remove") {
+    case "preserve":
+      content = code;
+      break;
+    case "remove":
+      content = code.replace(`---${rawFrontmatter}---`, "");
+      break;
+    case "empty-with-spaces":
+      content = code.replace(
+        `---${rawFrontmatter}---`,
+        `   ${rawFrontmatter.replace(/[^\r\n]/g, " ")}   `
+      );
+      break;
+    case "empty-with-lines":
+      content = code.replace(`---${rawFrontmatter}---`, rawFrontmatter.replace(/[^\r\n]/g, ""));
+      break;
+  }
+  return {
+    frontmatter,
+    rawFrontmatter,
+    content
+  };
+}
 export {
-  isFrontmatterValid
+  extractFrontmatter,
+  isFrontmatterValid,
+  parseFrontmatter
 };

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export { rehypeHeadingIds } from './rehype-collect-headings.js';
 export { remarkCollectImages } from './remark-collect-images.js';
 export { rehypePrism } from './rehype-prism.js';
 export { rehypeShiki } from './rehype-shiki.js';
-export { isFrontmatterValid } from './frontmatter.js';
+export { isFrontmatterValid, extractFrontmatter, parseFrontmatter, type ParseFrontmatterOptions, type ParseFrontmatterResult, } from './frontmatter.js';
 export { createShikiHighlighter, type ShikiHighlighter, type CreateShikiHighlighterOptions, type ShikiHighlighterHighlightOptions, } from './shiki.js';
 export * from './types.js';
 export declare const markdownConfigDefaults: Required<AstroMarkdownOptions>;

package/dist/index.js

@@ -16,7 +16,11 @@ import { rehypeHeadingIds as rehypeHeadingIds2 } from "./rehype-collect-headings
 import { remarkCollectImages as remarkCollectImages2 } from "./remark-collect-images.js";
 import { rehypePrism as rehypePrism2 } from "./rehype-prism.js";
 import { rehypeShiki as rehypeShiki2 } from "./rehype-shiki.js";
-import { isFrontmatterValid } from "./frontmatter.js";
+import {
+  isFrontmatterValid,
+  extractFrontmatter,
+  parseFrontmatter
+} from "./frontmatter.js";
 import {
   createShikiHighlighter
 } from "./shiki.js";
@@ -28,7 +32,8 @@ const markdownConfigDefaults = {
     theme: "github-dark",
     themes: {},
     wrap: false,
-    transformers: []
+    transformers: [],
+    langAlias: {}
   },
   remarkPlugins: [],
   rehypePlugins: [],
@@ -131,8 +136,10 @@ ${err.message}`;
 export {
   createMarkdownProcessor,
   createShikiHighlighter,
+  extractFrontmatter,
   isFrontmatterValid,
   markdownConfigDefaults,
+  parseFrontmatter,
   rehypeHeadingIds2 as rehypeHeadingIds,
   rehypePrism2 as rehypePrism,
   rehypeShiki2 as rehypeShiki,

package/dist/rehype-shiki.js

@@ -6,7 +6,8 @@ const rehypeShiki = (config) => {
     highlighterAsync ??= createShikiHighlighter({
       langs: config?.langs,
       theme: config?.theme,
-      themes: config?.themes
+      themes: config?.themes,
+      langAlias: config?.langAlias
     });
     const highlighter = await highlighterAsync;
     await highlightCodeBlocks(tree, (code, language, options) => {

package/dist/shiki.d.ts

@@ -1,5 +1,5 @@
 import type { Root } from 'hast';
-import { type LanguageRegistration, type ShikiTransformer, type ThemeRegistration, type ThemeRegistrationRaw } from 'shiki';
+import { type HighlighterCoreOptions, type LanguageRegistration, type ShikiTransformer, type ThemeRegistration, type ThemeRegistrationRaw } from 'shiki';
 import type { ThemePresets } from './types.js';
 export interface ShikiHighlighter {
     codeToHast(code: string, lang?: string, options?: ShikiHighlighterHighlightOptions): Promise<Root>;
@@ -9,6 +9,7 @@ export interface CreateShikiHighlighterOptions {
     langs?: LanguageRegistration[];
     theme?: ThemePresets | ThemeRegistration | ThemeRegistrationRaw;
     themes?: Record<string, ThemePresets | ThemeRegistration | ThemeRegistrationRaw>;
+    langAlias?: HighlighterCoreOptions['langAlias'];
 }
 export interface ShikiHighlighterHighlightOptions {
     /**
@@ -39,4 +40,4 @@ export interface ShikiHighlighterHighlightOptions {
      */
     meta?: string;
 }
-export declare function createShikiHighlighter({ langs, theme, themes, }?: CreateShikiHighlighterOptions): Promise<ShikiHighlighter>;
+export declare function createShikiHighlighter({ langs, theme, themes, langAlias, }?: CreateShikiHighlighterOptions): Promise<ShikiHighlighter>;

package/dist/shiki.js

@@ -4,24 +4,30 @@ import {
   isSpecialLang
 } from "shiki";
 let _cssVariablesTheme;
-const cssVariablesTheme = () => _cssVariablesTheme ?? (_cssVariablesTheme = createCssVariablesTheme({ variablePrefix: "--astro-code-" }));
+const cssVariablesTheme = () => _cssVariablesTheme ?? (_cssVariablesTheme = createCssVariablesTheme({
+  variablePrefix: "--astro-code-"
+}));
 async function createShikiHighlighter({
   langs = [],
   theme = "github-dark",
-  themes = {}
+  themes = {},
+  langAlias = {}
 } = {}) {
   theme = theme === "css-variables" ? cssVariablesTheme() : theme;
   const highlighter = await createHighlighter({
     langs: ["plaintext", ...langs],
+    langAlias,
     themes: Object.values(themes).length ? Object.values(themes) : [theme]
   });
   async function highlight(code, lang = "plaintext", options, to) {
+    const resolvedLang = langAlias[lang] ?? lang;
     const loadedLanguages = highlighter.getLoadedLanguages();
-    if (!isSpecialLang(lang) && !loadedLanguages.includes(lang)) {
+    if (!isSpecialLang(lang) && !loadedLanguages.includes(resolvedLang)) {
       try {
-        await highlighter.loadLanguage(lang);
+        await highlighter.loadLanguage(resolvedLang);
       } catch (_err) {
-        console.warn(`[Shiki] The language "${lang}" doesn't exist, falling back to "plaintext".`);
+        const langStr = lang === resolvedLang ? `"${lang}"` : `"${lang}" (aliased to "${resolvedLang}")`;
+        console.warn(`[Shiki] The language ${langStr} doesn't exist, falling back to "plaintext".`);
         lang = "plaintext";
       }
     }
@@ -58,7 +64,7 @@ async function createShikiHighlighter({
             }
           },
           line(node) {
-            if (lang === "diff") {
+            if (resolvedLang === "diff") {
               const innerSpanNode = node.children[0];
               const innerSpanTextNode = innerSpanNode?.type === "element" && innerSpanNode.children?.[0];
               if (innerSpanTextNode && innerSpanTextNode.type === "text") {

package/dist/types.d.ts

@@ -20,7 +20,7 @@ export type RehypePlugin<PluginParameters extends any[] = any[]> = unified.Plugi
 export type RehypePlugins = (string | [string, any] | RehypePlugin | [RehypePlugin, any])[];
 export type RemarkRehype = RemarkRehypeOptions;
 export type ThemePresets = BuiltinTheme | 'css-variables';
-export interface ShikiConfig extends Pick<CreateShikiHighlighterOptions, 'langs' | 'theme' | 'themes'>, Pick<ShikiHighlighterHighlightOptions, 'defaultColor' | 'wrap' | 'transformers'> {
+export interface ShikiConfig extends Pick<CreateShikiHighlighterOptions, 'langs' | 'theme' | 'themes' | 'langAlias'>, Pick<ShikiHighlighterHighlightOptions, 'defaultColor' | 'wrap' | 'transformers'> {
 }
 export interface AstroMarkdownOptions {
     syntaxHighlight?: 'shiki' | 'prism' | false;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@astrojs/markdown-remark",
-  "version": "6.0.0-beta.1",
+  "version": "6.0.0-beta.3",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/withastro/astro.git",
+    "url": "git+https://github.com/withastro/astro.git",
     "directory": "packages/markdown/remark"
   },
   "bugs": "https://github.com/withastro/astro/issues",
@@ -26,31 +26,33 @@
   ],
   "dependencies": {
     "github-slugger": "^2.0.0",
-    "hast-util-from-html": "^2.0.2",
+    "hast-util-from-html": "^2.0.3",
     "hast-util-to-text": "^4.0.2",
     "import-meta-resolve": "^4.1.0",
+    "js-yaml": "^4.1.0",
     "mdast-util-definitions": "^6.0.0",
     "rehype-raw": "^7.0.0",
-    "rehype-stringify": "^10.0.0",
+    "rehype-stringify": "^10.0.1",
     "remark-gfm": "^4.0.0",
     "remark-parse": "^11.0.0",
-    "remark-rehype": "^11.1.0",
+    "remark-rehype": "^11.1.1",
     "remark-smartypants": "^3.0.2",
-    "shiki": "^1.16.2",
+    "shiki": "^1.23.1",
     "unified": "^11.0.5",
     "unist-util-remove-position": "^5.0.0",
     "unist-util-visit": "^5.0.0",
     "unist-util-visit-parents": "^6.0.1",
     "vfile": "^6.0.3",
-    "@astrojs/prism": "3.1.0"
+    "@astrojs/prism": "3.2.0-beta.0"
   },
   "devDependencies": {
-    "@types/estree": "^1.0.5",
+    "@types/estree": "^1.0.6",
     "@types/hast": "^3.0.4",
+    "@types/js-yaml": "^4.0.9",
     "@types/mdast": "^4.0.4",
     "@types/unist": "^3.0.3",
     "esbuild": "^0.21.5",
-    "mdast-util-mdx-expression": "^2.0.0",
+    "mdast-util-mdx-expression": "^2.0.1",
     "astro-scripts": "0.0.14"
   },
   "publishConfig": {