@d10f/asciidoc-astro-loader 0.0.15 → 0.1.0

package/README.md

@@ -27,7 +27,8 @@ Install the package from `npm`:
 And import the loader function inside your `content.config.ts` file to define a new collection:
 
 ```ts
-import { defineCollection, z } from "astro:content";
+import { defineCollection } from "astro:content";
+import { z } from 'astro/zod';
 import { asciidocLoader } from "asciidoc-astro-loader";
 
 const blog = defineCollection({
@@ -93,7 +94,7 @@ const blog = defineCollection({
 });
 ```
 
-### Shiki Trasnformers
+### Shiki Transformers
 
 One of the coolest features from Shiki are [transformers](https://shiki.style/guide/transformers). You can provide a list of the transformers that you want to use at the loader configuration:
 

package/dist/{chunk-5LUVP7HW.js → chunk-S7W7VGV4.js}

@@ -5,6 +5,8 @@ var AbstractEngine = class {
     this._extensions = _extensions;
     this.templateList = /* @__PURE__ */ new Map();
   }
+  _name;
+  _extensions;
   templateList;
   /**
    * Returns the given name to this template engine.

package/dist/{chunk-4JCAN3ZN.js → chunk-TCLZUBH3.js}

@@ -61,43 +61,57 @@ var transformAsciidocCallout = (options) => {
 };
 
 // src/lib/shiki/transformers/transformerPrompt.ts
-var transformerPrompt = (options) => {
+var DEFAULT_OPTS = {
+  breakOn: "\\",
+  cssClasses: "",
+  hideBreak: false,
+  prompt: "",
+  promptAttribute: "custom-prompt"
+};
+var transformerPrompt = (opts) => {
   return (node) => {
-    const language = node.getAttribute("language");
-    const customPrompt = node.getAttribute(
-      options?.promptAttribute ?? "custom-prompt"
+    const config = {
+      breakOn: opts?.breakOn ?? DEFAULT_OPTS.breakOn,
+      cssClasses: opts?.cssClasses ?? DEFAULT_OPTS.cssClasses,
+      hideBreak: opts?.hideBreak ?? DEFAULT_OPTS.hideBreak,
+      prompt: opts?.prompt ?? DEFAULT_OPTS.prompt
+    };
+    if (opts && opts.langs) {
+      const lang = node.getAttribute("language");
+      const langOpts = opts.langs[lang];
+      Object.assign(
+        config,
+        typeof langOpts === "object" ? langOpts : { prompt: langOpts }
+      );
+    }
+    const promptAttr = node.getAttribute(
+      opts?.promptAttribute ?? DEFAULT_OPTS.promptAttribute
     );
-    const promptToAdd = customPrompt ?? (options?.langs && options.langs[language]);
-    let cssClasses = typeof promptToAdd === "object" ? promptToAdd.cssClasses : options?.cssClasses;
-    const breakOn = typeof promptToAdd === "object" ? promptToAdd.breakOn ?? "\\" : "\\";
+    if (promptAttr) {
+      Object.assign(config, {
+        prompt: promptAttr
+      });
+    }
     const breakOnRe = new RegExp(
-      `\\s+${escapeRegexCharacters(breakOn)}\\s*$`
+      `\\s+${escapeRegexCharacters(config.breakOn)}\\s*$`
     );
-    const hideBreak = options?.langs && options.langs[language] && typeof options.langs[language] === "object" && options.langs[language].hideBreak;
-    if (customPrompt && options?.langs && typeof options.langs[language] === "object") {
-      cssClasses = options.langs[language].cssClasses;
-    }
     let skipNext = false;
+    let skipCurrent = false;
     return {
       enforce: "pre",
       line(hast) {
-        if (!promptToAdd) return;
-        const skipCurrent = skipNext;
+        if (!config.prompt || !config.prompt.trim()) return;
+        skipCurrent = skipNext;
         skipNext = false;
         const lastChild = hast.children.at(-1);
-        const lastToken = lastChild.children[0];
-        if (lastChild && lastToken) {
+        const lastToken = lastChild?.children[0];
+        if (lastToken) {
           skipNext = breakOnRe.test(lastToken.value);
-          lastToken.value = lastToken.value.replace(breakOnRe, "");
-          if (lastChild.children[0].value.match(breakOnRe)) {
-            skipNext = true;
-            if (hideBreak) {
-              lastChild.children[0].value = // @ts-expect-error property "children" does exist
-              lastChild.children[0].value.replace(
-                breakOnRe,
-                ""
-              );
-            }
+          if (skipNext && config.hideBreak) {
+            lastToken.value = lastToken.value.replace(
+              breakOnRe,
+              ""
+            );
           }
         }
         if (skipCurrent) return;
@@ -105,12 +119,12 @@ var transformerPrompt = (options) => {
           type: "element",
           tagName: "span",
           properties: {
-            class: cssClasses
+            class: config.cssClasses
           },
           children: [
             {
               type: "text",
-              value: typeof promptToAdd === "object" ? promptToAdd.prompt : promptToAdd
+              value: config.prompt
             }
           ]
         });

package/dist/{index-C1F2jTPD.d.cts → index-B1d5alka.d.cts}

@@ -7,110 +7,37 @@ type DocumentOptions = RequiredOptions['document'];
 type PreambleOptions = RequiredOptions['preamble'];
 declare const loaderOptionsSchema: z.ZodObject<{
     base: z.ZodString;
+    images: z.ZodOptional<z.ZodObject<{
+        imageDir: z.ZodOptional<z.ZodString>;
+        imageUrl: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
     document: z.ZodDefault<z.ZodObject<{
-        mode: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
-        template: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
+        mode: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
+        template: z.ZodPipe<z.ZodDefault<z.ZodString>, z.ZodTransform<string, string>>;
         recursive: z.ZodDefault<z.ZodBoolean>;
-    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-        mode: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
-        template: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
-        recursive: z.ZodDefault<z.ZodBoolean>;
-    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-        mode: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
-        template: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
-        recursive: z.ZodDefault<z.ZodBoolean>;
-    }, z.ZodTypeAny, "passthrough">>>;
-    syntaxHighlighting: z.ZodDefault<z.ZodEffects<z.ZodObject<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
+    }, z.core.$loose>>;
+    syntaxHighlighting: z.ZodDefault<z.ZodPipe<z.ZodObject<{
+        theme: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
             light: z.ZodString;
             dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
+        }, z.core.$catchall<z.ZodString>>]>, z.ZodTransform<{
             light: string;
             dark: string;
         } & {
             [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
-        defaultColor: z.ZodDefault<z.ZodString>;
-        cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
-        callouts: z.ZodOptional<z.ZodObject<{
-            cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
-            light: string;
-            dark: string;
-        } & {
-            [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
-        defaultColor: z.ZodDefault<z.ZodString>;
-        cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
-        callouts: z.ZodOptional<z.ZodObject<{
-            cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
+        }, string | {
+            [x: string]: string;
             light: string;
             dark: string;
-        } & {
-            [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
+        }>>>;
         defaultColor: z.ZodDefault<z.ZodString>;
         cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
+        mergeWhitespaces: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodLiteral<"never">]>>;
+        tabindex: z.ZodDefault<z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
         callouts: z.ZodOptional<z.ZodObject<{
             cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, z.ZodTypeAny, "passthrough">>, {
+        }, z.core.$strip>>;
+    }, z.core.$loose>, z.ZodTransform<{
         defaultColor: string;
         cssVariablePrefix: string;
         mergeWhitespaces: boolean | "never";
@@ -124,60 +51,14 @@ declare const loaderOptionsSchema: z.ZodObject<{
         } & {
             [other: string]: string;
         };
-    }, z.objectInputType<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
+    }, {
+        [x: string]: unknown;
+        theme: {
             light: string;
             dark: string;
         } & {
             [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
-        defaultColor: z.ZodDefault<z.ZodString>;
-        cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
-        callouts: z.ZodOptional<z.ZodObject<{
-            cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, z.ZodTypeAny, "passthrough">>>;
-    preamble: z.ZodDefault<z.ZodObject<{
-        tableOfContents: z.ZodDefault<z.ZodBoolean>;
-        maxLevel: z.ZodDefault<z.ZodNumber>;
-        position: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"before">, z.ZodLiteral<"after">]>>;
-    }, "strip", z.ZodTypeAny, {
-        tableOfContents: boolean;
-        maxLevel: number;
-        position: "before" | "after";
-    }, {
-        tableOfContents?: boolean | undefined;
-        maxLevel?: number | undefined;
-        position?: "before" | "after" | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    base: string;
-    document: {
-        mode: "safe" | "unsafe";
-        template: string;
-        recursive: boolean;
-    } & {
-        [k: string]: unknown;
-    };
-    syntaxHighlighting: {
+        };
         defaultColor: string;
         cssVariablePrefix: string;
         mergeWhitespaces: boolean | "never";
@@ -185,62 +66,13 @@ declare const loaderOptionsSchema: z.ZodObject<{
         callouts?: {
             cssClasses?: string | undefined;
         } | undefined;
-        themes: {
-            light: string;
-            dark: string;
-        } & {
-            [other: string]: string;
-        };
-    };
-    preamble: {
-        tableOfContents: boolean;
-        maxLevel: number;
-        position: "before" | "after";
-    };
-}, {
-    base: string;
-    document?: z.objectInputType<{
-        mode: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
-        template: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
-        recursive: z.ZodDefault<z.ZodBoolean>;
-    }, z.ZodTypeAny, "passthrough"> | undefined;
-    syntaxHighlighting?: z.objectInputType<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
-            light: string;
-            dark: string;
-        } & {
-            [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
-        defaultColor: z.ZodDefault<z.ZodString>;
-        cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
-        callouts: z.ZodOptional<z.ZodObject<{
-            cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, z.ZodTypeAny, "passthrough"> | undefined;
-    preamble?: {
-        tableOfContents?: boolean | undefined;
-        maxLevel?: number | undefined;
-        position?: "before" | "after" | undefined;
-    } | undefined;
-}>;
+    }>>>;
+    preamble: z.ZodDefault<z.ZodObject<{
+        tableOfContents: z.ZodDefault<z.ZodBoolean>;
+        maxLevel: z.ZodDefault<z.ZodNumber>;
+        position: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"before">, z.ZodLiteral<"after">]>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 
 declare abstract class AbstractEngine {
     private _name;
@@ -420,6 +252,30 @@ type AsciidocLoader = {
          */
         templateEngines: Array<AbstractEngine & AsciidocTemplate>;
     }>;
