pantsdown 1.4.0 → 1.4.1

package/README.md

@@ -70,6 +70,38 @@ function App() {
 export default App;
 ```
 
+## Configuration
+
+The Pantsdown constructor accepts an optional configuration object:
+
+```typescript
+import { PantsdownConfig } from "pantsdown";
+
+const config: PantsdownConfig = {
+    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 result in:
+         * <img src="/__localimage__/wallpants-512.png" />
+         *
+         * ![image](https://avatars.githubusercontent.com/wallpants)
+         * absolute path remains unchanged:
+         * <img src="https://avatars.githubusercontent.com/wallpants" />
+         */
+        relativeImageUrlPrefix: "/__localimage__/",
+    },
+};
+
+const pantsdown = new Pantsdown(config);
+pantsdown.parse(markdown);
+```
+
 ## Roadmap
 
 -   [x] Add id & anchors to headings

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pantsdown",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "author": "wallpants",
   "description": "The markdown parser",
   "license": "MIT",

package/src/renderer.ts

@@ -13,7 +13,7 @@ import {
 } from "./utils.ts";
 
 const defaultConfig: NonNullable<PantsdownConfig["renderer"]> = {
-    localImageUrlPrefix: "",
+    relativeImageUrlPrefix: "",
 };
 
 /**
@@ -50,7 +50,7 @@ export class Renderer {
     }
 
     html(html: string, _block: boolean, sourceMap?: SourceMap | undefined): string {
-        let result = fixHtmlLocalImageHref(html, this.rendererConfig.localImageUrlPrefix);
+        let result = fixHtmlLocalImageHref(html, this.rendererConfig.relativeImageUrlPrefix);
         if (sourceMap) {
             result = injectHtmlAttributes(result, [
                 ["line-start", sourceMap[0]],
@@ -179,7 +179,7 @@ export class Renderer {
         if (cleanHref === null) {
             return text;
         }
-        href = fixLocalImageHref(cleanHref, this.rendererConfig.localImageUrlPrefix);
+        href = fixLocalImageHref(cleanHref, this.rendererConfig.relativeImageUrlPrefix);
 
         let out = `<img src="${href}" alt="${text}"`;
 

package/src/types.ts

@@ -190,9 +190,20 @@ export type Links = Record<string, { href: string; title: string }>;
 export type PantsdownConfig = {
     renderer?: {
         /**
-         * url prefix. Must start and end with "/"
-         * example: "/__localimage__/"
+         * 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 result in:
+         * <img src="/__localimage__/wallpants-512.png" />
+         *
+         * ![image](https://avatars.githubusercontent.com/wallpants)
+         * absolute path remains unchanged:
+         * <img src="https://avatars.githubusercontent.com/wallpants" />
          */
-        localImageUrlPrefix: string;
+        relativeImageUrlPrefix: string;
     };
 };

package/src/utils.ts

@@ -76,21 +76,21 @@ export function injectHtmlAttributes(
     }
 }
 
-export function fixHtmlLocalImageHref(html: string, localImageUrlPrefix: string): string {
+export function fixHtmlLocalImageHref(html: string, relativeImageUrlPrefix: string): string {
     return html.replace(
         /<img\s+([^>]*?)src\s*=\s*(["'])([^\2>]+?)\2([^>]*)>/gm,
         (_m, g1, _g2, g3: string, g4) => {
-            const href = fixLocalImageHref(g3, localImageUrlPrefix);
+            const href = fixLocalImageHref(g3, relativeImageUrlPrefix);
             return `<img ${g1}src="${href}"${g4}>`;
         },
     );
 }
 
-export function fixLocalImageHref(href: string, localImageUrlPrefix: string): string {
+export function fixLocalImageHref(href: string, relativeImageUrlPrefix: string): string {
     const reIsAbsolute = /^[\w+]+:\/\//;
     const dummyUrl = "http://__dummy__";
-    const dummyBaseUrl = new URL(localImageUrlPrefix, dummyUrl);
-    const dummyUrlLength = dummyUrl.length + (localImageUrlPrefix.startsWith("/") ? 0 : 1);
+    const dummyBaseUrl = new URL(relativeImageUrlPrefix, dummyUrl);
+    const dummyUrlLength = dummyUrl.length + (relativeImageUrlPrefix.startsWith("/") ? 0 : 1);
 
     if (reIsAbsolute.test(href)) {
         // the URL is absolute, do not touch it