@d10f/asciidoc-astro-loader 0.0.2 → 0.0.4

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

@@ -1,43 +1,35 @@
-import { Block } from 'asciidoctor';
-import { ShikiTransformer } from 'shiki';
-import { ShikiTransformer as ShikiTransformer$1 } from 'shiki/types';
+import { b as ShikiTransformerFactory } from '../../../index-CS3PBqxf.cjs';
+import { BundledLanguage } from 'shiki/types';
+import 'shiki';
+import 'asciidoctor';
+import 'astro/zod';
+
+type TransformerOptions = Partial<{
+    cssClasses?: string;
+}>;
+declare const transformAsciidocCallout: ShikiTransformerFactory<TransformerOptions>;
 
 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
+     * String of CSS classes to apply to leading prompt character(s) on
+     * source code blocks of type console.
      */
-    cssClasses?: string;
-};
-/**
- * Transforms source code blocks by converting Asciidoc's callout annotations
- * into unselectable tokens.
- */
-declare function transformAsciidocCallout({ node, cssClasses, }: TransformOptions$1): ShikiTransformer;
-
-type TransformOptions = {
+    cssClasses: string;
     /**
-     * String of CSS classes to apply to leading '$' character on console
-     * code blocks. By default, this transformer makes it unselectable and
-     * applies 50% opacity.
+     * 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 +46,34 @@ 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$1>;
+
+type PromptOptions = {
+    prompt: string;
+    cssClasses: string;
+};
+type TransformOptions = {
+    /**
+     * String of CSS classes to apply to leading prompt character(s) on
+     * source code blocks of type console.
+     */
+    cssClasses?: string;
+    /**
+     * An object mapping each language block to a prompt string. An object
+     * can also be provided specified with two keys, the prompt and the
+     * css classes that modify this prompt in particular. Useful when you
+     * want to style them differently from the
+     * If not provided, it will default to look at the block attribute.
+     */
+    prompts?: Partial<Record<BundledLanguage, PromptOptions | string>>;
+    /**
+     * The name of the block attribute on the original document to look
+     * for and use as the prompt for this block.
+     *
+     * @default custom-prompt
+     */
+    promptAttribute?: string;
+};
+declare const transformerPrompt: ShikiTransformerFactory<TransformOptions>;
 
-export { transformAsciidocCallout, transformConsoleCodeBlock };
+export { transformAsciidocCallout, transformConsolePrompt, transformerPrompt };

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

@@ -1,43 +1,35 @@
-import { Block } from 'asciidoctor';
-import { ShikiTransformer } from 'shiki';
-import { ShikiTransformer as ShikiTransformer$1 } from 'shiki/types';
+import { b as ShikiTransformerFactory } from '../../../index-CS3PBqxf.js';
+import { BundledLanguage } from 'shiki/types';
+import 'shiki';
+import 'asciidoctor';
+import 'astro/zod';
+
+type TransformerOptions = Partial<{
+    cssClasses?: string;
+}>;
+declare const transformAsciidocCallout: ShikiTransformerFactory<TransformerOptions>;
 
 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
+     * String of CSS classes to apply to leading prompt character(s) on
+     * source code blocks of type console.
      */
-    cssClasses?: string;
-};
-/**
- * Transforms source code blocks by converting Asciidoc's callout annotations
- * into unselectable tokens.
- */
-declare function transformAsciidocCallout({ node, cssClasses, }: TransformOptions$1): ShikiTransformer;
-
-type TransformOptions = {
+    cssClasses: string;
     /**
-     * String of CSS classes to apply to leading '$' character on console
-     * code blocks. By default, this transformer makes it unselectable and
-     * applies 50% opacity.
+     * 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 +46,34 @@ 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$1>;
+
+type PromptOptions = {
+    prompt: string;
+    cssClasses: string;
+};
+type TransformOptions = {
+    /**
+     * String of CSS classes to apply to leading prompt character(s) on
+     * source code blocks of type console.
+     */
+    cssClasses?: string;
+    /**
+     * An object mapping each language block to a prompt string. An object
+     * can also be provided specified with two keys, the prompt and the
+     * css classes that modify this prompt in particular. Useful when you
+     * want to style them differently from the
+     * If not provided, it will default to look at the block attribute.
+     */
+    prompts?: Partial<Record<BundledLanguage, PromptOptions | string>>;
+    /**
+     * The name of the block attribute on the original document to look
+     * for and use as the prompt for this block.
+     *
+     * @default custom-prompt
+     */
+    promptAttribute?: string;
+};
+declare const transformerPrompt: ShikiTransformerFactory<TransformOptions>;
 
-export { transformAsciidocCallout, transformConsoleCodeBlock };
+export { transformAsciidocCallout, transformConsolePrompt, transformerPrompt };

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

@@ -1,8 +1,80 @@
 import {
-  transformAsciidocCallout,
-  transformConsoleCodeBlock
-} from "../../../chunk-DDIUST2Z.js";
+  transformAsciidocCallout
+} from "../../../chunk-5P6LDJGO.js";
+import "../../../chunk-2UGTFP4R.js";
+
+// 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,
+            unselectablePrompt + "<span $1>$2"
+          ).replace(trimWhitespace, unselectablePrompt).replace(trimWhitespaceAhead, "$1");
+        }).join("\n");
+      }
+    };
+  };
+};
+
+// src/lib/shiki/transformers/transformerPrompt.ts
+var transformerPrompt = (options) => {
+  return (node) => {
+    const language = node.getAttribute("language");
+    const customPrompt = node.getAttribute(
+      options?.promptAttribute ?? "custom-prompt"
+    );
+    const promptToAdd = customPrompt ?? (options?.prompts && options.prompts[language]);
+    const cssClasses = typeof promptToAdd === "object" ? promptToAdd.cssClasses : options?.cssClasses;
+    return {
+      line(hast) {
+        if (!promptToAdd) return;
+        hast.children.unshift({
+          type: "element",
+          tagName: "span",
+          properties: {
+            class: cssClasses
+          },
+          children: [
+            {
+              type: "text",
+              value: typeof promptToAdd === "object" ? promptToAdd.prompt : promptToAdd
+            }
+          ]
+        });
+      }
+    };
+  };
+};
 export {
   transformAsciidocCallout,
-  transformConsoleCodeBlock
+  transformConsolePrompt,
+  transformerPrompt
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d10f/asciidoc-astro-loader",
-	"version": "0.0.2",
+	"version": "0.0.4",
 	"description": "An Astro collections loader for Asciidoc files",
 	"author": "D10f",
 	"license": "MIT",

package/dist/chunk-DDIUST2Z.js

@@ -1,113 +0,0 @@
-// src/lib/utils.ts
-function slugify(text) {
-  return text.trim().normalize().toLowerCase().replace(/\s+/g, "-").replace(/[^\w-]+/g, "").replace(/--+/g, "-").replace(/^-+/, "").replace(/-+$/, "");
-}
-function escapeRegexCharacters(str) {
-  const re = /[-\\^$*+?.()|\[\]{}]/g;
-  return str.replace(re, "\\$&");
-}
-function splitFilenameComponents(filename) {
-  const match = filename.match(/^(?<path>.*\/)*(?<name>[^\.]+)\.(?<ext>.*)$/);
-  return {
-    filepath: match?.groups?.path ?? null,
-    filename: match?.groups?.name ?? null,
-    extension: match?.groups?.ext ?? null
-  };
-}
-
-// 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");
-      }
-    }
-  };
-}
-
-export {
-  slugify,
-  splitFilenameComponents,
-  transformAsciidocCallout,
-  transformConsoleCodeBlock
-};