pantsdown 2.2.4 → 2.2.5

package/README.md

@@ -105,32 +105,50 @@ import { Pantsdown, type PartialPantsdownConfig } from "pantsdown";
 // This is the default config object. If you provide
 // a config object, it will be deeply merged into this.
 const config: PartialPantsdownConfig = {
-  renderer: {
-    /**
-     * Prefix to be added to relative image sources.
-     * Must start and end with "/"
-     *
-     * @example
-     * relativeImageUrlPrefix: "/__localimage__/"
-     *
-     * ![image](./wallpants-512.png)
-     * relative src is updated and results in:
-     * <img src="/__localimage__/wallpants-512.png" />
-     *
-     * ![image](https://avatars.githubusercontent.com/wallpants)
-     * absolute src remains unchanged:
-     * <img src="https://avatars.githubusercontent.com/wallpants" />
-     */
-    relativeImageUrlPrefix: "",
-
-    /**
-     * Whether to render <details> html tags with attribute open=""
-     *
-     * @default
-     * false
-     */
-    detailsTagDefaultOpen: false,
-  },
+   renderer: {
+      /**
+       * Prefix to be added to relative image sources.
+       * Must start and end with "/"
+       *
+       * @example
+       * relativeImageUrlPrefix: "/__localimage__/nested/directory/"
+       *
+       * ![image](./wallpants-512.png)
+       * relative src is updated and results in:
+       * <img src="/__localimage__/nested/directory/wallpants-512.png" />
+       *
+       * ![image](https://avatars.githubusercontent.com/wallpants)
+       * absolute src remains unchanged:
+       * <img src="https://avatars.githubusercontent.com/wallpants" />
+       */
+      relativeImageUrlPrefix: string;
+
+      /**
+       * Prefix to be added to absolute image sources.
+       * Must start and end with "/"
+       * Falls back to `relativeImageUrlPrefix` if not provided
+       *
+       * @example
+       * absoluteImageUrlPrefix: "/__localimage__/"
+       *
+       * ![image](/wallpants-512.png)
+       * relative src is updated and results in:
+       * <img src="/__localimage__/wallpants-512.png" />
+       *
+       * ![image](https://avatars.githubusercontent.com/wallpants)
+       * external src remains unchanged:
+       * <img src="https://avatars.githubusercontent.com/wallpants" />
+       */
+      absoluteImageUrlPrefix?: string | undefined;
+
+      /**
+       * Whether to render <details> html tags with attribute `open=""`
+       *
+       * @default
+       * false
+       */
+      detailsTagDefaultOpen: boolean;
+   };
 };
 
 const pantsdown = new Pantsdown(config);

package/bun.lock

@@ -1403,6 +1403,8 @@
 
     "@typescript-eslint/typescript-estree/minimatch/brace-expansion": ["brace-expansion@5.0.6", "", { "dependencies": { "balanced-match": "^4.0.2" } }, "sha512-kLpxurY4Z4r9sgMsyG0Z9uzsBlgiU/EFKhj/h91/8yHu0edo7XuixOIH3VcJ8kkxs6/jPzoI6U9Vj3WqbMQ94g=="],
 
+    "bl/readable-stream/string_decoder": ["string_decoder@1.3.0", "", { "dependencies": { "safe-buffer": "~5.2.0" } }, "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA=="],
+
     "cli-highlight/yargs/cliui": ["cliui@7.0.4", "", { "dependencies": { "string-width": "^4.2.0", "strip-ansi": "^6.0.0", "wrap-ansi": "^7.0.0" } }, "sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ=="],
 
     "cli-highlight/yargs/yargs-parser": ["yargs-parser@20.2.9", "", {}, "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w=="],
@@ -1465,6 +1467,8 @@
 
     "@typescript-eslint/typescript-estree/minimatch/brace-expansion/balanced-match": ["balanced-match@4.0.4", "", {}, "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA=="],
 
+    "bl/readable-stream/string_decoder/safe-buffer": ["safe-buffer@5.2.1", "", {}, "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ=="],
+
     "commitizen/inquirer/figures/escape-string-regexp": ["escape-string-regexp@1.0.5", "", {}, "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg=="],
 
     "cz-conventional-changelog/chalk/ansi-styles/color-convert": ["color-convert@1.9.3", "", { "dependencies": { "color-name": "1.1.3" } }, "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg=="],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pantsdown",
-  "version": "2.2.4",
+  "version": "2.2.5",
   "description": "Markdown to 'GitHub HTML' parser",
   "license": "MIT",
   "author": "wallpants",

package/src/pantsdown.ts

@@ -7,6 +7,7 @@ import { type PantsdownConfig, type PartialPantsdownConfig } from "./types.ts";
 const defaultConfig: PantsdownConfig = {
    renderer: {
       relativeImageUrlPrefix: "",
+      absoluteImageUrlPrefix: undefined,
       detailsTagDefaultOpen: false,
    },
 };

package/src/renderer.ts

