@d10f/asciidoc-astro-loader 0.0.2 → 0.0.3

package/dist/index.js

@@ -1,10 +1,13 @@
 import {
   sourceCodeConverter
-} from "./chunk-BRMWIQA2.js";
+} from "./chunk-KZRXEKZK.js";
+import {
+  transformAsciidocCallout
+} from "./chunk-5P6LDJGO.js";
 import {
   slugify,
   splitFilenameComponents
-} from "./chunk-DDIUST2Z.js";
+} from "./chunk-2UGTFP4R.js";
 import {
   HandlebarsEngine,
   NunjucksEngine
@@ -279,13 +282,18 @@ var shikiOptionsSchema = z2.object({
   cssVariablePrefix: z2.string().default("--shiki-"),
   mergeWhitespaces: z2.union([z2.boolean(), z2.literal("never")]).default(true),
   tabindex: z2.union([z2.number(), z2.string(), z2.literal(false)]).default(false),
-  transformers: z2.array(
-    z2.object({
-      name: z2.string(),
-      enforce: z2.union([z2.literal("pre"), z2.literal("post")])
-    })
-  ).optional()
-}).transform(({ theme, ...rest }) => ({
+  // transformers: z
+  // 	.array(
+  // 		z.object({
+  // 			name: z.string(),
+  // 			enforce: z.union([z.literal('pre'), z.literal('post')]),
+  // 		}),
+  // 	)
+  // 	.optional(),
+  callouts: z2.object({
+    cssClasses: z2.string().optional()
+  }).optional()
+}).passthrough().transform(({ theme, ...rest }) => ({
   themes: theme,
   ...rest
 })).default({
@@ -297,7 +305,8 @@ var shikiOptionsSchema = z2.object({
     light: "catppuccin-latte",
     dark: "catppuccin-macchiato"
   },
-  transformers: void 0
+  // transformers: undefined,
+  callouts: void 0
 });
 function transformThemeProp(value) {
   return typeof value === "string" ? { light: value, dark: value } : value;
@@ -342,13 +351,13 @@ async function createHighlighter(documents, themes) {
 }
 
 // src/loader.ts
-function asciidocLoader(options) {
-  const parsedOpts = loaderOptionsSchema.parse(options);
-  if (parsedOpts.document.converters === void 0) {
-    parsedOpts.document.converters = [];
+function asciidocLoader(_options) {
+  const options = loaderOptionsSchema.parse(_options);
+  if (options.document.converters === void 0) {
+    options.document.converters = [];
   }
-  if (parsedOpts.document.templateEngines === void 0) {
-    parsedOpts.document.templateEngines = [
+  if (options.document.templateEngines === void 0) {
+    options.document.templateEngines = [
       new HandlebarsEngine(),
       new NunjucksEngine()
     ];
@@ -360,18 +369,18 @@ function asciidocLoader(options) {
     async load(loaderContext) {
       const { config, logger, watcher } = loaderContext;
       const root = config.root.pathname;
-      const base = parsedOpts.base.startsWith(".") ? realpathSync(options.base) : root + options.base;
+      const base = options.base.startsWith(".") ? realpathSync(options.base) : root + options.base;
       const docs = readdirSync2(base, "utf8").filter((file) => file.match(/(?:\.a(?:scii)?doc)$/)).map((filename) => new AsciidocDocument(`${base}/${filename}`));
       if (docs.length === 0) {
         logger.warn("No documents found for this collection.");
         return;
       }
-      if (parsedOpts.document.template) {
+      if (options.document.template) {
         templateEngine = new TemplateEngineRegistry(
-          parsedOpts.document.templateEngines,
+          options.document.templateEngines,
           {
-            rootDir: parsedOpts.document.template,
-            recursive: parsedOpts.document.recursive
+            rootDir: options.document.template,
+            recursive: options.document.recursive
           }
         );
         await templateEngine.loadEngines();
@@ -379,11 +388,11 @@ function asciidocLoader(options) {
       if (!highlighter) {
         highlighter = await createHighlighter(
           docs,
-          parsedOpts.syntaxHighlighting.themes
+          options.syntaxHighlighting.themes
         );
       }
-      const converters = parsedOpts.document.converters.map(
-        (converter) => converter(parsedOpts, highlighter)
+      const converters = options.document.converters.map(
+        (converter) => converter(options, highlighter)
       );
       const hasSourceCodeConverter = converters.find(
         (converter) => converter.nodeContext === "listing" && converter?.nodeStyle === "source"
@@ -391,18 +400,18 @@ function asciidocLoader(options) {
       if (!hasSourceCodeConverter) {
         converters.push(
           sourceCodeConverter({
-            transformers: parsedOpts.syntaxHighlighting.transformers
-          })(parsedOpts, highlighter)
+            transformers: [
+              ...options.syntaxHighlighting.transformers ?? [],
+              transformAsciidocCallout(
+                options.syntaxHighlighting.callouts
+              )
+            ]
+          })(options, highlighter)
         );
       }
       await Promise.all(
         docs.map(
-          (doc) => syncDocument(
-            doc,
-            converters,
-            templateEngine,
-            loaderContext
-          )
+          (doc) => setDocument(doc, converters, templateEngine, loaderContext)
         )
       );
       if (watcher) {
@@ -415,11 +424,10 @@ function asciidocLoader(options) {
         const watchedFileRegExp = new RegExp(
           `^${base}.*.(a(?:scii)?doc)$`
         );
-        console.log(this.name);
         watcher.on("change", async (changedPath) => {
           if (changedPath.match(watchedFileRegExp)) {
             const newDoc = new AsciidocDocument(changedPath);
-            await syncDocument(
+            await setDocument(
               newDoc,
               converters,
               templateEngine,
@@ -427,15 +435,17 @@ function asciidocLoader(options) {
             );
           }
         });
-        process.on("SIGINT", handle2);
-        process.on("SIGTERM", handle2);
+        if (highlighter) {
+          process.on("SIGINT", handle2);
+          process.on("SIGTERM", handle2);
+        }
       } else {
         nextTick(highlighter.dispose);
       }
     }
   };
 }
-async function syncDocument(doc, converters, templateEngine, { parseData, store }) {
+async function setDocument(doc, converters, templateEngine, { parseData, store }) {
   const data = await parseData({
     id: doc.slug,
     data: {

package/dist/lib/asciidoc/converters/index.cjs

@@ -28,10 +28,6 @@ module.exports = __toCommonJS(converters_exports);
 var import_node_path = require("path");
 
 // src/lib/utils.ts
-function escapeRegexCharacters(str) {
-  const re = /[-\\^$*+?.()|\[\]{}]/g;
-  return str.replace(re, "\\$&");
-}
 function splitFilenameComponents(filename) {
   const match = filename.match(/^(?<path>.*\/)*(?<name>[^\.]+)\.(?<ext>.*)$/);
   return {
@@ -41,96 +37,6 @@ function splitFilenameComponents(filename) {
   };
 }
 
-// src/lib/shiki/transformers/transformAsciidocCallout.ts
-function transformAsciidocCallout({
-  node,
-  cssClasses = "pointer-events-none select-none ml-2"
-}) {
-  const lineComments = ["//", "#", ";;"];
-  const customLineComment = node.getAttribute("line-comment");
-  if (customLineComment) {
-    lineComments.push(escapeRegexCharacters(customLineComment));
-  }
-  const calloutReList = [
-    // Handles C-style and similar comments like Perl, Python...
-    new RegExp(`(?:${lineComments.join("|")})((?:\\s+<(\\d+)>)+)`),
-    // Handles XML comments
-    new RegExp(/((?:\s*<!--(\d+)-->)+)/)
-  ];
-  const linesWithCallout = {};
-  return {
-    preprocess(code) {
-      return code.split("\n").map((line, idx) => {
-        for (const re of calloutReList) {
-          const match = line.match(re);
-          if (!match) continue;
-          const callouts = match[0].trim().replaceAll(/(?:<!--|-->|[<>])/g, "").split(" ");
-          linesWithCallout[idx + 1] = callouts;
-          return line.replace(re, "");
-        }
-        return line;
-      }).join("\n");
-    },
-    line(hast, line) {
-      const callouts = linesWithCallout[line];
-      if (!callouts) return;
-      callouts.forEach((calloutId) => {
-        hast.properties[`data-callout-${calloutId}`] = "";
-        hast.children.push({
-          type: "element",
-          tagName: "i",
-          properties: {
-            class: `conum ${cssClasses}`,
-            "data-value": calloutId
-          },
-          children: [
-            {
-              type: "element",
-              tagName: "b",
-              properties: {},
-              children: [
-                {
-                  type: "text",
-                  value: calloutId
-                }
-              ]
-            }
-          ]
-        });
-      });
-    }
-  };
-}
-
-// src/lib/shiki/transformers/transformConsoleCodeBlock.ts
-function transformConsoleCodeBlock(options = {
-  cssClasses: "pointer-events-none select-none mr-2 opacity-50"
-}) {
-  const unselectablePrompt = `<span $1 class="${options.cssClasses}">$</span>`;
-  const linePrefix = '<span class="line[^>]+?>';
-  const splitPrompt = new RegExp(
-    `(?<=${linePrefix})(?:<span (style="[^"]*?")>\\s*?\\$\\s+?([^<]))`
-  );
-  const trimWhitespace = new RegExp(
-    `(?<=${linePrefix})(?:<span (style="[^"]*?")>\\s*?\\$\\s*?<\\/span>(?:<span>\\s+<\\/span>)?)`
-  );
-  const trimWhitespaceAhead = new RegExp(
-    `(?<=${linePrefix}<span [^>]+?>\\$<\\/span>)(<span style="[^"]+?">)\\s+?`
-  );
-  return {
-    postprocess: (html, { lang }) => {
-      if (lang === "console") {
-        return html.split("\n").map((line) => {
-          return line.replace(
-            splitPrompt,
-            unselectablePrompt + "<span $1>$2"
-          ).replace(trimWhitespace, unselectablePrompt).replace(trimWhitespaceAhead, "$1");
-        }).join("\n");
-      }
-    }
-  };
-}
-
 // src/lib/asciidoc/converters/sourceCodeConverter.ts
 var sourceCodeConverter = ({ transformers, template }) => {
   return (options, highlighter) => {
@@ -143,11 +49,9 @@ var sourceCodeConverter = ({ transformers, template }) => {
         const output = highlighter.codeToHtml(input, {
           ...options.syntaxHighlighting,
           lang,
-          transformers: [
-            ...transformers ?? [],
-            transformAsciidocCallout({ node }),
-            transformConsoleCodeBlock()
-          ]
+          transformers: (transformers ?? []).map((transformer) => {
+            return typeof transformer === "function" ? transformer(node) : transformer;
+          })
         });
         if (templateEngine && template) {
           const { extension } = splitFilenameComponents(template);

package/dist/lib/asciidoc/converters/index.d.cts

@@ -1,10 +1,10 @@
 import { ShikiTransformer } from 'shiki';
-import { C as CustomConverterFactoryFn } from '../../../index-BNxO58s3.cjs';
+import { C as CustomConverterFactoryFn, S as ShikiTransformerFactoryFn } from '../../../index-sFlXF8Qm.cjs';
 import 'asciidoctor';
 import 'astro/zod';
 
 type CodeBlockConverterOptions = {
-    transformers: ShikiTransformer[];
+    transformers: Array<ShikiTransformer | ShikiTransformerFactoryFn>;
     template: string;
 };
 declare const sourceCodeConverter: CustomConverterFactoryFn<Partial<CodeBlockConverterOptions>>;

package/dist/lib/asciidoc/converters/index.d.ts

@@ -1,10 +1,10 @@
 import { ShikiTransformer } from 'shiki';
-import { C as CustomConverterFactoryFn } from '../../../index-BNxO58s3.js';
+import { C as CustomConverterFactoryFn, S as ShikiTransformerFactoryFn } from '../../../index-sFlXF8Qm.js';
 import 'asciidoctor';
 import 'astro/zod';
 
 type CodeBlockConverterOptions = {
-    transformers: ShikiTransformer[];
+    transformers: Array<ShikiTransformer | ShikiTransformerFactoryFn>;
     template: string;
 };
 declare const sourceCodeConverter: CustomConverterFactoryFn<Partial<CodeBlockConverterOptions>>;

package/dist/lib/asciidoc/converters/index.js

@@ -1,7 +1,7 @@
 import {
   sourceCodeConverter
-} from "../../../chunk-BRMWIQA2.js";
-import "../../../chunk-DDIUST2Z.js";
+} from "../../../chunk-KZRXEKZK.js";
+import "../../../chunk-2UGTFP4R.js";
 export {
   sourceCodeConverter
 };

package/dist/lib/asciidoc/templates/engines/index.d.cts

@@ -1,4 +1,4 @@
-import { b as AbstractEngine, a as AsciidocTemplate, T as TemplateModule, F as FilesystemTemplate, R as RawTemplate } from '../../../../index-BNxO58s3.cjs';
+import { c as AbstractEngine, a as AsciidocTemplate, T as TemplateModule, F as FilesystemTemplate, R as RawTemplate } from '../../../../index-sFlXF8Qm.cjs';
 import { AbstractBlock } from 'asciidoctor';
 import 'shiki';
 import 'astro/zod';

package/dist/lib/asciidoc/templates/engines/index.d.ts

@@ -1,4 +1,4 @@
-import { b as AbstractEngine, a as AsciidocTemplate, T as TemplateModule, F as FilesystemTemplate, R as RawTemplate } from '../../../../index-BNxO58s3.js';
+import { c as AbstractEngine, a as AsciidocTemplate, T as TemplateModule, F as FilesystemTemplate, R as RawTemplate } from '../../../../index-sFlXF8Qm.js';
 import { AbstractBlock } from 'asciidoctor';
 import 'shiki';
 import 'astro/zod';

package/dist/lib/shiki/transformers/index.cjs

@@ -21,7 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var transformers_exports = {};
 __export(transformers_exports, {
   transformAsciidocCallout: () => transformAsciidocCallout,
-  transformConsoleCodeBlock: () => transformConsoleCodeBlock
+  transformConsolePrompt: () => transformConsolePrompt
 });
 module.exports = __toCommonJS(transformers_exports);
 
@@ -32,84 +32,93 @@ function escapeRegexCharacters(str) {
 }
 
 // src/lib/shiki/transformers/transformAsciidocCallout.ts
-function transformAsciidocCallout({
-  node,
-  cssClasses = "pointer-events-none select-none ml-2"
-}) {
-  const lineComments = ["//", "#", ";;"];
-  const customLineComment = node.getAttribute("line-comment");
-  if (customLineComment) {
-    lineComments.push(escapeRegexCharacters(customLineComment));
-  }
-  const calloutReList = [
-    // Handles C-style and similar comments like Perl, Python...
-    new RegExp(`(?:${lineComments.join("|")})((?:\\s+<(\\d+)>)+)`),
-    // Handles XML comments
-    new RegExp(/((?:\s*<!--(\d+)-->)+)/)
-  ];
-  const linesWithCallout = {};
-  return {
-    preprocess(code) {
-      return code.split("\n").map((line, idx) => {
-        for (const re of calloutReList) {
-          const match = line.match(re);
-          if (!match) continue;
-          const callouts = match[0].trim().replaceAll(/(?:<!--|-->|[<>])/g, "").split(" ");
-          linesWithCallout[idx + 1] = callouts;
-          return line.replace(re, "");
-        }
-        return line;
-      }).join("\n");
-    },
-    line(hast, line) {
-      const callouts = linesWithCallout[line];
-      if (!callouts) return;
-      callouts.forEach((calloutId) => {
-        hast.properties[`data-callout-${calloutId}`] = "";
-        hast.children.push({
-          type: "element",
-          tagName: "i",
-          properties: {
-            class: `conum ${cssClasses}`,
-            "data-value": calloutId
-          },
-          children: [
-            {
-              type: "element",
-              tagName: "b",
-              properties: {},
-              children: [
-                {
-                  type: "text",
-                  value: calloutId
-                }
-              ]
-            }
-          ]
-        });
-      });
+var transformAsciidocCallout = (options) => {
+  return (node) => {
+    const lineComments = ["//", "#", ";;"];
+    const customLineComment = node.getAttribute("line-comment");
+    if (customLineComment) {
+      lineComments.push(escapeRegexCharacters(customLineComment));
     }
+    const calloutReList = [
+      // Handles C-style and similar comments like Perl, Python...
+      new RegExp(`\\s+(?:${lineComments.join("|")})((?:\\s+<(\\d+)>)+)`),
+      // Handles XML comments
+      new RegExp(/((?:\s*<!--(\d+)-->)+)/)
+    ];
+    const commentTokensRe = new RegExp(
+      `(?:${lineComments.join("|")}|<!--|-->|[<>])`,
+      "g"
+    );
+    const linesWithCallout = {};
+    return {
+      preprocess(code) {
+        return code.split("\n").map((line, idx) => {
+          for (const re of calloutReList) {
+            const match = line.match(re);
+            if (!match) continue;
+            const callouts = match[0].replaceAll(commentTokensRe, "").trim().split(" ");
+            linesWithCallout[idx + 1] = callouts;
+            return line.replace(re, "");
+          }
+          return line;
+        }).join("\n");
+      },
+      line(hast, line) {
+        const callouts = linesWithCallout[line];
+        if (!callouts) return;
+        callouts.forEach((calloutId) => {
+          hast.properties[`data-callout-${calloutId}`] = "";
+          hast.children.push({
+            type: "element",
+            tagName: "span",
+            properties: {
+              class: options?.cssClasses ?? "conum",
+              style: options?.cssClasses ? "" : "user-select:none; pointer-events:none; opacity:0.5; margin-inline:8px;",
+              "data-value": calloutId
+            },
+            children: [
+              {
+                type: "text",
+                value: calloutId
+              }
+            ]
+          });
+        });
+      }
+    };
   };
-}
+};
 
-// src/lib/shiki/transformers/transformConsoleCodeBlock.ts
-function transformConsoleCodeBlock(options = {
-  cssClasses: "pointer-events-none select-none mr-2 opacity-50"
-}) {
-  const unselectablePrompt = `<span $1 class="${options.cssClasses}">$</span>`;
-  const linePrefix = '<span class="line[^>]+?>';
-  const splitPrompt = new RegExp(
-    `(?<=${linePrefix})(?:<span (style="[^"]*?")>\\s*?\\$\\s+?([^<]))`
-  );
-  const trimWhitespace = new RegExp(
-    `(?<=${linePrefix})(?:<span (style="[^"]*?")>\\s*?\\$\\s*?<\\/span>(?:<span>\\s+<\\/span>)?)`
-  );
-  const trimWhitespaceAhead = new RegExp(
-    `(?<=${linePrefix}<span [^>]+?>\\$<\\/span>)(<span style="[^"]+?">)\\s+?`
-  );
-  return {
-    postprocess: (html, { lang }) => {
-      if (lang === "console") {
+// src/lib/shiki/transformers/transformConsolePrompt.ts
+var transformConsolePrompt = (options) => {
+  return (node) => {
+    const language = node.getAttribute("language");
+    const cssClasses = options?.cssClasses;
+    const promptChar = options?.promptChar ?? "$";
+    const unselectablePrompt = `<span $1 class="${cssClasses}">${promptChar}</span>`;
+    const linePrefix = '<span class="line[^>]+?>';
+    const splitPrompt = new RegExp(
+      `(?<=${linePrefix})(?:<span (style="[^"]*?")>\\s*?\\${promptChar}\\s+?([^<]))`
+    );
+    const trimWhitespace = new RegExp(
+      `(?<=${linePrefix})(?:<span (style="[^"]*?")>\\s*?\\${promptChar}\\s*?<\\/span>(?:<span>\\s+<\\/span>)?)`
+    );
+    const trimWhitespaceAhead = new RegExp(
+      `(?<=${linePrefix}<span [^>]+?>\\${promptChar}<\\/span>)(<span style="[^"]+?">)\\s+?`
+    );
+    return {
+      line(hast) {
+        if (language !== "console") return;
+        const textNode = hast.children.at(0)?.children.at(0);
+        if (textNode && textNode.type === "text") {
+          const leadingChar = textNode.value;
+          if (!leadingChar.startsWith(promptChar)) {
+            textNode.value = promptChar + " " + textNode.value;
+          }
+        }
+      },
+      postprocess: (html) => {
+        if (language !== "console") return;
         return html.split("\n").map((line) => {
           return line.replace(
             splitPrompt,
@@ -117,11 +126,11 @@ function transformConsoleCodeBlock(options = {
           ).replace(trimWhitespace, unselectablePrompt).replace(trimWhitespaceAhead, "$1");
         }).join("\n");
       }
-    }
+    };
   };
-}
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   transformAsciidocCallout,
-  transformConsoleCodeBlock
+  transformConsolePrompt
 });

package/dist/lib/shiki/transformers/index.d.cts

@@ -1,43 +1,34 @@
-import { Block } from 'asciidoctor';
-import { ShikiTransformer } from 'shiki';
-import { ShikiTransformer as ShikiTransformer$1 } from 'shiki/types';
+import { b as ShikiTransformerFactory } from '../../../index-sFlXF8Qm.cjs';
+import 'shiki';
+import 'asciidoctor';
+import 'astro/zod';
 
-type TransformOptions$1 = {
-    /**
-     * Instance of Asciidoc's Block element to act upon.
-     */
-    node: Block;
-    /**
-     * String of CSS classes to apply to Asciidoc callout elements.
-     * Note: this does not override Asciidoctor's default class "conum"
-     * that applies to callout elements.
-     *
-     * @default pointer-events-none select-none ml-2
-     */
+type TransformerOptions = Partial<{
     cssClasses?: string;
-};
-/**
- * Transforms source code blocks by converting Asciidoc's callout annotations
- * into unselectable tokens.
- */
-declare function transformAsciidocCallout({ node, cssClasses, }: TransformOptions$1): ShikiTransformer;
+}>;
+declare const transformAsciidocCallout: ShikiTransformerFactory<TransformerOptions>;
 
 type TransformOptions = {
     /**
-     * String of CSS classes to apply to leading '$' character on console
-     * code blocks. By default, this transformer makes it unselectable and
-     * applies 50% opacity.
+     * String of CSS classes to apply to leading prompt character(s) on
+     * source code blocks of type console.
+     */
+    cssClasses: string;
+    /**
+     * The prompt character representing the actual console prompt.
      *
-     * @default pointer-events-none select-none mr-2 opacity-50
+     * @default $
      */
-    cssClasses?: string;
+    promptChar?: string;
 };
 /**
- * For code blocks of language "console", makes the leading prompt
- * character "$" unselectable, as it often leads to confusion when
- * copying the command and running with the preceding prompt.
+ * For code blocks of language "console", prepends each line with a
+ * prompt character(s), where applicable. By default, a "$" is used but
+ * this can be controlled via the *promptChar* option.
+ * Use the *cssClasses* option to style this prompt for things like
+ * making it unselectable, or dimmed..
  *
- * Likewise, the leading spaces before the actual command are deleted
+ * In addition, the leading spaces before the actual command are deleted
  * from the span elements generated by Shiki to avoid accidentally
  * running commands that would not appear in the shell history.
  *
@@ -54,6 +45,6 @@ type TransformOptions = {
  *   before: <span>$</span><span> npm run dev</span>
  *   after:  <span>$</span><span>npm run dev</span>
  */
-declare function transformConsoleCodeBlock(options?: TransformOptions): ShikiTransformer$1;
+declare const transformConsolePrompt: ShikiTransformerFactory<TransformOptions>;
 
-export { transformAsciidocCallout, transformConsoleCodeBlock };
+export { transformAsciidocCallout, transformConsolePrompt };