eleventy-plugin-asciidoc 3.0.0 → 3.1.0

package/.eleventy.js

@@ -1,4 +1,6 @@
+// @ts-check
 const eleventyAsciidoc = require("./lib/eleventy-asciidoc.js");
+const pkg = require("./package.json");
 
 /** @typedef {import('./lib/eleventy-asciidoc.js').ProcessorOptions} ProcessorOptions} */
 
@@ -10,6 +12,20 @@ module.exports = {
    * @param      {ProcessorOptions}  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");
     eleventyConfig.addExtension("adoc", eleventyAsciidoc(converterOptions));
   },

package/README.md

@@ -33,7 +33,7 @@ module.exports = function (eleventyConfig) {
 };
 ```
 
-#### Customize with Options
+### 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/).
 
@@ -50,10 +50,39 @@ module.exports = function (eleventyConfig) {
 };
 ```
 
-##### `base_dir`
+#### `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).
 
+#### `extension_registry` (⚠️ deprecated)
+
+The convert option `extension_registry` **will not work** as intended from Asciidoctor.js v3.0 onwards.
+The `extension_registry` needs a newly created registry for each conversion.
+Use [the `configure_extension_registry`](#configure_extension_registry) function instead.
+
+#### `configure_extension_registry`
+
+The `configure_extension_registry` should be a function which accepts a `registry` (instance of `Extensions.Registry`).
+During each file conversion, the function will be called with a new `registry`.
+This `registry` instance can be used to register extensions.
+
+```js
+const eleventyAsciidoc = require("eleventy-plugin-asciidoc");
+const myExtension = require("./my-extension.js");
+
+module.exports = function (eleventyConfig) {
+  eleventyConfig.addPlugin(eleventyAsciidoc, {
+    configure_extension_registry(registry) {
+      myExtension.register(registry);
+      // Or, myExtension(registry) depending on how
+      // you have programmed your extension.
+    },
+  });
+};
+```
+
+Refer to [Asciidoctor.js documentation](https://docs.asciidoctor.org/asciidoctor.js/latest/extend/extensions/) to know more about extensions.
+
 ### CSS Styles
 
 The plugin does not include any CSS styles. It is up to you to style the content.

package/lib/eleventy-asciidoc.js

@@ -1,5 +1,5 @@
 // @ts-check
-/* eslint camelcase: ["error", {allow: ["base_dir"]}] */
+/* eslint camelcase: ["error", {allow: ["base_dir", "extension_registry", "configure_extension_registry"]}] */
 
 const asciidoctor = require("@asciidoctor/core");
 const debug = require("debug")("eleventy-plugin-asciidoc");
@@ -11,7 +11,7 @@ const nunjucks = require("nunjucks");
 // @ts-ignore
 const processor = asciidoctor();
 
-/** @typedef {import('asciidoctor').ProcessorOptions} ProcessorOptions */
+/** @typedef {import('@asciidoctor/core').ProcessorOptions} ProcessorOptions */
 /** @typedef {import('gray-matter').GrayMatterFile}  GrayMatterFile */
 
 /**
@@ -70,13 +70,25 @@ function eleventyAsciidoctor(convertOptions = {}) {
     debug(`Reading ${inputPath}`);
     const { content } = readFileSync(inputPath);
 
-    let { base_dir } = options;
+    let { base_dir, configure_extension_registry } = options;
     base_dir = base_dir === undefined ? path.dirname(inputPath) : base_dir;
 
     if (content) {
       debug(`Converting:\n ${content}`);
       debug(`base_dir: ${base_dir}`);
-      return processor.convert(content, { ...options, base_dir });
+
+      let registry;
+      if (typeof configure_extension_registry === "function") {
+        debug(`Creating an extension registry`);
+        registry = processor.Extensions.create();
+        configure_extension_registry(registry);
+      }
+
+      return processor.convert(content, {
+        ...options,
+        base_dir,
+        extension_registry: registry,
+      });
     }
   };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eleventy-plugin-asciidoc",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Adds support for AsciiDoc to Eleventy",
   "main": ".eleventy.js",
   "repository": {
@@ -21,18 +21,22 @@
   ],
   "author": "Saneef Ansari <hello@saneef.com> (https://saneef.com/)",
   "license": "MIT",
+  "11ty": {
+    "compatibility": ">=1.0.0"
+  },
   "dependencies": {
-    "asciidoctor": "^3.0.2",
+    "@asciidoctor/core": "^3.0.2",
     "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.44.0",
-    "eslint-config-prettier": "^8.8.0",
+    "eslint": "^8.45.0",
+    "eslint-config-prettier": "^8.9.0",
     "eslint-config-xo-space": "^0.34.0",
-    "eslint-plugin-prettier": "^5.0.0-alpha.1",
+    "eslint-plugin-prettier": "^5.0.0",
     "husky": "^8.0.3",
     "lint-staged": "^13.2.3",
     "nyc": "^15.1.0",
@@ -40,12 +44,13 @@
     "rimraf": "^5.0.1"
   },
   "lint-staged": {
-    "*.js": "eslint --cache --fix",
+    "*.js": "eslint --cache --fix --ignore-pattern \"!.eleventy.js\"",
     "*.{js,md,json}": "prettier --write"
   },
   "ava": {
     "files": [
       "tests/**/*",
+      "!tests/fixtures/",
       "!tests/utils.js"
     ],
     "ignoredByWatcher": [