@antora/assembler 1.0.0-beta.13 → 1.0.0-beta.15

package/lib/assemble-content.js

@@ -16,8 +16,6 @@ const PACKAGE_NAME = require('../package.json').name
 const NEWLINE_RX = /(?:\r?\n)+/
 
 async function assembleContent (playbook, contentCatalog, converter, { configSource, navigationCatalog }) {
-  const assemblerConfig = await loadConfig(playbook, configSource)
-  if (!assemblerConfig) return [] // TODO consider removing and doing this another way
   const context = isBound(this)
     ? this
     : {
@@ -25,6 +23,8 @@ async function assembleContent (playbook, contentCatalog, converter, { configSou
         getLogger: invariably.void,
         getVariables: invariably.new,
       }
+  const assemblerConfig = await loadConfig.call(context, playbook, configSource)
+  if (assemblerConfig.enabled === false) return []
   const generatorFunctions = context.getFunctions()
   const { loadAsciiDoc = require('@antora/asciidoc-loader') } = generatorFunctions
   const {

package/lib/load-config.js

@@ -5,6 +5,8 @@ const fsp = require('node:fs/promises')
 const os = require('node:os')
 const yaml = require('js-yaml')
 
+const PACKAGE_NAME = require('../package.json').name
+
 const ASSEMBLY_KEYS = [
   'rootLevel',
   'insertStartPage',
@@ -13,25 +15,34 @@ const ASSEMBLY_KEYS = [
   'dropExplicitXrefText',
 ]
 
-function loadConfig (playbook, configSource = './antora-assembler.yml') {
+function loadConfig (playbook, configSource) {
+  let resolvedConfigSource
   return (
-    configSource.constructor === Object
+    configSource?.constructor === Object
       ? Promise.resolve(configSource)
       : fsp
-          .access((configSource = expandPath(configSource, { dot: playbook.dir })))
+          .access((resolvedConfigSource = expandPath(configSource ?? './antora-assembler.yml', { dot: playbook.dir })))
           .then(
             () => true,
             () => false
           )
-          .then((exists) =>
-            exists
-              ? fsp
-                  .readFile(configSource)
-                  .then((data) => Object.assign(camelCaseKeys(yaml.load(data), ['asciidoc']), { file: configSource }))
-              : {}
-          )
+          .then((exists) => {
+            if (!exists) {
+              let logger
+              if (configSource && (logger = this?.getLogger?.(PACKAGE_NAME))) {
+                const ctx = { file: { path: configSource } }
+                logger.warn(ctx, 'Could not resolve config file; reverting to default settings')
+              }
+              return {}
+            }
+            return fsp
+              .readFile(resolvedConfigSource)
+              .then((data) =>
+                Object.assign(camelCaseKeys(yaml.load(data), ['asciidoc']), { file: resolvedConfigSource })
+              )
+          })
   ).then((config) => {
-    if (config.enabled === false) return undefined
+    if (config.enabled === false) return config
     let asciidocAttrs
     if (!config.asciidoc) {
       config.asciidoc = { attributes: (asciidocAttrs = {}) }

package/lib/produce-assembly-file.js

@@ -121,6 +121,7 @@ function mergeAsciiDoc (
     outDirname,
     siteRoot,
     xmlIds,
+    logger,
   } = assemblyModel
   // FIXME: ideally, resource ID would be stored in navigation so we can look up the page more efficiently
   const page = urlType === 'internal' && !unresolved ? pagesInOutline.get(url) : undefined
@@ -142,6 +143,16 @@ function mergeAsciiDoc (
       Object.assign({}, page, { contents: trimAsciiDoc(contents), mediaType })
     )
     const doc = loadAsciiDoc(pageAsAsciiDoc, contentCatalog, asciidocConfig)
+    let asciidoctorLogger = doc.getLogger()
+    if (logger) {
+      asciidoctorLogger = Object.assign(asciidoctorLogger.$dup(), {
+        delegate: {
+          warn () {
+            return logger.warn.apply(logger, arguments)
+          },
+        },
+      })
+    }
     if (doc.hasAttribute('assembly-navtitle')) {
       navtitleAsciiDoc = doc.getAttribute('assembly-navtitle')
       navtitlePlain = sanitize((navtitle = doc.$apply_reftext_subs(navtitleAsciiDoc)))
@@ -374,7 +385,7 @@ function mergeAsciiDoc (
       }
       if (~line.indexOf('xref:')) {
         // Q: should we allow : as first character of target?
-        line = line.replace(/(?<![\\+])xref:((?:\.\/)?[\p{Alpha}0-9_/.{#].*?)\[(|.*?[^\\])\]/gu, (m, target, text) => {
+        line = line.replace(/(?<![\\+])xref:((?:\.\/)?[\p{Alpha}0-9_/.{#].*?)\[(|.*?[^\\])\]/gu, (_, target, text) => {
           let fragment, resource, resourceRef
           const hashIdx = target.indexOf('#')
           if (~hashIdx) {
@@ -389,21 +400,23 @@ function mergeAsciiDoc (
           // Q: should we validate the internal ID here?
           if (!resourceRef) return `xref:${idPrefix}${fragment}[${text}]`
           const resourceId = parseResourceRef(resourceRef, page.src, 'page', contentCatalog)
-          if (resourceId.family !== 'page') {
-            if (siteRoot && (resource = contentCatalog.getById(resourceId))?.pub) {
-              text ||= resource.asciidoc?.xreftext || target
-              return `${resolveLinkTarget(resource, siteRoot, pubRoot, linkRefStyle)}${fragment && '#' + fragment}[${text}]`
-            }
-            // TODO: handle unresolved resource better
-            return m
-          }
-          if (!(resource = pagesInOutline.get(createResourceKey(resourceId)))) {
-            if (siteRoot && (resource = contentCatalog.getById(resourceId))?.pub) {
+          if (resourceId.family !== 'page' || !(resource = pagesInOutline.get(createResourceKey(resourceId)))) {
+            if ((resource = contentCatalog.getById(resourceId))?.pub) {
               text ||= resource.asciidoc?.xreftext || target
-              return `${resolveLinkTarget(resource, siteRoot, pubRoot, linkRefStyle)}${fragment && '#' + fragment}[${text}]`
+              if (siteRoot || linkRefStyle === 'relative') {
+                return `${resolveLinkTarget(resource, siteRoot, pubRoot, linkRefStyle)}${fragment && '#' + fragment}[${text}]`
+              }
+              asciidoctorLogger.warn(
+                doc.createLogMessage(
+                  `Cannot create external ${resourceId.family} reference in assembly because site URL is unknown: ${target}`,
+                  { source_location: { file: relative, lineno: idx + 1 } }
+                )
+              )
             }
-            // TODO: handle unresolved page better
-            return m
+            const linkAttrlist = text
+              ? (~text.indexOf(',') ? `"${text}"` : text) + ',role=unresolved'
+              : 'role=unresolved'
+            return `link:${target}[${linkAttrlist}]`
           }
           if (fragment === resource.asciidoc.id) fragment = ''
           if (
@@ -427,7 +440,7 @@ function mergeAsciiDoc (
       if (~line.indexOf('link:{attachmentsdir}/')) {
         line = line.replace(/(?<![\\+])link:\{attachmentsdir\}\/([^\s[]+)\[(|.*?[^\\])\]/g, (m, relative, text) => {
           const attachment =
-            siteRoot &&
+            (siteRoot || linkRefStyle === 'relative') &&
             contentCatalog.getById({
               component: componentVersion.name,
               version: componentVersion.version,
@@ -441,15 +454,25 @@ function mergeAsciiDoc (
       }
       if (~line.indexOf('image:') && !line.startsWith('image::')) {
         line = line.replace(/(?<![\\+])image:([^:\s[](?:[^[]*[^\s[])?)\[([^\]]*)\]/g, (m, target, attrlist) => {
-          if (isResourceSpec(target)) {
-            const image = contentCatalog.resolveResource(target, page.src, 'image', ['image'])
-            // TODO: handle (or report) unresolved image better
-            if (image?.out && (filetype !== 'html' || siteRoot)) {
+          let image
+          if (
+            isResourceSpec(target) &&
+            (image = contentCatalog.resolveResource(target, page.src, 'image', ['image']))?.out
+          ) {
+            if (filetype !== 'html') {
+              pagesInOutline.assembled.assets.add(image)
+              return `image:${resolveEmbedTarget(image, outDirname, embedRefStyle, true)}[${attrlist}]`
+            }
+            if (siteRoot || linkRefStyle === 'relative') {
               pagesInOutline.assembled.assets.add(image)
-              return filetype === 'html'
-                ? `image:${resolveLinkTarget(image, siteRoot, pubRoot, linkRefStyle)}[${attrlist}]`
-                : `image:${resolveEmbedTarget(image, outDirname, embedRefStyle, true)}[${attrlist}]`
+              return `image:${resolveLinkTarget(image, siteRoot, pubRoot, linkRefStyle)}[${attrlist}]`
             }
+            asciidoctorLogger.warn(
+              doc.createLogMessage(
+                `Cannot create external image reference in assembly because site URL is unknown: ${target}`,
+                { source_location: { file: relative, lineno: idx + 1 } }
+              )
+            )
           }
           return m
         })

package/lib/produce-assembly-files.js

@@ -21,6 +21,7 @@ function produceAssemblyFiles (loadAsciiDoc, contentCatalog, assemblerConfig, re
     embedReferenceStyle: assemblyConfig.embedReferenceStyle,
     linkReferenceStyle: assemblyConfig.linkReferenceStyle,
     dropExplicitXrefText: assemblyConfig.dropExplicitXrefText,
+    logger: assemblyConfig.logger, // for tests
   })
   const assemblerAsciiDocAttributes = Object.assign({}, assemblerAsciiDocConfig.attributes)
   const { revdate, 'source-highlighter': sourceHighlighter } = assemblerAsciiDocAttributes
@@ -64,7 +65,7 @@ function produceAssemblyFiles (loadAsciiDoc, contentCatalog, assemblerConfig, re
         if (linkRefStyle === 'absolute' && siteRoot?.url == null) linkRefStyle = 'root-relative'
         if (linkRefStyle === 'root-relative' && siteRoot?.path == null) linkRefStyle = 'relative'
         assemblyModel.linkReferenceStyle = linkRefStyle
-      } else {
+      } else if (!(assemblyModel.filetype === 'pdf' && assemblyModel.linkReferenceStyle === 'relative')) {
         assemblyModel.linkReferenceStyle = 'absolute'
       }
       const auxiliaryImages = new Set()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/assembler",
-  "version": "1.0.0-beta.13",
+  "version": "1.0.0-beta.15",
   "description": "A JavaScript library that merges AsciiDoc content from multiple pages in an Antora site into assembly files and delegates to an exporter to convert those files to another format, such as PDF.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",