eleventy-plugin-asciidoc 5.0.1 → 6.0.0

package/.eslintrc.cjs

@@ -0,0 +1,11 @@
+module.exports = {
+  root: true,
+  extends: ["xo-space", "plugin:prettier/recommended"],
+  plugins: ["prettier"],
+  rules: {
+    "prettier/prettier": "error",
+  },
+  env: {
+    browser: true,
+  },
+};

package/README.md

@@ -35,7 +35,7 @@ module.exports = function (eleventyConfig) {
 };
 ```
 
-### Front Matter
+## Front Matter
 
 You can use either [Eleventy style front matter](https://www.11ty.dev/docs/data-frontmatter/#front-matter-formats) or AsciiDoc document attributes to write front matter.
 
@@ -68,7 +68,7 @@ Hello everyone!
 > [!WARNING]
 > Asciidoctor.js converts all attribute names to lower case letters. Example `:eleventy-aTitle:` will be made available as `atitle` in front matter data (also as `eleventy-atitle` in document attributes).
 
-#### Data Cascade
+### Data Cascade
 
 Data specified using AsciiDoc style front matter override YAML (or front matter in other Eleventy supported formats).
 
@@ -87,9 +87,36 @@ In the above case, front matter data will have `{ layout: layout-b.njk }`.
 
 In the case of `title`, [the AsciiDoc document title](https://docs.asciidoctor.org/asciidoc/latest/document/title/) (including `title` and `doctitle` attributes) takes precedence over front matter.
 
-### Customize with Options
+## Options
+
+You can pass options as the second argument in `addPlugin()`.
+
+### Options for this plugin
+
+#### `eleventyAttributesPrefix`
+
+Default value is `eleventy-`.
+
+This config can be used to change the prefix string for [AsciiDoc style front matter](#front-matter).
+
+#### `resolveDocumentTitle`
+
+Default value is `false`.
+
+If enabled, the title will be resolved from the heading of the first section in the document. Otherwise, the title will be the Level 0 heading.
+
+```adoc
+== A second level heading
+
+This text is written in AsciiDoc format.
+```
+
+With `resolveDocumentTitle: true`, the above document will have a title (in page data). `A second level heading`.
+
+### Options for Asciidoctor.js
+
+All properties other than [the ones specific to the plugin](#options-for-this-plugin) will be passed to Asciidoctor.js.
 
-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
@@ -144,12 +171,6 @@ module.exports = function (eleventyConfig) {
 
 Refer to [Asciidoctor.js documentation](https://docs.asciidoctor.org/asciidoctor.js/latest/extend/extensions/) to know more about extensions.
 
-#### `eleventyAttributesPrefix`
-
-Default value is `eleventy-`.
-
-This config can be used to change the prefix string for [AsciiDoc style front matter](#front-matter).
-
 ### CSS Styles
 
 The plugin does not include any CSS styles. It is up to you to style the content.

package/index.js

@@ -1,35 +1,24 @@
 // @ts-check
-const eleventyAsciidoc = require("./lib/eleventy-asciidoc.js");
-const pkg = require("./package.json");
+import eleventyAsciidoc from "./lib/eleventy-asciidoc.js";
 
 /** @typedef {import('./lib/eleventy-asciidoc.js').EleventyAsciidocOptions} EleventyAsciidocOptions} */
 
-module.exports = {
-  /**
-   * Plugin config function
-   *
-   * @param      {object}            eleventyConfig     The eleventy configuration object
-   * @param      {EleventyAsciidocOptions}  converterOptions   Options for Asciidoctor.converter()
-   */
-  configFunction(eleventyConfig, converterOptions) {
-    try {
-      eleventyConfig.versionCheck(pkg["11ty"].compatibility);
-    } catch (e) {
-      console.log(
-        `WARN: Eleventy Plugin (${pkg.name}) Compatibility: ${e.message}`,
-      );
-    }
-
-    if (converterOptions?.extension_registry !== undefined) {
-      console.log(
-        `WARN: 'extension_registry' doesn't work well with Asciidoctor.js v3+. Use 'configure_extension_registry'.`,
-      );
-    }
-
-    eleventyConfig.addTemplateFormats(["adoc", "asciidoc", "ad"]);
-    eleventyConfig.addExtension(
-      ["adoc", "asciidoc", "ad"],
-      eleventyAsciidoc(converterOptions),
+/**
+ * Plugin config function
+ *
+ * @param      {object}            eleventyConfig     The eleventy configuration object
+ * @param      {EleventyAsciidocOptions}  converterOptions   Options for Asciidoctor.converter()
+ */
+export default function config(eleventyConfig, converterOptions) {
+  if (converterOptions?.extension_registry !== undefined) {
+    console.log(
+      `WARN: 'extension_registry' doesn't work well with Asciidoctor.js v3+. Use 'configure_extension_registry'.`,
     );
-  },
-};
+  }
+
+  eleventyConfig.addTemplateFormats(["adoc", "asciidoc", "ad"]);
+  eleventyConfig.addExtension(
+    ["adoc", "asciidoc", "ad"],
+    eleventyAsciidoc(converterOptions),
+  );
+}

