feat: pass eleventy front matter from asciidoc attributes

saneef · saneef · commit c1a07a580d0b · 2025-04-06T01:30:51.000+05:30
Fixes #24
diff --git a/lib/eleventy-asciidoc.js b/lib/eleventy-asciidoc.js
@@ -7,14 +7,19 @@ const fs = require("fs");
 const matter = require("gray-matter");
 const path = require("path");
 const nunjucks = require("nunjucks");
-const { parseDocumentAttributes } = require("./utils.js");
+const { parseDocumentAttributes, pickByKeyPrefix } = require("./utils.js");
 
 // @ts-ignore
 const processor = asciidoctor();
 
-/** @typedef {import('@asciidoctor/core').ProcessorOptions} ProcessorOptions */
 /** @typedef {import('gray-matter').GrayMatterFile}  GrayMatterFile */
 
+/**
+ * @typedef {Object} ExtraProcessorOptions
+ * @property {string=} eleventyAttributesPrefix
+ * @typedef {import('@asciidoctor/core').ProcessorOptions & ExtraProcessorOptions} EleventyAsciidocOptions
+ */
+
 /**
  * Reads a file synchronously.
  *
@@ -32,23 +37,31 @@ const readFileSync = (inputPath) => {
 /**
  * Creates getData function with options initialised.
  *
- * @param      {ProcessorOptions}  converterOptions  The converter options
+ * @param      {EleventyAsciidocOptions}  converterOptions  The converter options
  * @return     {GetDataFn}
  */
 const generateGetData = (converterOptions) => (inputPath) => {
   const { data, content } = readFileSync(inputPath);
+  const { eleventyAttributesPrefix = "eleventy-" } = converterOptions;
+
   const doc = processor.load(content, {
     ...converterOptions,
     base_dir: getBaseDir(inputPath, converterOptions.base_dir),
   });
   const attributes = doc.getAttributes();
   const title = doc.getDocumentTitle();
+  const eleventyAttributes = pickByKeyPrefix(
+    attributes,
+    eleventyAttributesPrefix,
+  );
+
   debug(`Document title ${title}`);
   debug(`Document attributes: ${JSON.stringify(attributes)}`);
 
   return {
     title,
     asciidocAttributes: attributes,
+    ...eleventyAttributes,
     ...data,
   };
 };
@@ -67,7 +80,7 @@ function getBaseDir(inputPath, base_dir) {
 /**
  * Generates Eleventy template renderer for AsciiDoctor
  *
- * @param      {ProcessorOptions=}  convertOptions Options for Asciidoctor.converter()
+ * @param      {EleventyAsciidocOptions=}  convertOptions Options for Asciidoctor.converter()
  * @return     {Object}             Eleventy data processor object
  */
 function eleventyAsciidoctor(convertOptions = {}) {
diff --git a/tests/attributes-to-front-matter.mjs b/tests/attributes-to-front-matter.mjs
@@ -0,0 +1,29 @@
+/* eslint camelcase: ["error", {allow: ["base_dir"]}] */
+
+import Eleventy from "@11ty/eleventy";
+import test from "ava";
+import { removeNewlines } from "./utils.js";
+
+test("Permalinks are mapped correctly", async (t) => {
+  const elev = new Eleventy(
+    "./tests/fixtures/attributes-to-front-matter/",
+    "./tests/fixtures/_site",
+    {
+      configPath: "./tests/fixtures/attributes-to-front-matter/.eleventy.js",
+    },
+  );
+  const json = await elev.toJSON();
+
+  t.is(json.length, 2);
+
+  const home = json.find((d) => d.inputPath.endsWith("home.adoc"));
+  t.is(home.url, "/");
+  t.snapshot(removeNewlines(home.content));
+
+  const permalinkTemplate = json.find((d) =>
+    d.inputPath.endsWith("permalink-template.adoc"),
+  );
+  t.is(permalinkTemplate.url, "/another-index.html");
+
+  t.snapshot(removeNewlines(permalinkTemplate.content));
+});
diff --git a/tests/fixtures/attributes-to-front-matter/.eleventy.js b/tests/fixtures/attributes-to-front-matter/.eleventy.js
@@ -0,0 +1,5 @@
+const eleventyAsciidoc = require("../../../");
+
+module.exports = function (eleventyConfig) {
+  eleventyConfig.addPlugin(eleventyAsciidoc);
+};
diff --git a/tests/fixtures/attributes-to-front-matter/_includes/base.njk b/tests/fixtures/attributes-to-front-matter/_includes/base.njk
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>{{ title }}</title>
+</head>
+<body>
+  {% block content %}{{ content | safe }}{% endblock %}
+</body>
+</html>
diff --git a/tests/fixtures/attributes-to-front-matter/home.adoc b/tests/fixtures/attributes-to-front-matter/home.adoc
@@ -0,0 +1,6 @@
+:eleventy-layout: base.njk
+:eleventy-permalink: index.html
+
+= Home
+
+This text is written in AsciiDoc format.
diff --git a/tests/fixtures/attributes-to-front-matter/permalink-template.adoc b/tests/fixtures/attributes-to-front-matter/permalink-template.adoc
@@ -0,0 +1,7 @@
+:eleventy-layout: base.njk
+:eleventy-urlslug: another-index
+:eleventy-permalink: {{ urlslug }}.html
+
+= Another Page
+
+This text is written in AsciiDoc format.
diff --git a/tests/snapshots/attributes-to-front-matter.mjs.md b/tests/snapshots/attributes-to-front-matter.mjs.md
@@ -0,0 +1,15 @@
+# Snapshot report for `tests/attributes-to-front-matter.mjs`
+
+The actual snapshot is saved in `attributes-to-front-matter.mjs.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## Permalinks are mapped correctly
+
+> Snapshot 1
+
+    '<!DOCTYPE html><html lang="en"><head>  <meta charset="UTF-8">  <meta name="viewport" content="width=device-width, initial-scale=1.0">  <title>Home</title></head><body>  <div class="paragraph"><p>This text is written in AsciiDoc format.</p></div></body></html>'
+
+> Snapshot 2
+
+    '<!DOCTYPE html><html lang="en"><head>  <meta charset="UTF-8">  <meta name="viewport" content="width=device-width, initial-scale=1.0">  <title>Another Page</title></head><body>  <div class="paragraph"><p>This text is written in AsciiDoc format.</p></div></body></html>'
diff --git a/tests/snapshots/attributes-to-front-matter.mjs.snap b/tests/snapshots/attributes-to-front-matter.mjs.snap
diff --git a/tests/utils.js b/tests/utils.js
@@ -0,0 +1,7 @@
+function removeNewlines(str) {
+  return str.replace(/[^\x20-\x7E]/gim, "");
+}
+
+module.exports = {
+  removeNewlines,
+};