+    /**
+     * Options related to images and their location while parsing documents
+     */
+    images?: Partial<{
+        /**
+         * Path to the directory where images are stored. This is a global
+         * setting that applies to all documents that _do not_ already have
+         * an imagesdir attribute set.
+         *
+         * Make use of templates or converters for granuar control over this
+         * attribute on individua documents.
+         *
+         * @see https://docs.asciidoctor.org/pdf-converter/latest/image-paths-and-formats/#imagesdir
+         */
+        imagesDir?: string;
+        /**
+         * Path relative to the base URL of the site that will be used to
+         * resolve image src attributes. The base URL is configured via the
+         * Astro configuration file.
+         *
+         * @see https://docs.astro.build/en/reference/configuration-reference/#site
+         */
+        imageUrl?: string;
+    }>;
     /**
      * Options provided for the output of the preamble section, when
      * there is one present in the parsed document.
@@ -546,4 +402,4 @@ interface RawTemplate {
     renderString(content: string, options?: Record<string, unknown>): string;
 }
 
-export { type AsciidocLoader as A, type CustomConverterFactoryFn as C, type FilesystemTemplate as F, type NodeContext as N, type RawTemplate as R, type ShikiTransformerFactoryFn as S, type TemplateModule as T, type AsciidocTemplate as a, AbstractEngine as b, type ShikiTransformerFactory as c };
+export { AbstractEngine as A, type CustomConverterFactoryFn as C, type FilesystemTemplate as F, type NodeContext as N, type RawTemplate as R, type ShikiTransformerFactory as S, type TemplateModule as T, type AsciidocLoader as a, type AsciidocTemplate as b, type ShikiTransformerFactoryFn as c };