@astrojs/markdown-remark 6.1.0 → 6.2.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import type { AstroMarkdownOptions, MarkdownProcessor } from './types.js';
+import type { AstroMarkdownOptions, AstroMarkdownProcessorOptions, MarkdownProcessor } from './types.js';
 export { rehypeHeadingIds } from './rehype-collect-headings.js';
 export { remarkCollectImages } from './remark-collect-images.js';
 export { rehypePrism } from './rehype-prism.js';
@@ -10,4 +10,4 @@ export declare const markdownConfigDefaults: Required<AstroMarkdownOptions>;
 /**
  * Create a markdown preprocessor to render multiple markdown files
  */
-export declare function createMarkdownProcessor(opts?: AstroMarkdownOptions): Promise<MarkdownProcessor>;
+export declare function createMarkdownProcessor(opts?: AstroMarkdownProcessorOptions): Promise<MarkdownProcessor>;

package/dist/index.js

@@ -67,7 +67,7 @@ async function createMarkdownProcessor(opts) {
     parser.use(plugin, pluginOpts);
   }
   if (!isPerformanceBenchmark) {
-    parser.use(remarkCollectImages);
+    parser.use(remarkCollectImages, opts?.image);
   }
   parser.use(remarkRehype, {
     allowDangerousHtml: true,
@@ -84,7 +84,7 @@ async function createMarkdownProcessor(opts) {
   for (const [plugin, pluginOpts] of loadedRehypePlugins) {
     parser.use(plugin, pluginOpts);
   }
-  parser.use(rehypeImages());
+  parser.use(rehypeImages);
   if (!isPerformanceBenchmark) {
     parser.use(rehypeHeadingIds);
   }
@@ -109,7 +109,8 @@ async function createMarkdownProcessor(opts) {
         code: String(result.value),
         metadata: {
           headings: result.data.astro?.headings ?? [],
-          imagePaths: result.data.astro?.imagePaths ?? [],
+          localImagePaths: result.data.astro?.localImagePaths ?? [],
+          remoteImagePaths: result.data.astro?.remoteImagePaths ?? [],
           frontmatter: result.data.astro?.frontmatter ?? {}
         }
       };

package/dist/rehype-images.d.ts

@@ -1,2 +1,3 @@
+import type { Root } from 'hast';
 import type { VFile } from 'vfile';
-export declare function rehypeImages(): () => (tree: any, file: VFile) => void;
+export declare function rehypeImages(): (tree: Root, file: VFile) => void;

package/dist/rehype-images.js

@@ -1,22 +1,30 @@
 import { visit } from "unist-util-visit";
 function rehypeImages() {
-  return () => function(tree, file) {
+  return function(tree, file) {
+    if (!file.data.astro?.localImagePaths?.length && !file.data.astro?.remoteImagePaths?.length) {
+      return;
+    }
     const imageOccurrenceMap = /* @__PURE__ */ new Map();
-    visit(tree, (node) => {
-      if (node.type !== "element") return;
+    visit(tree, "element", (node) => {
       if (node.tagName !== "img") return;
-      if (node.properties?.src) {
-        node.properties.src = decodeURI(node.properties.src);
-        if (file.data.astro?.imagePaths?.includes(node.properties.src)) {
-          const { ...props } = node.properties;
-          const index = imageOccurrenceMap.get(node.properties.src) || 0;
-          imageOccurrenceMap.set(node.properties.src, index + 1);
-          node.properties["__ASTRO_IMAGE_"] = JSON.stringify({ ...props, index });
-          Object.keys(props).forEach((prop) => {
-            delete node.properties[prop];
-          });
-        }
+      if (typeof node.properties?.src !== "string") return;
+      const src = decodeURI(node.properties.src);
+      let newProperties;
+      if (file.data.astro?.localImagePaths?.includes(src)) {
+        newProperties = { ...node.properties, src };
+      } else if (file.data.astro?.remoteImagePaths?.includes(src)) {
+        newProperties = {
+          // By default, markdown images won't have width and height set. However, just in case another user plugin does set these, we should respect them.
+          inferSize: "width" in node.properties && "height" in node.properties ? void 0 : true,
+          ...node.properties,
+          src
+        };
+      } else {
+        return;
       }
+      const index = imageOccurrenceMap.get(node.properties.src) || 0;
+      imageOccurrenceMap.set(node.properties.src, index + 1);
+      node.properties = { __ASTRO_IMAGE_: JSON.stringify({ ...newProperties, index }) };
     });
   };
 }

package/dist/remark-collect-images.d.ts

@@ -1,2 +1,4 @@
+import type { Root } from 'mdast';
 import type { VFile } from 'vfile';
-export declare function remarkCollectImages(): (tree: any, vfile: VFile) => void;
+import type { AstroMarkdownProcessorOptions } from './types.js';
+export declare function remarkCollectImages(opts: AstroMarkdownProcessorOptions['image']): (tree: Root, vfile: VFile) => void;

package/dist/remark-collect-images.js

@@ -1,37 +1,38 @@
+import { isRemoteAllowed } from "@astrojs/internal-helpers/remote";
 import { definitions } from "mdast-util-definitions";
 import { visit } from "unist-util-visit";
-function remarkCollectImages() {
+function remarkCollectImages(opts) {
+  const domains = opts?.domains ?? [];
+  const remotePatterns = opts?.remotePatterns ?? [];
   return function(tree, vfile) {
     if (typeof vfile?.path !== "string") return;
     const definition = definitions(tree);
-    const imagePaths = /* @__PURE__ */ new Set();
-    visit(tree, ["image", "imageReference"], (node) => {
+    const localImagePaths = /* @__PURE__ */ new Set();
+    const remoteImagePaths = /* @__PURE__ */ new Set();
+    visit(tree, (node) => {
+      let url;
       if (node.type === "image") {
-        if (shouldOptimizeImage(node.url)) imagePaths.add(decodeURI(node.url));
-      }
-      if (node.type === "imageReference") {
+        url = decodeURI(node.url);
+      } else if (node.type === "imageReference") {
         const imageDefinition = definition(node.identifier);
         if (imageDefinition) {
-          if (shouldOptimizeImage(imageDefinition.url))
-            imagePaths.add(decodeURI(imageDefinition.url));
+          url = decodeURI(imageDefinition.url);
+        }
+      }
+      if (!url) return;
+      if (URL.canParse(url)) {
+        if (isRemoteAllowed(url, { domains, remotePatterns })) {
+          remoteImagePaths.add(url);
         }
+      } else if (!url.startsWith("/")) {
+        localImagePaths.add(url);
       }
     });
     vfile.data.astro ??= {};
-    vfile.data.astro.imagePaths = Array.from(imagePaths);
+    vfile.data.astro.localImagePaths = Array.from(localImagePaths);
+    vfile.data.astro.remoteImagePaths = Array.from(remoteImagePaths);
   };
 }
-function shouldOptimizeImage(src) {
-  return !isValidUrl(src) && !src.startsWith("/");
-}
-function isValidUrl(str) {
-  try {
-    new URL(str);
-    return true;
-  } catch {
-    return false;
-  }
-}
 export {
   remarkCollectImages
 };

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import type { RemotePattern } from '@astrojs/internal-helpers/remote';
 import type * as hast from 'hast';
 import type * as mdast from 'mdast';
 import type { Options as RemarkRehypeOptions } from 'remark-rehype';
@@ -9,7 +10,8 @@ declare module 'vfile' {
     interface DataMap {
         astro: {
             headings?: MarkdownHeading[];
-            imagePaths?: string[];
+            localImagePaths?: string[];
+            remoteImagePaths?: string[];
             frontmatter?: Record<string, any>;
         };
     }
@@ -22,6 +24,9 @@ export type RemarkRehype = RemarkRehypeOptions;
 export type ThemePresets = BuiltinTheme | 'css-variables';
 export interface ShikiConfig extends Pick<CreateShikiHighlighterOptions, 'langs' | 'theme' | 'themes' | 'langAlias'>, Pick<ShikiHighlighterHighlightOptions, 'defaultColor' | 'wrap' | 'transformers'> {
 }
+/**
+ * Configuration options that end up in the markdown section of AstroConfig
+ */
 export interface AstroMarkdownOptions {
     syntaxHighlight?: 'shiki' | 'prism' | false;
     shikiConfig?: ShikiConfig;
@@ -31,6 +36,15 @@ export interface AstroMarkdownOptions {
     gfm?: boolean;
     smartypants?: boolean;
 }
+/**
+ * Extra configuration options from other parts of AstroConfig that get injected into this plugin
+ */
+export interface AstroMarkdownProcessorOptions extends AstroMarkdownOptions {
+    image?: {
+        domains?: string[];
+        remotePatterns?: RemotePattern[];
+    };
+}
 export interface MarkdownProcessor {
     render: (content: string, opts?: MarkdownProcessorRenderOptions) => Promise<MarkdownProcessorRenderResult>;
 }
@@ -42,7 +56,8 @@ export interface MarkdownProcessorRenderResult {
     code: string;
     metadata: {
         headings: MarkdownHeading[];
-        imagePaths: string[];
+        localImagePaths: string[];
+        remoteImagePaths: string[];
         frontmatter: Record<string, any>;
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/markdown-remark",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -37,13 +37,14 @@
     "remark-parse": "^11.0.0",
     "remark-rehype": "^11.1.1",
     "remark-smartypants": "^3.0.2",
-    "shiki": "^1.29.1",
+    "shiki": "^1.29.2",
     "smol-toml": "^1.3.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/internal-helpers": "0.6.0",
     "@astrojs/prism": "3.2.0"
   },
   "devDependencies": {