@antora/document-converter 3.0.0-alpha.9 → 3.0.0-beta.4

package/README.md

@@ -3,7 +3,7 @@
 The Document Converter is a component in Antora responsible for converting AsciiDoc documents to embeddable HTML for use in an Antora documentation pipeline.
 
 [Antora](https://antora.org) is a modular static site generator designed for creating documentation sites from AsciiDoc documents.
-Its site generator pipeline aggregates documents from versioned content repositories and processes them using [Asciidoctor](https://asciidoctor.org).
+Its site generator aggregates documents from versioned content repositories and processes them using [Asciidoctor](https://asciidoctor.org).
 
 ## Copyright and License
 

package/lib/convert-document.js

@@ -1,6 +1,9 @@
 'use strict'
 
-const { loadAsciiDoc, extractAsciiDocMetadata } = require('@antora/asciidoc-loader')
+const {
+  loadAsciiDoc: _loadAsciiDoc,
+  extractAsciiDocMetadata: _extractAsciiDocMetadata,
+} = require('@antora/asciidoc-loader')
 
 /**
  * Converts the contents on the specified file from AsciiDoc to embedded HTML.
@@ -24,10 +27,13 @@ const { loadAsciiDoc, extractAsciiDocMetadata } = require('@antora/asciidoc-load
  * @returns {File} The virtual file that was converted.
  */
 function convertDocument (file, contentCatalog = undefined, asciidocConfig = {}) {
+  const { extractAsciiDocMetadata = _extractAsciiDocMetadata, loadAsciiDoc = _loadAsciiDoc } = this
+    ? this.getFunctions(false)
+    : {}
   const doc = loadAsciiDoc(file, contentCatalog, asciidocConfig)
   if (!file.asciidoc) {
     file.asciidoc = extractAsciiDocMetadata(doc)
-    if (doc.hasAttribute('page-partial')) file.src.contents = file.contents
+    if (asciidocConfig.keepSource || 'page-partial' in file.asciidoc.attributes) file.src.contents = file.contents
   }
   file.contents = Buffer.from(doc.convert())
   file.mediaType = 'text/html'

package/lib/convert-documents.js

@@ -1,7 +1,10 @@
 'use strict'
 
-const convertDocument = require('./convert-document')
-const { loadAsciiDoc, extractAsciiDocMetadata } = require('@antora/asciidoc-loader')
+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
@@ -26,6 +29,11 @@ const { loadAsciiDoc, extractAsciiDocMetadata } = require('@antora/asciidoc-load
  * @returns {Array<File>} The publishable virtual files in the page family taken from the content catalog.
  */
 function convertDocuments (contentCatalog, siteAsciiDocConfig = {}) {
+  const {
+    convertDocument = _convertDocument,
+    extractAsciiDocMetadata = _extractAsciiDocMetadata,
+    loadAsciiDoc = _loadAsciiDoc,
+  } = this ? this.getFunctions(false) : {}
   const mainAsciiDocConfigs = new Map()
   contentCatalog.getComponents().forEach(({ name: component, versions }) => {
     versions.forEach(({ version, asciidoc }) => {
@@ -37,30 +45,33 @@ function convertDocuments (contentCatalog, siteAsciiDocConfig = {}) {
   for (const [cacheKey, mainAsciiDocConfig] of mainAsciiDocConfigs) {
     headerAsciiDocConfigs.set(cacheKey, Object.assign({}, mainAsciiDocConfig, headerOverrides))
   }
-  return contentCatalog
-    .getPages((page) => page.out)
-    .map((page) => {
-      if (page.mediaType === 'text/asciidoc') {
-        const asciidocConfig = headerAsciiDocConfigs.get(buildCacheKey(page.src))
-        const { attributes } = (page.asciidoc = extractAsciiDocMetadata(
-          loadAsciiDoc(page, contentCatalog, asciidocConfig || Object.assign({}, siteAsciiDocConfig, headerOverrides))
-        ))
-        Object.defineProperty(page, 'title', {
-          get () {
-            return this.asciidoc.doctitle
-          },
-        })
-        registerPageAliases(attributes['page-aliases'], page, contentCatalog)
-        if ('page-partial' in attributes) page.src.contents = page.contents
+  const keepSource = siteAsciiDocConfig.keepSource
+  const pages = contentCatalog
+    .getPages((page) => {
+      if (page.out) {
+        if (page.mediaType === 'text/asciidoc') {
+          const asciidocConfig = headerAsciiDocConfigs.get(buildCacheKey(page.src))
+          const { attributes } = (page.asciidoc = extractAsciiDocMetadata(
+            loadAsciiDoc(page, contentCatalog, asciidocConfig || Object.assign({}, siteAsciiDocConfig, headerOverrides))
+          ))
+          Object.defineProperty(page, 'title', {
+            get () {
+              return this.asciidoc.doctitle
+            },
+          })
+          registerPageAliases(attributes['page-aliases'], page, contentCatalog)
+          if (keepSource || 'page-partial' in attributes) page.src.contents = page.contents
+        }
+        return true
       }
-      return page
     })
     .map((page) =>
       page.mediaType === 'text/asciidoc'
         ? convertDocument(page, contentCatalog, mainAsciiDocConfigs.get(buildCacheKey(page.src)) || siteAsciiDocConfig)
         : page
     )
-    .map((page) => delete page.src.contents && page)
+  if (!keepSource) pages.forEach((page) => delete page.src.contents)
+  return pages
 }
 
 function buildCacheKey ({ component, version }) {
@@ -74,4 +85,4 @@ function registerPageAliases (aliases, targetFile, contentCatalog) {
     .forEach((spec) => (spec = spec.trim()) && contentCatalog.registerPageAlias(spec, targetFile))
 }
 
-module.exports = Object.assign(convertDocuments, { convertDocuments, convertDocument })
+module.exports = Object.assign(convertDocuments, { convertDocuments, convertDocument: _convertDocument })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/document-converter",
-  "version": "3.0.0-alpha.9",
+  "version": "3.0.0-beta.4",
   "description": "Converts AsciiDoc documents to embeddable HTML for use in an Antora documentation pipeline.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -17,10 +17,10 @@
   },
   "main": "lib/index.js",
   "dependencies": {
-    "@antora/asciidoc-loader": "3.0.0-alpha.9"
+    "@antora/asciidoc-loader": "3.0.0-beta.4"
   },
   "engines": {
-    "node": ">=10.17.0"
+    "node": ">=12.21.0"
   },
   "files": [
     "lib/"
@@ -35,5 +35,6 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "a504d6889819b548e8a5416a7194cbb6f9a93e93"
+  "gitHead": "8a142499e9f1a9e0631777796e06dd6c010d3a90",
+  "readmeFilename": "README.md"
 }