eleventy-plugin-asciidoc 1.1.0 → 1.2.0

package/.eleventy.js

@@ -1,13 +1,16 @@
 const eleventyAsciidoc = require("./lib/eleventy-asciidoc.js");
 
+/** @typedef {import('./lib/eleventy-asciidoc.js').ProcessorOptions} ProcessorOptions} */
+
 module.exports = {
   /**
    * Plugin config function
    *
-   * @param      {Object}  eleventy     The eleventy configuration object
+   * @param      {object}            eleventyConfig     The eleventy configuration object
+   * @param      {ProcessorOptions}  converterOptions   Options for Asciidoctor.converter()
    */
-  configFunction(eleventyConfig, userOptions) {
+  configFunction(eleventyConfig, converterOptions) {
     eleventyConfig.addTemplateFormats("adoc");
-    eleventyConfig.addExtension("adoc", eleventyAsciidoc(userOptions));
+    eleventyConfig.addExtension("adoc", eleventyAsciidoc(converterOptions));
   },
 };

package/README.md

@@ -1,9 +1,18 @@
 # eleventy-plugin-asciidoc
 
-Eleventy plugin to add support for AsciiDoc. The plugin uses [Asciidoctor.js](https://docs.asciidoctor.org/asciidoctor.js) under the hood.
+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.
 
 **Requires Eleventy `1.0.0` or newer.**
 
+## Features
+
+- Supports the default [YAML front matter](https://www.11ty.dev/docs/data-frontmatter/).
+- Supports [AsciiDoc document title](https://docs.asciidoctor.org/asciidoc/latest/document/title/#title-syntax)
+- Other attributes in the AsciiDoc file are made available in `page.asciidocAttributes`.
+  - Example `:author: Jane Doe` in the `.adoc` file will be available in `page.asciidocAttrbutes.author`
+
 ## Usage
 
 ### Install
@@ -33,9 +42,8 @@ const eleventyAsciidoc = require("eleventy-plugin-asciidoc");
 
 module.exports = function (eleventyConfig) {
   eleventyConfig.addPlugin(eleventyAsciidoc, {
-    /* Converter options */
-    showtitle: true,
-    safe: "unsafe",
+    showtitle: true /* Default value: true */,
+    safe: "unsafe" /* Default value: undefined */,
   });
 };
 ```

package/lib/eleventy-asciidoc.js

@@ -1,22 +1,57 @@
 // @ts-check
 
 const asciidoctor = require("asciidoctor").default();
-const debug = require("debug")("eleventy-asciidoc");
-
-const nunjucks = require("nunjucks");
+const debug = require("debug")("eleventy-plugin-asciidoc");
 const fs = require("fs");
 const matter = require("gray-matter");
+const nunjucks = require("nunjucks");
+
+/** @typedef {import('asciidoctor').Asciidoctor.ProcessorOptions} ProcessorOptions */
+/** @typedef {import('gray-matter').GrayMatterFile}  GrayMatterFile */
 
-function eleventyAsciidoctor(options = {}) {
-  debug("Options: ", options);
-  const readFileSync = (inputPath) => {
-    return matter(fs.readFileSync(inputPath, "utf8"));
+/**
+ * Reads a file synchronously.
+ *
+ * @param      {string}  inputPath  The input path
+ * @return     {GrayMatterFile}  { description_of_the_return_value }
+ */
+const readFileSync = (inputPath) => {
+  return matter(fs.readFileSync(inputPath, "utf8"));
+};
+
+/**
+ * Gets front-matter data from the file synchronously
+ *
+ * @param      {string}  inputPath  The input path
+ * @return     {{ [key: string]: any }}  The data.
+ */
+const getData = (inputPath) => {
+  const { data, content } = readFileSync(inputPath);
+  const doc = asciidoctor.load(content);
+  const attributes = doc.getAttributes();
+  const title = doc.getDocumentTitle();
+  debug(`Document title ${title}`);
+  debug(`Document attributes: ${attributes}`);
+
+  return {
+    title,
+    asciidocAttributes: attributes,
+    ...data,
   };
+};
 
-  const getData = (inputPath) => {
-    const { data } = readFileSync(inputPath);
+/**
+ * Generates Eleventy template renderer for AsciiDoctor
+ *
+ * @param      {ProcessorOptions=}  convertOptions Options for Asciidoctor.converter()
+ * @return     {Object}             Eleventy data processor object
+ */
+function eleventyAsciidoctor(convertOptions = {}) {
+  debug("Converter options: ", convertOptions);
 
-    return data;
+  const options = {
+    showtitle: true,
+    ...convertOptions,
   };
 
   const compile = (str) => (data) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eleventy-plugin-asciidoc",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Adds support for AsciiDoc to Eleventy",
   "main": ".eleventy.js",
   "repository": {
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "lint": "eslint lib/**.js tests/**.js",
-    "test": "nyc ava --timeout=1m -v --color",
+    "test": "nyc ava -v --color",
     "prepare": "husky install"
   },
   "keywords": [