eleventy-plugin-asciidoc 3.1.0 → 3.1.2

package/README.md

@@ -1,6 +1,8 @@
 # eleventy-plugin-asciidoc
 
-Eleventy plugin to add support for [AsciiDoc](https://asciidoc.org/). You don't need to use to shortcodes. You can directly use AsciiDoc files (`.adoc`), just like Markdown (`.md`).
+Eleventy plugin to add support for [AsciiDoc](https://asciidoc.org/).
+You don't need to use to shortcodes.
+You can directly use AsciiDoc files (`.adoc`), just like Markdown (`.md`).
 
 The plugin uses [Asciidoctor.js](https://docs.asciidoctor.org/asciidoctor.js) under the hood.
 
@@ -35,7 +37,8 @@ module.exports = function (eleventyConfig) {
 
 ### Customize with Options
 
-You can pass options to `convert()` of Asciidoctor.js as second argument in `addPlugin()`. These are the [available options](https://docs.asciidoctor.org/asciidoctor.js/latest/processor/convert-options/).
+You can pass options to `convert()` of Asciidoctor.js as second argument in `addPlugin()`.
+These are the [available options](https://docs.asciidoctor.org/asciidoctor.js/latest/processor/convert-options/).
 
 ```js
 const eleventyAsciidoc = require("eleventy-plugin-asciidoc");
@@ -52,7 +55,13 @@ module.exports = function (eleventyConfig) {
 
 #### `base_dir`
 
-The `base_dir` of [convert options](https://docs.asciidoctor.org/asciidoctor.js/latest/processor/convert-options/) is relative to the document. This can be changed using above [options](#customize-with-options).
+The `base_dir` of [convert options](https://docs.asciidoctor.org/asciidoctor.js/latest/processor/convert-options/) is relative to the document.
+This can be changed using the above [options](#customize-with-options).
+
+#### `attributes.outdir`
+
+By default, [`attributes.outdir`](https://docs.asciidoctor.org/asciidoc/latest/attributes/document-attributes-ref/#intrinsic-attributes) will be the path to the output directory (`permalink`) of the document.
+This can be changed using the above [options](#customize-with-options).
 
 #### `extension_registry` (⚠️ deprecated)
 
@@ -87,7 +96,8 @@ Refer to [Asciidoctor.js documentation](https://docs.asciidoctor.org/asciidoctor
 
 The plugin does not include any CSS styles. It is up to you to style the content.
 
-The quick way to style the content is to use the CSS file from Asciidoctor.js. The CSS file is [available on cdnjs](https://cdnjs.com/libraries/asciidoctor.js).
+The quickest way to style the content is to use the CSS file from Asciidoctor.js.
+The CSS file is [available on cdnjs](https://cdnjs.com/libraries/asciidoctor.js).
 
 ## Enhancements
 

package/lib/eleventy-asciidoc.js

@@ -7,6 +7,7 @@ const fs = require("fs");
 const matter = require("gray-matter");
 const path = require("path");
 const nunjucks = require("nunjucks");
+const { parseDocumentAttributes } = require("./utils.js");
 
 // @ts-ignore
 const processor = asciidoctor();
@@ -18,21 +19,28 @@ const processor = asciidoctor();
  * Reads a file synchronously.
  *
  * @param      {string}  inputPath  The input path
- * @return     {GrayMatterFile}  { description_of_the_return_value }
+ * @return     {GrayMatterFile}
  */
 const readFileSync = (inputPath) => {
   return matter(fs.readFileSync(inputPath, "utf8"));
 };
 
-/**
+/** @typedef {(inputPath: string) => Object.<string, any>} GetDataFn
  * Gets front-matter data from the file synchronously
+ */
+
+/**
+ * Creates getData function with options initialised.
  *
- * @param      {string}  inputPath  The input path
- * @return     {{ [key: string]: any }}  The data.
+ * @param      {ProcessorOptions}  converterOptions  The converter options
+ * @return     {GetDataFn}
  */
-const getData = (inputPath) => {
+const generateGetData = (converterOptions) => (inputPath) => {
   const { data, content } = readFileSync(inputPath);
-  const doc = processor.load(content);
+  const doc = processor.load(content, {
+    ...converterOptions,
+    base_dir: getBaseDir(inputPath, converterOptions.base_dir),
+  });
   const attributes = doc.getAttributes();
   const title = doc.getDocumentTitle();
   debug(`Document title ${title}`);
@@ -45,6 +53,17 @@ const getData = (inputPath) => {
   };
 };
 
+/**
+ * Gets the base directory if available, otherwise from input path
+ *
+ * @param      {string}  inputPath  The input path
+ * @param      {string=}  base_dir   The base directory
+ * @return     {string}  The base dir.
+ */
+function getBaseDir(inputPath, base_dir) {
+  return base_dir === undefined ? path.dirname(inputPath) : base_dir;
+}
+
 /**
  * Generates Eleventy template renderer for AsciiDoctor
  *
@@ -71,11 +90,32 @@ function eleventyAsciidoctor(convertOptions = {}) {
     const { content } = readFileSync(inputPath);
 
     let { base_dir, configure_extension_registry } = options;
-    base_dir = base_dir === undefined ? path.dirname(inputPath) : base_dir;
+    const attributes = parseDocumentAttributes(options.attributes ?? {});
+    let { outdir } = attributes;
+
+    base_dir = getBaseDir(inputPath, base_dir);
+
+    if (outdir === undefined) {
+      const { page } = data ?? {};
+      const { outputPath } = page ?? {};
+      if (outputPath !== undefined) {
+        outdir = path.dirname(outputPath);
+      }
+    }
+
+    const converterOptions = {
+      ...options,
+      attributes: {
+        ...attributes,
+        outdir,
+      },
+      base_dir,
+    };
 
     if (content) {
       debug(`Converting:\n ${content}`);
       debug(`base_dir: ${base_dir}`);
+      debug(`attributes:\n ${JSON.stringify(attributes)}`);
 
       let registry;
       if (typeof configure_extension_registry === "function") {
@@ -85,13 +125,14 @@ function eleventyAsciidoctor(convertOptions = {}) {
       }
 
       return processor.convert(content, {
-        ...options,
-        base_dir,
+        ...converterOptions,
         extension_registry: registry,
       });
     }
   };
 
+  const getData = generateGetData(options);
+
   return {
     read: false,
     getData,

package/lib/utils.js

@@ -0,0 +1,25 @@
+// @ts-check
+
+/** @typedef {import('@asciidoctor/core').Attributes} Attributes */
+
+/**
+ * Parses AsciiDoc Document attributes into object
+ *
+ * @param      {Attributes | string[] | string}  attrs    AsciiDoc Document Attributes
+ * @return     {Attributes}  Attributes as Object
+ */
+function parseDocumentAttributes(attrs) {
+  if (Array.isArray(attrs)) {
+    return Object.fromEntries(attrs.map((a) => a.split("=")));
+  }
+
+  if (typeof attrs === "string") {
+    return Object.fromEntries([attrs.split("=")]);
+  }
+
+  return attrs;
+}
+
+module.exports = {
+  parseDocumentAttributes,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eleventy-plugin-asciidoc",
-  "version": "3.1.0",
+  "version": "3.1.2",
   "description": "Adds support for AsciiDoc to Eleventy",
   "main": ".eleventy.js",
   "repository": {
@@ -25,23 +25,23 @@
     "compatibility": ">=1.0.0"
   },
   "dependencies": {
-    "@asciidoctor/core": "^3.0.2",
+    "@asciidoctor/core": "^3.0.4",
     "debug": "^4.3.4",
     "gray-matter": "^4.0.3",
     "nunjucks": "^3.2.4"
   },
   "devDependencies": {
     "@11ty/eleventy": "^2.0.1",
-    "ava": "^5.3.1",
-    "eslint": "^8.45.0",
-    "eslint-config-prettier": "^8.9.0",
-    "eslint-config-xo-space": "^0.34.0",
-    "eslint-plugin-prettier": "^5.0.0",
-    "husky": "^8.0.3",
-    "lint-staged": "^13.2.3",
+    "ava": "^6.1.1",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "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.0.0",
-    "rimraf": "^5.0.1"
+    "prettier": "^3.2.5",
+    "rimraf": "^5.0.5"
   },
   "lint-staged": {
     "*.js": "eslint --cache --fix --ignore-pattern \"!.eleventy.js\"",
@@ -53,8 +53,10 @@
       "!tests/fixtures/",
       "!tests/utils.js"
     ],
-    "ignoredByWatcher": [
-      "tests/output/**"
-    ]
+    "watchMode": {
+      "ignoreChanges": [
+        "tests/output/**"
+      ]
+    }
   }
 }