@d10f/asciidoc-astro-loader 0.0.4 → 0.0.5

package/README.md

@@ -179,7 +179,7 @@ Just like regular Asciidoctor.js, any files located here will be used to replace
 
 ### Registering A Templating Engine
 
-By default, only Handlebars and Nunjucks are available for processing templates, but you can create your own as well to leverage whatever other template engine you like. A template engine in the context of this package a class that extends the `AbstractEngine` class.
+Templates can be written as plain functions that return an HTML string, or as templates written in a format supported by one of the registered templating engines. By default, only Handlebars and Nunjucks are supported, but you can create your own. A templating engine in the context of this package is a class that extends the `AbstractEngine` class:
 
 ```ts
 import { Php, Request } from '@platformatic/php-node';

package/dist/{index-CS3PBqxf.d.cts → index-R3g0cYiE.d.cts}

@@ -542,4 +542,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, type ShikiTransformerFactory as b, AbstractEngine as c };
+export { type AsciidocLoader 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 AsciidocTemplate as a, type ShikiTransformerFactoryFn as b, AbstractEngine as c };

package/dist/{index-CS3PBqxf.d.ts → index-R3g0cYiE.d.ts}

@@ -542,4 +542,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, type ShikiTransformerFactory as b, AbstractEngine as c };
+export { type AsciidocLoader 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 AsciidocTemplate as a, type ShikiTransformerFactoryFn as b, AbstractEngine as c };

package/dist/index.cjs

@@ -260,6 +260,15 @@ var AsciidocDocument = class {
     const [preambleBlock] = documentBlock?.getBlocks();
     if (preambleBlock) return preambleBlock.getSourceLines()[0];
   }
+  get description() {
+    return this.document.getAttribute("description", "");
+  }
+  get author() {
+    return this.document.getAuthor();
+  }
+  get authors() {
+    return this.document.getAuthors();
+  }
   get version() {
     return this.document.getRevisionNumber();
   }
@@ -416,6 +425,26 @@ var NunjucksEngine = class extends AbstractEngine {
   }
 };
 
+// src/lib/asciidoc/templates/engines/TemplateStr.ts
+var TemplateStr = class extends AbstractEngine {
+  renderMap;
+  constructor(name = "templateStr", extensions = ["ts", "js"]) {
+    super(name, extensions);
+    this.renderMap = /* @__PURE__ */ new Map();
+  }
+  async load() {
+    for (const [context, path] of this.templateList.entries()) {
+      const templateFn = await import(path);
+      this.renderMap.set(context, templateFn.default);
+    }
+  }
+  renderNode(node, options) {
+    const context = node.getNodeName();
+    const renderFn = this.renderMap.get(context);
+    return renderFn ? renderFn(node, options) : "";
+  }
+};
+
 // src/schemas/index.ts
 var import_zod3 = require("astro/zod");
 
@@ -624,7 +653,8 @@ function asciidocLoader(_options) {
   if (options.document.templateEngines === void 0) {
     options.document.templateEngines = [
       new HandlebarsEngine(),
-      new NunjucksEngine()
+      new NunjucksEngine(),
+      new TemplateStr()
     ];
   }
   let highlighter;
@@ -715,8 +745,16 @@ async function setDocument(doc, converters, templateEngine, { parseData, store }
     id: doc.slug,
     data: {
       title: doc.title,
+      subtitle: doc.subtitle,
+      author: doc.author,
+      authors: doc.authors,
+      version: doc.version,
       createdAt: new Date(doc.createdAt),
-      description: doc.preamble
+      email: doc.authors.at(0)?.getEmail(),
+      description: doc.description,
+      slug: doc.slug,
+      preamble: doc.preamble,
+      keywords: doc.keywords
     }
   });
   store.set({

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { LoaderContext } from 'astro/loaders';
-import { A as AsciidocLoader } from './index-CS3PBqxf.cjs';
-export { a as AsciidocTemplate, C as CustomConverterFactoryFn, F as FilesystemTemplate, N as NodeContext, R as RawTemplate } from './index-CS3PBqxf.cjs';
+import { A as AsciidocLoader } from './index-R3g0cYiE.cjs';
+export { a as AsciidocTemplate, C as CustomConverterFactoryFn, F as FilesystemTemplate, N as NodeContext, R as RawTemplate } from './index-R3g0cYiE.cjs';
 import 'shiki';
 import 'asciidoctor';
 import 'astro/zod';

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { LoaderContext } from 'astro/loaders';
-import { A as AsciidocLoader } from './index-CS3PBqxf.js';
-export { a as AsciidocTemplate, C as CustomConverterFactoryFn, F as FilesystemTemplate, N as NodeContext, R as RawTemplate } from './index-CS3PBqxf.js';
+import { A as AsciidocLoader } from './index-R3g0cYiE.js';
+export { a as AsciidocTemplate, C as CustomConverterFactoryFn, F as FilesystemTemplate, N as NodeContext, R as RawTemplate } from './index-R3g0cYiE.js';
 import 'shiki';
 import 'asciidoctor';
 import 'astro/zod';

package/dist/index.js

@@ -1,14 +1,15 @@
-import {
-  sourceCodeConverter
-} from "./chunk-NC6IZHLR.js";
 import {
   transformAsciidocCallout
 } from "./chunk-5P6LDJGO.js";
+import {
+  sourceCodeConverter
+} from "./chunk-NC6IZHLR.js";
 import {
   slugify,
   splitFilenameComponents
 } from "./chunk-2UGTFP4R.js";
 import {
+  AbstractEngine,
   HandlebarsEngine,
   NunjucksEngine
 } from "./chunk-2F52PMNV.js";
@@ -222,6 +223,15 @@ var AsciidocDocument = class {
     const [preambleBlock] = documentBlock?.getBlocks();
     if (preambleBlock) return preambleBlock.getSourceLines()[0];
   }
+  get description() {
+    return this.document.getAttribute("description", "");
+  }
+  get author() {
+    return this.document.getAuthor();
+  }
+  get authors() {
+    return this.document.getAuthors();
+  }
   get version() {
     return this.document.getRevisionNumber();
   }
@@ -249,6 +259,26 @@ var AsciidocDocument = class {
   }
 };
 
+// src/lib/asciidoc/templates/engines/TemplateStr.ts
+var TemplateStr = class extends AbstractEngine {
+  renderMap;
+  constructor(name = "templateStr", extensions = ["ts", "js"]) {
+    super(name, extensions);
+    this.renderMap = /* @__PURE__ */ new Map();
+  }
+  async load() {
+    for (const [context, path] of this.templateList.entries()) {
+      const templateFn = await import(path);
+      this.renderMap.set(context, templateFn.default);
+    }
+  }
+  renderNode(node, options) {
+    const context = node.getNodeName();
+    const renderFn = this.renderMap.get(context);
+    return renderFn ? renderFn(node, options) : "";
+  }
+};
+
 // src/schemas/index.ts
 import { z as z3 } from "astro/zod";
 
@@ -359,7 +389,8 @@ function asciidocLoader(_options) {
   if (options.document.templateEngines === void 0) {
     options.document.templateEngines = [
       new HandlebarsEngine(),
-      new NunjucksEngine()
+      new NunjucksEngine(),
+      new TemplateStr()
     ];
   }
   let highlighter;
@@ -450,8 +481,16 @@ async function setDocument(doc, converters, templateEngine, { parseData, store }
     id: doc.slug,
     data: {
       title: doc.title,
+      subtitle: doc.subtitle,
+      author: doc.author,
+      authors: doc.authors,
+      version: doc.version,
       createdAt: new Date(doc.createdAt),
-      description: doc.preamble
+      email: doc.authors.at(0)?.getEmail(),
+      description: doc.description,
+      slug: doc.slug,
+      preamble: doc.preamble,
+      keywords: doc.keywords
     }
   });
   store.set({

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

@@ -1,5 +1,5 @@
 import { ShikiTransformer } from 'shiki';
-import { C as CustomConverterFactoryFn, S as ShikiTransformerFactoryFn } from '../../../index-CS3PBqxf.cjs';
+import { C as CustomConverterFactoryFn, b as ShikiTransformerFactoryFn } from '../../../index-R3g0cYiE.cjs';
 import 'asciidoctor';
 import 'astro/zod';
 

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

@@ -1,5 +1,5 @@
 import { ShikiTransformer } from 'shiki';
-import { C as CustomConverterFactoryFn, S as ShikiTransformerFactoryFn } from '../../../index-CS3PBqxf.js';
+import { C as CustomConverterFactoryFn, b as ShikiTransformerFactoryFn } from '../../../index-R3g0cYiE.js';
 import 'asciidoctor';
 import 'astro/zod';
 

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

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

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

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

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

@@ -21,7 +21,6 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var transformers_exports = {};
 __export(transformers_exports, {
   transformAsciidocCallout: () => transformAsciidocCallout,
-  transformConsolePrompt: () => transformConsolePrompt,
   transformerPrompt: () => transformerPrompt
 });
 module.exports = __toCommonJS(transformers_exports);
@@ -90,47 +89,6 @@ var transformAsciidocCallout = (options) => {
   };
 };
 
-// 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) => {
@@ -138,7 +96,7 @@ var transformerPrompt = (options) => {
     const customPrompt = node.getAttribute(
       options?.promptAttribute ?? "custom-prompt"
     );
-    const promptToAdd = customPrompt ?? (options?.prompts && options.prompts[language]);
+    const promptToAdd = customPrompt ?? (options?.langs && options.langs[language]);
     const cssClasses = typeof promptToAdd === "object" ? promptToAdd.cssClasses : options?.cssClasses;
     return {
       line(hast) {
@@ -163,6 +121,5 @@ var transformerPrompt = (options) => {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   transformAsciidocCallout,
-  transformConsolePrompt,
   transformerPrompt
 });

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

@@ -1,4 +1,4 @@
-import { b as ShikiTransformerFactory } from '../../../index-CS3PBqxf.cjs';
+import { S as ShikiTransformerFactory } from '../../../index-R3g0cYiE.cjs';
 import { BundledLanguage } from 'shiki/types';
 import 'shiki';
 import 'asciidoctor';
@@ -9,45 +9,6 @@ type TransformerOptions = Partial<{
 }>;
 declare const transformAsciidocCallout: ShikiTransformerFactory<TransformerOptions>;
 
-type TransformOptions$1 = {
-    /**
-     * 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 $
-     */
-    promptChar?: string;
-};
-/**
- * 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..
- *
- * 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.
- *
- * @example
- *   before: <span>$ npm run dev</span>
- *   after:  <span>$</span><span>npm run dev</span>
- *
- * @example
- *   before: <span> $ </span><span> </span>
- *   before: <span> $ </span>
- *   after:  <span>$</span>
- *
- * @example
- *   before: <span>$</span><span> npm run dev</span>
- *   after:  <span>$</span><span>npm run dev</span>
- */
-declare const transformConsolePrompt: ShikiTransformerFactory<TransformOptions$1>;
-
 type PromptOptions = {
     prompt: string;
     cssClasses: string;
@@ -65,7 +26,7 @@ type TransformOptions = {
      * 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>>;
+    langs?: 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.
@@ -76,4 +37,4 @@ type TransformOptions = {
 };
 declare const transformerPrompt: ShikiTransformerFactory<TransformOptions>;
 
-export { transformAsciidocCallout, transformConsolePrompt, transformerPrompt };
+export { transformAsciidocCallout, transformerPrompt };

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

@@ -1,4 +1,4 @@
-import { b as ShikiTransformerFactory } from '../../../index-CS3PBqxf.js';
+import { S as ShikiTransformerFactory } from '../../../index-R3g0cYiE.js';
 import { BundledLanguage } from 'shiki/types';
 import 'shiki';
 import 'asciidoctor';
@@ -9,45 +9,6 @@ type TransformerOptions = Partial<{
 }>;
 declare const transformAsciidocCallout: ShikiTransformerFactory<TransformerOptions>;
 
-type TransformOptions$1 = {
-    /**
-     * 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 $
-     */
-    promptChar?: string;
-};
-/**
- * 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..
- *
- * 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.
- *
- * @example
- *   before: <span>$ npm run dev</span>
- *   after:  <span>$</span><span>npm run dev</span>
- *
- * @example
- *   before: <span> $ </span><span> </span>
- *   before: <span> $ </span>
- *   after:  <span>$</span>
- *
- * @example
- *   before: <span>$</span><span> npm run dev</span>
- *   after:  <span>$</span><span>npm run dev</span>
- */
-declare const transformConsolePrompt: ShikiTransformerFactory<TransformOptions$1>;
-
 type PromptOptions = {
     prompt: string;
     cssClasses: string;
@@ -65,7 +26,7 @@ type TransformOptions = {
      * 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>>;
+    langs?: 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.
@@ -76,4 +37,4 @@ type TransformOptions = {
 };
 declare const transformerPrompt: ShikiTransformerFactory<TransformOptions>;
 
-export { transformAsciidocCallout, transformConsolePrompt, transformerPrompt };
+export { transformAsciidocCallout, transformerPrompt };

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

@@ -3,47 +3,6 @@ import {
 } 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) => {
@@ -51,7 +10,7 @@ var transformerPrompt = (options) => {
     const customPrompt = node.getAttribute(
       options?.promptAttribute ?? "custom-prompt"
     );
-    const promptToAdd = customPrompt ?? (options?.prompts && options.prompts[language]);
+    const promptToAdd = customPrompt ?? (options?.langs && options.langs[language]);
     const cssClasses = typeof promptToAdd === "object" ? promptToAdd.cssClasses : options?.cssClasses;
     return {
       line(hast) {
@@ -75,6 +34,5 @@ var transformerPrompt = (options) => {
 };
 export {
   transformAsciidocCallout,
-  transformConsolePrompt,
   transformerPrompt
 };

package/package.json

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