fix: pass thru front matter

- Let Eleventy handle front matter.
- Permalink is render by the plugin using Nunjucks.

Author: saneef

lib/eleventy-asciidoc.js

@@ -35,34 +35,46 @@ const readFileSync = (inputPath) => {
  */
 
 /**
- * Creates getData function with options initialised.
+ * Creates generateGetDataFromInputPath function with options initialised.
  *
  * @param      {EleventyAsciidocOptions}  converterOptions  The converter options
  * @return     {GetDataFn}
  */
-const generateGetData = (converterOptions) => (inputPath) => {
-  const { data, content } = readFileSync(inputPath);
+
+const generateGetDataFromInputPath = (converterOptions) => (inputPath) => {
+  const { 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 attributes = doc.getAttributes();
   const eleventyAttributes = pickByKeyPrefix(
     attributes,
     eleventyAttributesPrefix,
   );
 
   debug(`Document title ${title}`);
   debug(`Document attributes: ${JSON.stringify(attributes)}`);
+  debug(`Document Eleventy attributes: ${JSON.stringify(eleventyAttributes)}`);
 
-  return {
+  let data = {
     title,
     asciidocAttributes: attributes,
     ...eleventyAttributes,
-    ...data,
+  };
+
+  // Removes undefined or null values
+  // that may override Eleventy page data.
+  data = Object.entries(data)
+    .filter((v) => Boolean(v[1]))
+    .reduce((acc, [k, v]) => ({ ...acc, [k]: v }), {});
+
+  return {
+    data,
   };
 };
 
@@ -152,12 +164,12 @@ function eleventyAsciidoctor(convertOptions = {}) {
     return contents;
   };
 
-  const getData = generateGetData(options);
+  const getInstanceFromInputPath = generateGetDataFromInputPath(options);
 
   return {
-    read: false,
-    getData,
     compile,
+    getData: ["data"],
+    getInstanceFromInputPath,
     compileOptions: {
       permalink,
     },

tests/compile.js

@@ -40,30 +40,22 @@ test("Render AsciiDoc with converter options", async (t) => {
   t.is(result, output);
 });
 
-test("Get data from front matter", async (t) => {
-  const processor = eleventyAsciidoc();
-  const result = processor.getData(path.join(sourcePath, "hello.adoc"));
-
-  t.is(result.title, "Hello world");
-  t.is(result.mySlug, "hello-world");
-});
-
 test("Get title from AsciiDoc document title", async (t) => {
   const processor = eleventyAsciidoc();
-  const result = processor.getData(
+  const result = processor.getInstanceFromInputPath(
     path.join(sourcePath, "with-asciidoc-attributes.adoc"),
   );
 
-  t.is(result.title, "Hello world");
+  t.is(result.data.title, "Hello world");
 });
 
 test("Populate data.asciidocAttributes with AsciiDoc attributes", async (t) => {
   const processor = eleventyAsciidoc();
-  const result = processor.getData(
+  const result = processor.getInstanceFromInputPath(
     path.join(sourcePath, "with-asciidoc-attributes.adoc"),
   );
 
-  t.is(result.asciidocAttributes.author, "Jane Doe");
+  t.is(result.data.asciidocAttributes.author, "Jane Doe");
 });
 
 test("Render AsciiDoc in 'unsafe' mode with 'include'", async (t) => {

tests/fixtures/front-matter/front-matter-json.adoc

@@ -0,0 +1,9 @@
+---json
+{
+  "title": "JSON Front Matter",
+  "layout": "base.njk",
+  "permalink": "front-matter-json/index.html"
+}
+---
+
+This text is written in AsciiDoc format.

tests/front-matter.mjs

@@ -38,8 +38,6 @@ test("Permalinks are mapped correctly", async (t) => {
   );
   const json = await elev.toJSON();
 
-  t.is(json.length, 4);
-
   const home = json.find((d) => d.inputPath.endsWith("home.adoc"));
   t.is(home.url, "/");
 
@@ -55,4 +53,22 @@ test("Permalinks are mapped correctly", async (t) => {
     d.inputPath.endsWith("permalink-template.adoc"),
   );
   t.is(permalinkTemplate.url, "/from-page-data.html");
+});
+
+test("JSON front matter parsed", async (t) => {
+  const elev = new Eleventy(
+    "./tests/fixtures/front-matter/",
+    "./tests/fixtures/_site",
+    {
+      configPath: "./tests/fixtures/front-matter/.eleventy.js",
+    },
+  );
+  const json = await elev.toJSON();
+
+  const page = json.find((d) => d.inputPath.endsWith("front-matter-json.adoc"));
+
+  const pageTitle = getHtmlTitle(page.content);
+  t.is(pageTitle, `JSON Front Matter`);
+
+  t.is(page.url, "/front-matter-json/");
 });