@d10f/asciidoc-astro-loader 0.0.9 → 0.0.11

package/README.md

@@ -35,10 +35,9 @@ const blog = defineCollection({
         base: ".src/content/blog",
     }),
     schema: z.object({
-        title: z.string(),
-        preamble: z.string().optional(),
-        createdAt: z.coerce.date(),
-        updatedAt: z.coerce.date().optional(),
+        doctitle: z.string(),
+		description: z.string(),
+        revdate: z.coerce.date(),
     }),
 });
 ```
@@ -317,7 +316,12 @@ A custom converter is declared as a factory function that accepts a configuratio
 ```ts
 import type { CustomConverterFactoryFn, NodeContext } from '@d10f/asciidoc-astro-loader';
 
-export const myCustomConverter: CustomConverterFactoryFn = ({ nodeContext }) => {
+type MyConverterOpts = {
+    name?: string;
+    description?: string;
+};
+
+export const myCustomConverter: CustomConverterFactoryFn<MyConverterOpts> = ({ name, description }) => {
     return (options, highlighter) => {
         return {
 
@@ -325,7 +329,7 @@ export const myCustomConverter: CustomConverterFactoryFn = ({ nodeContext }) =>
              * The type of node that this converter will act upon. It
              * can either be hard-coded here, or passed as an option.
              */
-            nodeContext,
+            nodeContext: 'admonition',
 
             /**
              * The convert function that will produce the HTML output.
@@ -343,3 +347,44 @@ export const myCustomConverter: CustomConverterFactoryFn = ({ nodeContext }) =>
 ```
 
 In addition, the `convert` method receives the node that is being processed, as well as an instance of the template engine registry. You can use this to render the HTML from a template as well, combining both to get the best of both worlds.
+
+Using a converter might make more sense if you need to keep some state as the document is being processed. With templates, each invocation is a brand-new state for each block. A converter encapsulates variables declared within it and this can be used to do things like count how many blocks of a given type there are in the whole document. A more practical example might be if you need to position (through CSS styles) an element left or right based on whether it's even or odd. This can be tricky to do with CSS alone because the `:nth-child()` selector accounts only for elements under the same parent, and not the whole document.
+
+## Example
+
+This is an example taken from my own website to showcase how to use it in a real world setting. This configuration uses a custom converter, a custom Shiki transformer and points to a folder where custom templates are found:
+
+```ts
+const blog = defineCollection({
+	loader: asciidocLoader({
+		base: 'src/content/blog',
+		document: {
+			template: './src/templates',
+			converters: [admonitionConverter()],
+		},
+		syntaxHighlighting: {
+			theme: 'catppuccin-frappe',
+			transformers: [
+				transformerNotationDiff(),
+				transformerNotationErrorLevel(),
+				transformerNotationFocus(),
+				transformerNotationHighlight(),
+				transformerPrompt({
+					langs: {
+						console: '$',
+					},
+					cssClasses: 'unselectable mr-2 opacity-50',
+				}),
+			],
+			callouts: {
+				cssClasses: 'conum unselectable',
+			},
+		},
+	}),
+	schema: z.object({
+		doctitle: z.string(),
+		description: z.string(),
+		revdate: z.coerce.date(),
+	}),
+});
+```

package/dist/{chunk-IWQC3MJM.js → chunk-KPEWXJBE.js}

@@ -5,14 +5,14 @@ import {
 // src/lib/shiki/transformers/transformAsciidocCallout.ts
 var transformAsciidocCallout = (options) => {
   return (node) => {
-    const lineComments = ["//", "#", ";;"];
+    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+)>)+)`),
+      new RegExp(`\\s*(?:${lineComments.join("|")})((?:\\s+<(\\d+)>)+)`),
       // Handles XML comments
       new RegExp(/((?:\s*<!--(\d+)-->)+)/)
     ];
@@ -72,9 +72,19 @@ var transformerPrompt = (options) => {
     if (customPrompt && options?.langs && typeof options.langs[language] === "object") {
       cssClasses = options.langs[language].cssClasses;
     }
+    let skipNext = false;
     return {
+      enforce: "pre",
       line(hast) {
         if (!promptToAdd) return;
+        const skipCurrent = skipNext;
+        skipNext = false;
+        const lastChild = hast.children.at(-1);
+        if (lastChild && // @ts-expect-error property "children" does exist
+        lastChild.children[0].value.match(/\s+\\(?:\\)?\s*$/)) {
+          skipNext = true;
+        }
+        if (skipCurrent) return;
         hast.children.unshift({
           type: "element",
           tagName: "span",

package/dist/{chunk-NC6IZHLR.js → chunk-SUQERYPQ.js}

@@ -21,19 +21,20 @@ var sourceCodeConverter = (converterOptions) => {
             return typeof transformer === "function" ? transformer(node) : transformer;
           })
         });
-        if (templateEngine && template) {
-          const { extension } = splitFilenameComponents(template);
-          const engine = templateEngine.getEngineByExtension(
-            extension || ""
+        if (templateEngine) {
+          const { extension } = splitFilenameComponents(
+            template ?? ""
           );
-          if (engine) {
+          const engine = extension ? templateEngine.getEngineByExtension(extension ?? "") : templateEngine.getEngineByContext(this.nodeContext);
+          if (template) {
             const templateFile = resolve(process.cwd(), template);
-            if (engine.canRenderFile) {
-              return engine.renderFile(templateFile, {
-                content: output,
-                lang
-              });
-            }
+            engine?.addContext(this.nodeContext, templateFile);
+          }
+          if (engine) {
+            return engine.renderNode(node, {
+              content: output,
+              lang
+            });
           }
         }
         return output;

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

@@ -1,4 +1,4 @@
-import { HighlighterCore, CodeToHastOptions, CodeOptionsMultipleThemes, ThemeRegistrationAny, StringLiteralUnion, BundledTheme, ShikiTransformer } from 'shiki';
+import { HighlighterCore, CodeToHastOptions, CodeOptionsMultipleThemes, StringLiteralUnion, BundledTheme, ShikiTransformer } from 'shiki';
 import { AbstractNode, AbstractBlock } from 'asciidoctor';
 import { z } from 'astro/zod';
 
@@ -317,6 +317,10 @@ declare class TemplateEngineRegistry {
      * Returns the module that supports the given extension.
      */
     getEngineByExtension(ext: string): (AbstractEngine & AsciidocTemplate) | undefined;
+    /**
+     * Returns the first module that supports the given context.
+     */
+    getEngineByContext(context: NodeContext): (AbstractEngine & AsciidocTemplate) | undefined;
     /**
      * Converts the provided node using one of the registered template
      * engine modules. For more granular control, gain access to the
@@ -470,7 +474,7 @@ type AsciidocLoader = {
          *
          * @default 'light-dark()'
          */
-        defaultColor: Partial<Record<string, ThemeRegistrationAny | StringLiteralUnion<string>>>;
+        defaultColor?: StringLiteralUnion<'light' | 'dark'> | 'light-dark()' | false;
         /**
          * The syntax highlighter theme to use. It can be either a
          * string that will apply for both light and dark mode by

package/dist/{index-DwboxIUQ.d.ts → index-C1F2jTPD.d.ts}

@@ -1,4 +1,4 @@
-import { HighlighterCore, CodeToHastOptions, CodeOptionsMultipleThemes, ThemeRegistrationAny, StringLiteralUnion, BundledTheme, ShikiTransformer } from 'shiki';
+import { HighlighterCore, CodeToHastOptions, CodeOptionsMultipleThemes, StringLiteralUnion, BundledTheme, ShikiTransformer } from 'shiki';
 import { AbstractNode, AbstractBlock } from 'asciidoctor';
 import { z } from 'astro/zod';
 
@@ -317,6 +317,10 @@ declare class TemplateEngineRegistry {
      * Returns the module that supports the given extension.
      */
     getEngineByExtension(ext: string): (AbstractEngine & AsciidocTemplate) | undefined;
+    /**
+     * Returns the first module that supports the given context.
+     */
+    getEngineByContext(context: NodeContext): (AbstractEngine & AsciidocTemplate) | undefined;
     /**
      * Converts the provided node using one of the registered template
      * engine modules. For more granular control, gain access to the
@@ -470,7 +474,7 @@ type AsciidocLoader = {
          *
          * @default 'light-dark()'
          */
-        defaultColor: Partial<Record<string, ThemeRegistrationAny | StringLiteralUnion<string>>>;
+        defaultColor?: StringLiteralUnion<'light' | 'dark'> | 'light-dark()' | false;
         /**
          * The syntax highlighter theme to use. It can be either a
          * string that will apply for both light and dark mode by

package/dist/index.cjs

@@ -193,6 +193,14 @@ var TemplateEngineRegistry = class _TemplateEngineRegistry {
       (m) => m.extensions.includes(ext)
     );
   }
+  /**
+   * Returns the first module that supports the given context.
+   */
+  getEngineByContext(context) {
+    return _TemplateEngineRegistry.modules.find(
+      (m) => m.hasContext(context)
+    );
+  }
   /**
    * Converts the provided node using one of the registered template
    * engine modules. For more granular control, gain access to the
@@ -247,6 +255,9 @@ var AsciidocDocument = class {
       partition: true
     });
   }
+  get attributes() {
+    return this.document.getAttributes();
+  }
   get title() {
     return this.documentTitle.getMain();
   }
@@ -570,19 +581,20 @@ var sourceCodeConverter = (converterOptions) => {
             return typeof transformer === "function" ? transformer(node) : transformer;
           })
         });
-        if (templateEngine && template) {
-          const { extension } = splitFilenameComponents(template);
-          const engine = templateEngine.getEngineByExtension(
-            extension || ""
+        if (templateEngine) {
+          const { extension } = splitFilenameComponents(
+            template ?? ""
           );
-          if (engine) {
+          const engine = extension ? templateEngine.getEngineByExtension(extension ?? "") : templateEngine.getEngineByContext(this.nodeContext);
+          if (template) {
             const templateFile = (0, import_node_path2.resolve)(process.cwd(), template);
-            if (engine.canRenderFile) {
-              return engine.renderFile(templateFile, {
-                content: output,
-                lang
-              });
-            }
+            engine?.addContext(this.nodeContext, templateFile);
+          }
+          if (engine) {
+            return engine.renderNode(node, {
+              content: output,
+              lang
+            });
           }
         }
         return output;
@@ -594,14 +606,14 @@ var sourceCodeConverter = (converterOptions) => {
 // src/lib/shiki/transformers/transformAsciidocCallout.ts
 var transformAsciidocCallout = (options) => {
   return (node) => {
-    const lineComments = ["//", "#", ";;"];
+    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+)>)+)`),
+      new RegExp(`\\s*(?:${lineComments.join("|")})((?:\\s+<(\\d+)>)+)`),
       // Handles XML comments
       new RegExp(/((?:\s*<!--(\d+)-->)+)/)
     ];
@@ -748,19 +760,20 @@ function asciidocLoader(_options) {
 async function setDocument(doc, converters, templateEngine, { parseData, store }) {
   const data = await parseData({
     id: doc.slug,
-    data: {
-      title: doc.title,
-      subtitle: doc.subtitle,
-      author: doc.author,
-      authors: doc.authors,
-      version: doc.version,
-      createdAt: new Date(doc.createdAt),
-      email: doc.authors.at(0)?.getEmail(),
-      description: doc.description,
-      slug: doc.slug,
-      preamble: doc.preamble,
-      keywords: doc.keywords
-    }
+    data: doc.attributes
+    // data: {
+    // 	title: doc.title,
+    // 	subtitle: doc.subtitle,
+    // 	author: doc.author,
+    // 	authors: doc.authors,
+    // 	version: doc.version,
+    // 	createdAt: new Date(doc.createdAt),
+    // 	email: doc.authors.at(0)?.getEmail(),
+    // 	description: doc.description,
+    // 	slug: doc.slug,
+    // 	preamble: doc.preamble,
+    // 	keywords: doc.keywords,
+    // },
   });
   store.set({
     id: doc.slug,
@@ -783,9 +796,19 @@ var transformerPrompt = (options) => {
     if (customPrompt && options?.langs && typeof options.langs[language] === "object") {
       cssClasses = options.langs[language].cssClasses;
     }
+    let skipNext = false;
     return {
+      enforce: "pre",
       line(hast) {
         if (!promptToAdd) return;
+        const skipCurrent = skipNext;
+        skipNext = false;
+        const lastChild = hast.children.at(-1);
+        if (lastChild && // @ts-expect-error property "children" does exist
+        lastChild.children[0].value.match(/\s+\\(?:\\)?\s*$/)) {
+          skipNext = true;
+        }
+        if (skipCurrent) return;
         hast.children.unshift({
           type: "element",
           tagName: "span",

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { LoaderContext } from 'astro/loaders';
-import { A as AsciidocLoader } from './index-DwboxIUQ.cjs';
-export { a as AsciidocTemplate, C as CustomConverterFactoryFn, F as FilesystemTemplate, N as NodeContext, R as RawTemplate } from './index-DwboxIUQ.cjs';
+import { A as AsciidocLoader } from './index-C1F2jTPD.cjs';
+export { a as AsciidocTemplate, C as CustomConverterFactoryFn, F as FilesystemTemplate, N as NodeContext, R as RawTemplate } from './index-C1F2jTPD.cjs';
 export { transformAsciidocCallout, transformerPrompt } from './lib/shiki/transformers/index.cjs';
 import 'shiki';
 import 'asciidoctor';

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { LoaderContext } from 'astro/loaders';
-import { A as AsciidocLoader } from './index-DwboxIUQ.js';
-export { a as AsciidocTemplate, C as CustomConverterFactoryFn, F as FilesystemTemplate, N as NodeContext, R as RawTemplate } from './index-DwboxIUQ.js';
+import { A as AsciidocLoader } from './index-C1F2jTPD.js';
+export { a as AsciidocTemplate, C as CustomConverterFactoryFn, F as FilesystemTemplate, N as NodeContext, R as RawTemplate } from './index-C1F2jTPD.js';
 export { transformAsciidocCallout, transformerPrompt } from './lib/shiki/transformers/index.js';
 import 'shiki';
 import 'asciidoctor';

package/dist/index.js

@@ -1,10 +1,10 @@
 import {
   sourceCodeConverter
-} from "./chunk-NC6IZHLR.js";
+} from "./chunk-SUQERYPQ.js";
 import {
   transformAsciidocCallout,
   transformerPrompt
-} from "./chunk-IWQC3MJM.js";
+} from "./chunk-KPEWXJBE.js";
 import {
   slugify,
   splitFilenameComponents
@@ -155,6 +155,14 @@ var TemplateEngineRegistry = class _TemplateEngineRegistry {
       (m) => m.extensions.includes(ext)
     );
   }
+  /**
+   * Returns the first module that supports the given context.
+   */
+  getEngineByContext(context) {
+    return _TemplateEngineRegistry.modules.find(
+      (m) => m.hasContext(context)
+    );
+  }
   /**
    * Converts the provided node using one of the registered template
    * engine modules. For more granular control, gain access to the
@@ -209,6 +217,9 @@ var AsciidocDocument = class {
       partition: true
     });
   }
+  get attributes() {
+    return this.document.getAttributes();
+  }
   get title() {
     return this.documentTitle.getMain();
   }
@@ -459,19 +470,20 @@ function asciidocLoader(_options) {
 async function setDocument(doc, converters, templateEngine, { parseData, store }) {
   const data = await parseData({
     id: doc.slug,
-    data: {
-      title: doc.title,
-      subtitle: doc.subtitle,
-      author: doc.author,
-      authors: doc.authors,
-      version: doc.version,
-      createdAt: new Date(doc.createdAt),
-      email: doc.authors.at(0)?.getEmail(),
-      description: doc.description,
-      slug: doc.slug,
-      preamble: doc.preamble,
-      keywords: doc.keywords
-    }
+    data: doc.attributes
+    // data: {
+    // 	title: doc.title,
+    // 	subtitle: doc.subtitle,
+    // 	author: doc.author,
+    // 	authors: doc.authors,
+    // 	version: doc.version,
+    // 	createdAt: new Date(doc.createdAt),
+    // 	email: doc.authors.at(0)?.getEmail(),
+    // 	description: doc.description,
+    // 	slug: doc.slug,
+    // 	preamble: doc.preamble,
+    // 	keywords: doc.keywords,
+    // },
   });
   store.set({
     id: doc.slug,

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

@@ -55,19 +55,20 @@ var sourceCodeConverter = (converterOptions) => {
             return typeof transformer === "function" ? transformer(node) : transformer;
           })
         });
-        if (templateEngine && template) {
-          const { extension } = splitFilenameComponents(template);
-          const engine = templateEngine.getEngineByExtension(
-            extension || ""
+        if (templateEngine) {
+          const { extension } = splitFilenameComponents(
+            template ?? ""
           );
-          if (engine) {
+          const engine = extension ? templateEngine.getEngineByExtension(extension ?? "") : templateEngine.getEngineByContext(this.nodeContext);
+          if (template) {
             const templateFile = (0, import_node_path.resolve)(process.cwd(), template);
-            if (engine.canRenderFile) {
-              return engine.renderFile(templateFile, {
-                content: output,
-                lang
-              });
-            }
+            engine?.addContext(this.nodeContext, templateFile);
+          }
+          if (engine) {
+            return engine.renderNode(node, {
+              content: output,
+              lang
+            });
           }
         }
         return output;

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-DwboxIUQ.cjs';
+import { C as CustomConverterFactoryFn, S as ShikiTransformerFactoryFn } from '../../../index-C1F2jTPD.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-DwboxIUQ.js';
+import { C as CustomConverterFactoryFn, S as ShikiTransformerFactoryFn } from '../../../index-C1F2jTPD.js';
 import 'asciidoctor';
 import 'astro/zod';
 

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

@@ -1,6 +1,6 @@
 import {
   sourceCodeConverter
-} from "../../../chunk-NC6IZHLR.js";
+} from "../../../chunk-SUQERYPQ.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-DwboxIUQ.cjs';
+import { b as AbstractEngine, a as AsciidocTemplate, T as TemplateModule, F as FilesystemTemplate, R as RawTemplate } from '../../../../index-C1F2jTPD.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-DwboxIUQ.js';
+import { b as AbstractEngine, a as AsciidocTemplate, T as TemplateModule, F as FilesystemTemplate, R as RawTemplate } from '../../../../index-C1F2jTPD.js';
 import { AbstractBlock } from 'asciidoctor';
 import 'shiki';
 import 'astro/zod';

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

@@ -34,14 +34,14 @@ function escapeRegexCharacters(str) {
 // src/lib/shiki/transformers/transformAsciidocCallout.ts
 var transformAsciidocCallout = (options) => {
   return (node) => {
-    const lineComments = ["//", "#", ";;"];
+    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+)>)+)`),
+      new RegExp(`\\s*(?:${lineComments.join("|")})((?:\\s+<(\\d+)>)+)`),
       // Handles XML comments
       new RegExp(/((?:\s*<!--(\d+)-->)+)/)
     ];
@@ -101,9 +101,19 @@ var transformerPrompt = (options) => {
     if (customPrompt && options?.langs && typeof options.langs[language] === "object") {
       cssClasses = options.langs[language].cssClasses;
     }
+    let skipNext = false;
     return {
+      enforce: "pre",
       line(hast) {
         if (!promptToAdd) return;
+        const skipCurrent = skipNext;
+        skipNext = false;
+        const lastChild = hast.children.at(-1);
+        if (lastChild && // @ts-expect-error property "children" does exist
+        lastChild.children[0].value.match(/\s+\\(?:\\)?\s*$/)) {
+          skipNext = true;
+        }
+        if (skipCurrent) return;
         hast.children.unshift({
           type: "element",
           tagName: "span",

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

@@ -1,4 +1,4 @@
-import { c as ShikiTransformerFactory } from '../../../index-DwboxIUQ.cjs';
+import { c as ShikiTransformerFactory } from '../../../index-C1F2jTPD.cjs';
 import { BundledLanguage } from 'shiki/types';
 import 'shiki';
 import 'asciidoctor';

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

@@ -1,4 +1,4 @@
-import { c as ShikiTransformerFactory } from '../../../index-DwboxIUQ.js';
+import { c as ShikiTransformerFactory } from '../../../index-C1F2jTPD.js';
 import { BundledLanguage } from 'shiki/types';
 import 'shiki';
 import 'asciidoctor';

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

@@ -1,7 +1,7 @@
 import {
   transformAsciidocCallout,
   transformerPrompt
-} from "../../../chunk-IWQC3MJM.js";
+} from "../../../chunk-KPEWXJBE.js";
 import "../../../chunk-2UGTFP4R.js";
 export {
   transformAsciidocCallout,

package/package.json

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