package/lefthook.yml

@@ -0,0 +1,16 @@
+pre-commit:
+  commands:
+    # Prettier for JS is included in ESlint
+    prettier:
+      glob: "*.{md,json}"
+      run: npx prettier --write {staged_files}
+      stage_fixed: true
+
+    eslint:
+      glob: "*.{js,mjs,cjs}"
+      run: npx eslint --fix {staged_files}
+      stage_fixed: true
+
+    tests:
+      glob: "*.{js,mjs,cjs}"
+      run: npm run test

package/lib/eleventy-asciidoc.js

@@ -1,35 +1,55 @@
 // @ts-check
 /* eslint camelcase: ["error", {allow: ["base_dir", "extension_registry", "configure_extension_registry"]}] */
 
-const asciidoctor = require("@asciidoctor/core");
-const debug = require("debug")("eleventy-plugin-asciidoc");
-const fs = require("fs");
-const matter = require("gray-matter");
-const path = require("path");
-const nunjucks = require("nunjucks");
-const { parseDocumentAttributes } = require("./utils/asciidoc.js");
-const { pickByKeyPrefix, mapKeys, pick } = require("./utils/object.js");
-
-// @ts-ignore
-const processor = asciidoctor();
+import { load, Extensions, convert } from "@asciidoctor/core";
+import libDebug from "debug";
+import fs from "node:fs/promises";
+import matter from "gray-matter";
+import path from "path";
+import nunjucks from "nunjucks";
+import { parseDocumentAttributes } from "./utils/asciidoc.js";
+import { pickByKeyPrefix, mapKeys, pick } from "./utils/object.js";
+
+const debug = libDebug("eleventy-plugin-asciidoc");
 
 /** @typedef {import('gray-matter').GrayMatterFile}  GrayMatterFile */
 
 /**
  * @typedef {Object} ExtraProcessorOptions
  * @property {string=} eleventyAttributesPrefix
+ * @property {Boolean} [resolveDocumentTitle=false]
  * @typedef {import('@asciidoctor/core').ProcessorOptions & ExtraProcessorOptions} EleventyAsciidocOptions
  */
 
 /**
- * Reads a file synchronously.
+ * Reads files and separates front matter and content asynchronously.
  *
- * @param      {string}  inputPath  The input path
- * @return     {GrayMatterFile}
+ * @param      {string}   inputPath  Path to file
+ * @return     {Promise<GrayMatterFile>}
+ */
+async function readFileAsync(inputPath) {
+  try {
+    const fileContent = await fs.readFile(inputPath);
+    return matter(fileContent);
+  } catch (e) {
+    throw new Error(`Unable to read path. ${e.error}`);
+  }
+}
+
+/**
+ * Gets the title from ascii document document.
+ *
+ * @param      {object}   document         The document
+ * @param      {boolean}  [resolve=false]  The resolve
+ * @return     {string | undefined}   The title of the document.
  */
