eleventy-plugin-asciidoc 4.0.2 → 5.0.0-alpha.0

package/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 = {}) {
@@ -77,15 +90,7 @@ function eleventyAsciidoctor(convertOptions = {}) {
     ...convertOptions,
   };
 
-  const compile = (str, inputPath) => (data) => {
-    if (str) {
-      // So if str has a value, it's a permalink (which can be a string or a function)
-      debug(`Permalink: ${str}`);
-      return typeof str === "function"
-        ? str(data)
-        : nunjucks.renderString(str, data);
-    }
-
+  const compile = (_contents, inputPath) => (data) => {
     debug(`Reading ${inputPath}`);
     const { content } = readFileSync(inputPath);
 
@@ -134,12 +139,28 @@ function eleventyAsciidoctor(convertOptions = {}) {
     }
   };
 
+  const permalink = function (contents, _inputPath) {
+    if (contents && typeof contents === "string") {
+      return async (data) => {
+        const permalink = nunjucks.renderString(contents, data);
+        debug("permalink: ", permalink);
+        return permalink;
+      };
+    }
+
+    // Fallbacks to Eleventy default behaviour
+    return contents;
+  };
+
   const getData = generateGetData(options);
 
   return {
     read: false,
     getData,
     compile,
+    compileOptions: {
+      permalink,
+    },
   };
 }
 

package/lib/utils.js

@@ -20,6 +20,49 @@ function parseDocumentAttributes(attrs) {
   return attrs;
 }
 
+/**
+ * Return a copy of the object, filtered to only have values for the allowed keys (or array of valid keys). Alternatively accepts a predicate indicating which keys to pick.
+ *
+ * @param      {object}  obj  The object
+ * @param      {(key: string, value: any, obj: object ) => boolean | Array<string>}  keys    The keys
+ * @return     {object}  Copy of the object with filtered values
+ */
+function pick(obj, keys = (k) => Boolean(k)) {
+  if (Array.isArray(keys)) {
+    return pick(obj, (key) => keys.includes(key));
+  }
+
+  return Object.keys(obj).reduce((acc, k) => {
+    if (keys(k, obj[k], obj)) {
+      return {
+        [k]: obj[k],
+        ...acc,
+      };
+    }
+
+    return acc;
+  }, {});
+}
+
+/**
+ * Picks keys with matching prefix and removes prefix from keys
+ *
+ * @param      {object}  obj  The objec
+ * @param      {string}  prefix  The key prefix
+ * @return     {object}  Copy of the object with filtered values
+ */
+function pickByKeyPrefix(obj, prefix) {
+  const filteredObj = pick(obj, (k) => k.startsWith(prefix));
+  return Object.entries(filteredObj).reduce((acc, [k, v]) => {
+    return {
+      [k.slice(prefix.length)]: v,
+      ...acc,
+    };
+  }, {});
+}
+
 module.exports = {
   parseDocumentAttributes,
+  pickByKeyPrefix,
+  pick,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eleventy-plugin-asciidoc",
-  "version": "4.0.2",
+  "version": "5.0.0-alpha.0",
   "description": "Adds support for AsciiDoc to Eleventy",
   "main": ".eleventy.js",
   "funding": "https://github.com/sponsors/saneef/",
@@ -27,22 +27,22 @@
   },
   "dependencies": {
     "@asciidoctor/core": "^3.0.4",
-    "debug": "^4.3.4",
+    "debug": "^4.4.0",
     "gray-matter": "^4.0.3",
     "nunjucks": "^3.2.4"
   },
   "devDependencies": {
-    "@11ty/eleventy": "^2.0.1",
-    "ava": "^6.1.1",
+    "@11ty/eleventy": "^3.0.0",
+    "ava": "^6.2.0",
     "eslint": "^8.56.0",
-    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-prettier": "^10.0.1",
     "eslint-config-xo-space": "^0.35.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "husky": "^9.0.11",
-    "lint-staged": "^15.2.2",
-    "nyc": "^15.1.0",
-    "prettier": "^3.2.5",
-    "rimraf": "^5.0.5"
+    "eslint-plugin-prettier": "^5.2.3",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.4.3",
+    "nyc": "^17.1.0",
+    "prettier": "^3.5.2",
+    "rimraf": "^6.0.1"
   },
   "lint-staged": {
     "*.js": "eslint --cache --fix --ignore-pattern \"!.eleventy.js\"",