@antora/document-converter 3.0.0-beta.4 → 3.0.0-rc.2

package/lib/convert-document.js

@@ -1,22 +1,16 @@
 'use strict'
 
-const {
-  loadAsciiDoc: _loadAsciiDoc,
-  extractAsciiDocMetadata: _extractAsciiDocMetadata,
-} = require('@antora/asciidoc-loader')
-
 /**
  * Converts the contents on the specified file from AsciiDoc to embedded HTML.
  *
- * It first delegates to the AsciiDoc Loader to load the AsciiDoc contents on
- * the specified virtual file to a Document object. It then grabs the document
- * attributes from that Document and assigns them to the asciidoc.attributes
- * property on the file. If the document has a document header, it assigns the
- * doctitle, xreftext, and navtitle to the asciidoc property on that file. If
- * the page-partial attributes is set, it backs up the AsciiDoc source on the
- * src.contents property. It then converts the Document to embedded HTML, wraps
- * it in a Buffer, and assigns it to the contents property on the file. Finally,
- * the mediaType property is updated to 'text/html'.
+ * This function first delegates to the AsciiDoc loader to load the AsciiDoc contents on the
+ * specified virtual file to a Document object. If the asciidoc property is not set on the virtual
+ * file, it then extracts the metadata from that document and assigns it to the asciidoc property.
+ * This metadata includes the document attributes, doctitle, xreftext, and navtitle. If the
+ * keepSource option on the AsciiDoc config is true or the page-partial attributes is set, it backs
+ * up the AsciiDoc source to the src.contents property. It then converts the Document to embedded
+ * HTML, wraps it in a Buffer, and assigns it to the contents property on the file. Finally, it
+ * updates the mediaType property on the file to 'text/html'.
  *
  * @memberof document-converter
  *
@@ -27,9 +21,10 @@ const {
  * @returns {File} The virtual file that was converted.
  */
 function convertDocument (file, contentCatalog = undefined, asciidocConfig = {}) {
-  const { extractAsciiDocMetadata = _extractAsciiDocMetadata, loadAsciiDoc = _loadAsciiDoc } = this
-    ? this.getFunctions(false)
-    : {}
+  const {
+    extractAsciiDocMetadata = requireAsciiDocLoader().extractAsciiDocMetadata,
+    loadAsciiDoc = requireAsciiDocLoader(),
+  } = this ? this.getFunctions(false) : {}
   const doc = loadAsciiDoc(file, contentCatalog, asciidocConfig)
   if (!file.asciidoc) {
     file.asciidoc = extractAsciiDocMetadata(doc)
@@ -40,4 +35,8 @@ function convertDocument (file, contentCatalog = undefined, asciidocConfig = {})
   return file
 }
 
+function requireAsciiDocLoader () {
+  return requireAsciiDocLoader.cache || (requireAsciiDocLoader.cache = require('@antora/asciidoc-loader'))
+}
+
 module.exports = convertDocument

package/lib/convert-documents.js

@@ -1,10 +1,6 @@
 'use strict'
 
 const _convertDocument = require('./convert-document')
-const {
-  loadAsciiDoc: _loadAsciiDoc,
-  extractAsciiDocMetadata: _extractAsciiDocMetadata,
-} = require('@antora/asciidoc-loader')
 
 /**
  * Converts the contents of publishable pages with the media type text/asciidoc
@@ -31,8 +27,8 @@ const {
 function convertDocuments (contentCatalog, siteAsciiDocConfig = {}) {
   const {
     convertDocument = _convertDocument,
-    extractAsciiDocMetadata = _extractAsciiDocMetadata,
-    loadAsciiDoc = _loadAsciiDoc,
+    extractAsciiDocMetadata = requireAsciiDocLoader().extractAsciiDocMetadata,
+    loadAsciiDoc = requireAsciiDocLoader(),
   } = this ? this.getFunctions(false) : {}
   const mainAsciiDocConfigs = new Map()
   contentCatalog.getComponents().forEach(({ name: component, versions }) => {
@@ -85,4 +81,8 @@ function registerPageAliases (aliases, targetFile, contentCatalog) {
     .forEach((spec) => (spec = spec.trim()) && contentCatalog.registerPageAlias(spec, targetFile))
 }
 
+function requireAsciiDocLoader () {
+  return requireAsciiDocLoader.cache || (requireAsciiDocLoader.cache = require('@antora/asciidoc-loader'))
+}
+
 module.exports = Object.assign(convertDocuments, { convertDocuments, convertDocument: _convertDocument })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/document-converter",
-  "version": "3.0.0-beta.4",
+  "version": "3.0.0-rc.2",
   "description": "Converts AsciiDoc documents to embeddable HTML for use in an Antora documentation pipeline.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -16,8 +16,11 @@
     "url": "https://gitlab.com/antora/antora/issues"
   },
   "main": "lib/index.js",
+  "scripts": {
+    "test": "_mocha"
+  },
   "dependencies": {
-    "@antora/asciidoc-loader": "3.0.0-beta.4"
+    "@antora/asciidoc-loader": "3.0.0-rc.2"
   },
   "engines": {
     "node": ">=12.21.0"
@@ -35,6 +38,5 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "8a142499e9f1a9e0631777796e06dd6c010d3a90",
-  "readmeFilename": "README.md"
+  "gitHead": "b64861391b7e55ea31fcecce4490b9cc02fec1c7"
 }