-const readFileSync = (inputPath) => {
-  return matter(fs.readFileSync(inputPath, "utf8"));
-};
+function getTitleFromAsciiDocDocument(document, resolve = false) {
+  if (resolve) {
+    return document.getDocumentTitle();
+  }
+
+  return document.getHeader()?.title;
+}
 
 /** @typedef {(inputPath: string) => Object.<string, any>} GetDataFn
  * Gets front-matter data from the file synchronously
@@ -42,46 +62,54 @@ const readFileSync = (inputPath) => {
  * @return     {GetDataFn}
  */
 
-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 title = doc.getDocumentTitle();
-  const attributes = doc.getAttributes();
-
-  let eleventyAttributes = pickByKeyPrefix(
-    attributes,
-    eleventyAttributesPrefix,
-  );
-  eleventyAttributes = mapKeys(eleventyAttributes, (k) =>
-    k.slice(eleventyAttributesPrefix.length),
-  );
-
-  debug(`Document title ${title}`);
-  debug(`Document attributes: ${JSON.stringify(attributes)}`);
-  debug(`Document Eleventy attributes: ${JSON.stringify(eleventyAttributes)}`);
-
-  let data = {
-    asciidocAttributes: attributes,
-    ...eleventyAttributes,
-    // Pass title only if defined. Otherwise, `undefined`
-    // will override the title in `eleventyAttributes`
-    ...(title === undefined ? {} : { title }),
-  };
+const generateGetDataFromInputPath =
+  (converterOptions) => async (inputPath) => {
+    const { content } = await readFileAsync(inputPath);
+    const {
+      eleventyAttributesPrefix = "eleventy-",
+      resolveDocumentTitle = false,
+      ...restOfConverterOptions
+    } = converterOptions;
+
+    const doc = await load(content, {
+      ...restOfConverterOptions,
+      base_dir: getBaseDir(inputPath, restOfConverterOptions.base_dir),
+    });
+
+    const title = getTitleFromAsciiDocDocument(doc, resolveDocumentTitle);
+
+    const attributes = doc.getAttributes();
+
+    let eleventyAttributes = pickByKeyPrefix(
+      attributes,
+      eleventyAttributesPrefix,
+    );
+    eleventyAttributes = mapKeys(eleventyAttributes, (k) =>
+      k.slice(eleventyAttributesPrefix.length),
+    );
+
+    debug(`Document title ${title}`);
+    debug(`Document attributes: ${JSON.stringify(attributes)}`);
+    debug(
+      `Document Eleventy attributes: ${JSON.stringify(eleventyAttributes)}`,
+    );
+
+    let data = {
+      asciidocAttributes: attributes,
+      ...eleventyAttributes,
+      // Pass title only if defined. Otherwise, `undefined`
+      // will override the title in `eleventyAttributes`
+      ...(title === undefined ? {} : { title }),
+    };
 
-  // Removes undefined values
-  // that may override Eleventy page data.
-  data = pick(data, (k, v) => v !== undefined);
+    // Removes undefined values
+    // that may override Eleventy page data.
+    data = pick(data, (k, v) => v !== undefined);
 
-  return {
-    data,
+    return {
+      data,
+    };
   };
-};
 
 /**
  * Gets the base directory if available, otherwise from input path
@@ -107,9 +135,9 @@ function eleventyAsciidoctor(convertOptions = {}) {
     ...convertOptions,
   };
 
-  const compile = (_contents, inputPath) => (data) => {
+  const compile = (_contents, inputPath) => async (data) => {
     debug(`Reading ${inputPath}`);
-    const { content } = readFileSync(inputPath);
+    const { content } = await readFileAsync(inputPath);
 
     let { base_dir, configure_extension_registry } = options;
     const attributes = parseDocumentAttributes(options.attributes ?? {});
@@ -145,11 +173,11 @@ function eleventyAsciidoctor(convertOptions = {}) {
       let registry;
       if (typeof configure_extension_registry === "function") {
         debug(`Creating an extension registry`);
-        registry = processor.Extensions.create();
+        registry = Extensions.create();
         configure_extension_registry(registry);
       }
 
-      return processor.convert(content, {
+      return convert(content, {
         ...converterOptions,
         extension_registry: registry,
       });
@@ -181,4 +209,4 @@ function eleventyAsciidoctor(convertOptions = {}) {
   };
 }
 
-module.exports = eleventyAsciidoctor;
+export default eleventyAsciidoctor;

package/lib/utils/asciidoc.js

@@ -8,7 +8,7 @@
  * @param      {Attributes | string[] | string}  attrs    AsciiDoc Document Attributes
  * @return     {Attributes}  Attributes as Object
  */