@@ -61,10 +61,7 @@ export class Renderer {
    }
 
    html(html: string, _block: boolean, sourceMap?: SourceMap): string {
-      let result = fixHtmlLocalImageHref(
-         html,
-         this.pantsdown.config.renderer.relativeImageUrlPrefix,
-      );
+      let result = fixHtmlLocalImageHref(html, this.pantsdown.config);
       result = addGithubImageStyles(result);
 
       const attrs: HTMLAttrs = [];
@@ -190,10 +187,7 @@ export class Renderer {
          return text;
       }
       const attrs: HTMLAttrs = [
-         [
-            "src",
-            fixLocalImageHref(cleanHref, this.pantsdown.config.renderer.relativeImageUrlPrefix),
-         ],
+         ["src", fixLocalImageHref(cleanHref, this.pantsdown.config)],
          ["alt", text],
       ];
       if (title) attrs.push(["title", title]);

package/src/types.ts

@@ -238,11 +238,11 @@ export type PantsdownConfig = {
        * Must start and end with "/"
        *
        * @example
-       * relativeImageUrlPrefix: "/__localimage__/"
+       * relativeImageUrlPrefix: "/__localimage__/nested/directory/"
        *
        * ![image](./wallpants-512.png)
        * relative src is updated and results in:
-       * <img src="/__localimage__/wallpants-512.png" />
+       * <img src="/__localimage__/nested/directory/wallpants-512.png" />
        *
        * ![image](https://avatars.githubusercontent.com/wallpants)
        * absolute src remains unchanged:
@@ -250,6 +250,24 @@ export type PantsdownConfig = {
        */
       relativeImageUrlPrefix: string;
 
+      /**
+       * Prefix to be added to absolute image sources.
+       * Must start and end with "/"
+       * Falls back to `relativeImageUrlPrefix` if not provided
+       *
+       * @example
+       * absoluteImageUrlPrefix: "/__localimage__/"
+       *
+       * ![image](./wallpants-512.png)
+       * relative src is updated and results in:
+       * <img src="/__localimage__/wallpants-512.png" />
+       *
+       * ![image](https://avatars.githubusercontent.com/wallpants)
+       * external src remains unchanged:
+       * <img src="https://avatars.githubusercontent.com/wallpants" />
+       */
+      absoluteImageUrlPrefix?: string | undefined;
+
       /**
        * Whether to render <details> html tags with attribute `open=""`
        *

package/src/utils.ts

@@ -1,5 +1,5 @@
 import { type Lexer } from "./lexer.ts";
-import { type HTMLAttrs, type SourceMap, type Tokens } from "./types.ts";
+import { PantsdownConfig, type HTMLAttrs, type SourceMap, type Tokens } from "./types.ts";
 
 /**
  * Helpers
@@ -67,15 +67,12 @@ export function injectHtmlAttributes(html: string, attrs: HTMLAttrs, sourceMap?:
    return html;
 }
 
-export function fixHtmlLocalImageHref(
-   html: string,
-   relativeImageUrlPrefix: string | undefined,
-): string {
-   return relativeImageUrlPrefix
+export function fixHtmlLocalImageHref(html: string, config: PantsdownConfig): string {
+   return config.renderer.relativeImageUrlPrefix
       ? html.replace(
            /<img\s+([^>]*?)src\s*=\s*(["'])([^>'"]+?)\2([^>]*)>/gm,
            (_m, g1, _g2, g3: string, g4) => {
-              const href = fixLocalImageHref(g3, relativeImageUrlPrefix);
+              const href = fixLocalImageHref(g3, config);
               return `<img ${g1}src="${href}"${g4}>`;
            },
         )
@@ -120,25 +117,27 @@ export function addGithubImageStyles(html: string): string {
    });
 }
 
-export function fixLocalImageHref(
-   href: string,
-   relativeImageUrlPrefix: string | undefined,
-): string {
-   if (!relativeImageUrlPrefix) return href;
+export function fixLocalImageHref(href: string, config: PantsdownConfig): string {
+   if (!config.renderer.relativeImageUrlPrefix) return href;
 
-   const reIsAbsolute = /^[\w+]+:\/\//;
+   // http://something
+   const refIsExternal = /^[\w+]+:\/\//;
    const dummyUrl = "http://__dummy__";
-   const dummyBaseUrl = new URL(relativeImageUrlPrefix, dummyUrl);
-   const dummyUrlLength = dummyUrl.length + (relativeImageUrlPrefix.startsWith("/") ? 0 : 1);
+   const dummyBaseUrl = new URL(config.renderer.relativeImageUrlPrefix, dummyUrl);
+   const dummyUrlLength =
+      dummyUrl.length + (config.renderer.relativeImageUrlPrefix.startsWith("/") ? 0 : 1);
 
-   if (reIsAbsolute.test(href)) {
-      // the URL is absolute, do not touch it
+   if (refIsExternal.test(href)) {
+      // the URL is external, do not touch it
       return href;
    }
 
    if (href.startsWith("/")) {
       // the URL is from root
-      return relativeImageUrlPrefix + href.slice(1);
+      return (
+         (config.renderer.absoluteImageUrlPrefix ?? config.renderer.relativeImageUrlPrefix) +
+         href.slice(1)
+      );
    }
 
    try {