-function parseDocumentAttributes(attrs) {
+export function parseDocumentAttributes(attrs) {
   if (Array.isArray(attrs)) {
     return Object.fromEntries(attrs.map((a) => a.split("=")));
   }
@@ -19,7 +19,3 @@ function parseDocumentAttributes(attrs) {
 
   return attrs;
 }
-
-module.exports = {
-  parseDocumentAttributes,
-};

package/lib/utils/object.js

@@ -7,7 +7,7 @@
  * @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, v) => Boolean(v)) {
+export function pick(obj, keys = (_k, v) => Boolean(v)) {
   if (Array.isArray(keys)) {
     return pick(obj, (key) => keys.includes(key));
   }
@@ -31,7 +31,7 @@ function pick(obj, keys = (_k, v) => Boolean(v)) {
  * @param      {string}  prefix  The key prefix
  * @return     {object}  Copy of the object with filtered values
  */
-function pickByKeyPrefix(obj, prefix) {
+export function pickByKeyPrefix(obj, prefix) {
   return pick(obj, (k) => k.startsWith(prefix));
 }
 
@@ -42,7 +42,7 @@ function pickByKeyPrefix(obj, prefix) {
  * @param      {(k: string, v: any)=> string}  [mapKey=(k)=>k]  The function to map the keys
  * @return     {object}    { Copy of the object with mapped keys }
  */
-function mapKeys(obj, mapKey = (k) => k) {
+export function mapKeys(obj, mapKey = (k) => k) {
   return Object.entries(obj).reduce((acc, [k, v]) => {
     const newKey = mapKey(k, v);
     return {
@@ -51,9 +51,3 @@ function mapKeys(obj, mapKey = (k) => k) {
     };
   }, {});
 }
-
-module.exports = {
-  pickByKeyPrefix,
-  pick,
-  mapKeys,
-};

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "eleventy-plugin-asciidoc",
-  "version": "5.0.1",
+  "version": "6.0.0",
   "description": "Adds support for AsciiDoc to Eleventy",
   "main": "index.js",
+  "type": "module",
   "funding": "https://github.com/sponsors/saneef/",
   "repository": {
     "type": "git",
@@ -10,8 +11,7 @@
   },
   "scripts": {
     "lint": "eslint lib/**.js tests/**.js",
-    "test": "nyc ava -v --color",
-    "prepare": "husky install"
+    "test": "ava -v --color"
   },
   "keywords": [
     "asciidoc",
@@ -22,31 +22,22 @@
   ],
   "author": "Saneef Ansari <hello@saneef.com> (https://saneef.com/)",
   "license": "MIT",
-  "11ty": {
-    "compatibility": ">=2.0.0-canary.19"
-  },
   "dependencies": {
-    "@asciidoctor/core": "^3.0.4",
-    "debug": "^4.4.0",
+    "@asciidoctor/core": "^4.0.0",
+    "debug": "^4.4.3",
     "gray-matter": "^4.0.3",
     "nunjucks": "^3.2.4"
   },
   "devDependencies": {
-    "@11ty/eleventy": "^3.0.0",
-    "ava": "^6.2.0",
+    "@11ty/eleventy": "^3.1.6",
+    "ava": "^8.0.1",
     "eslint": "^8.56.0",
-    "eslint-config-prettier": "^10.0.1",
+    "eslint-config-prettier": "^10.1.8",
     "eslint-config-xo-space": "^0.35.0",
-    "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,mjs,cjs}": "eslint --cache --fix",
-    "*.{js,md,json}": "prettier --write"
+    "eslint-plugin-prettier": "^5.5.6",
+    "lefthook": "^2.1.9",
+    "prettier": "^3.9.4",
+    "rimraf": "^6.1.3"
   },
   "ava": {
     "files": [