@antora/assembler 1.0.0-rc.6 → 1.0.0-rc.8

package/lib/assemble-content.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const fs = require('node:fs')
-const { promises: fsp } = fs
+const compileConversionAttributes = require('./compile-conversion-attributes')
+const fsp = require('node:fs/promises')
 const LazyReadable = require('./util/lazy-readable')
 const loadConfig = require('./load-config')
 const logCommand = require('./log-command')
@@ -22,12 +22,13 @@ async function assembleContent (playbook, contentCatalog, converter, providers)
     getDefaultCommand,
     extname: targetExtname = '',
     backend: targetBackend = targetExtname.substring(1),
+    format: targetFormat = targetBackend,
     embedReferenceStyle = 'relative',
     mediaType: targetMediaType,
     loggerName = `${PACKAGE_NAME} [${targetBackend}-exporter]`,
     xmlCompliant,
   } = converter ?? {}
-  const assemblerConfig = await loadConfig.call(this, configSource, playbook, '-' + targetBackend)
+  const assemblerConfig = await loadConfig.call(this, configSource, playbook, targetBackend ? '-' + targetBackend : '')
   if (assemblerConfig.enabled === false || !contentCatalog.publishableFamilies?.has('export')) return []
   const context = isBound(this)
     ? this
@@ -35,9 +36,10 @@ async function assembleContent (playbook, contentCatalog, converter, providers)
         getFunctions: invariably.new,
         getLogger: invariably.void,
         getVariables: invariably.new,
+        require,
       }
   const generatorFunctions = context.getFunctions()
-  const { loadAsciiDoc = require('@antora/asciidoc-loader') } = generatorFunctions
+  const { loadAsciiDoc = context.require('@antora/asciidoc-loader') } = generatorFunctions
   const { assembly: assemblyConfig, build: buildConfig } = assemblerConfig
   assemblyConfig.embedReferenceStyle = embedReferenceStyle
   if (xmlCompliant) assemblyConfig.xmlIds ??= true
@@ -48,13 +50,17 @@ async function assembleContent (playbook, contentCatalog, converter, providers)
     buildConfig.dir ??= ospath.join(playbook.dir ?? process.cwd(), `build/assembler/${profile}`)
     intrinsicAttributes[`assembler-profile-${profile}`] = ''
     intrinsicAttributes['assembler-profile'] = profile
-    if (targetBackend) {
-      intrinsicAttributes[`assembler-backend-${targetBackend}`] = ''
-      intrinsicAttributes['assembler-backend'] = targetBackend
-    }
   } else {
     buildConfig.dir ??= ospath.join(playbook.dir ?? process.cwd(), 'build/assembler/_')
   }
+  if (targetBackend) {
+    intrinsicAttributes[`assembler-backend-${targetBackend}`] = ''
+    intrinsicAttributes['assembler-backend'] = targetBackend
+  }
+  if (targetFormat) {
+    intrinsicAttributes[`assembler-format-${targetFormat}`] = ''
+    intrinsicAttributes['assembler-format'] = targetFormat
+  }
   if (targetExtname) {
     const targetFiletype = targetExtname.substring(1)
     intrinsicAttributes[`assembler-filetype-${targetFiletype}`] = ''
@@ -65,23 +71,29 @@ async function assembleContent (playbook, contentCatalog, converter, providers)
     loadAsciiDoc,
     contentCatalog,
     assemblerConfig,
-    generateSelectAssemblyProfile(context, contentCatalog, assemblyConfig, intrinsicAttributes, navigationCatalog),
+    generateSelectAssemblerProfile(context, contentCatalog, assemblyConfig, intrinsicAttributes, navigationCatalog),
     typeof componentVersionFilter === 'function' ? componentVersionFilter : undefined
   )
   if (!(assemblyFiles.length && typeof convert === 'function')) return assemblyFiles
   buildConfig.command ??= typeof getDefaultCommand === 'function' ? await getDefaultCommand(cwd, playbook) : null
-  const { publishSite: publishFiles = require('@antora/site-publisher') } = generatorFunctions
+  const { publishSite: publishFiles = context.require('@antora/site-publisher') } = generatorFunctions
   await prepareWorkspace(publishFiles, assemblyFiles, buildConfig)
-  const helpers = { logCommand: logCommand.bind(context, loggerName), runCommand }
+  const helpers = { runCommand }
+  Object.defineProperty(helpers, 'logger', {
+    get: () => context?.getLogger(loggerName),
+  })
+  Object.defineProperty(helpers, 'logCommand', {
+    get: () => logCommand.bind(null, helpers.logger),
+  })
   const boundConvert = convert.bind(context)
   const boundResolveFileOrContents = resolveFileOrContents.bind(context)
   return new PromiseQueue({ concurrency: buildConfig.processLimit })
     .add(
       assemblyFiles.map((doc) => async () => {
         const relativeToOutput = embedReferenceStyle === 'output-relative'
-        const convertAttributes = await prepareConvertAttributes(doc, targetExtname, relativeToOutput, assemblerConfig)
-        return boundConvert(doc, convertAttributes, buildConfig, helpers).then((result) =>
-          boundResolveFileOrContents(result, convertAttributes, buildConfig, loggerName).then((fileOrContents) =>
+        const attributes = await compileConversionAttributes(doc, targetExtname, assemblerConfig, relativeToOutput)
+        return boundConvert(doc, attributes, buildConfig, helpers).then((result) =>
+          boundResolveFileOrContents(result, attributes, buildConfig, loggerName).then((fileOrContents) =>
             coerceToExportFormat(doc, targetBackend, targetExtname, targetMediaType, fileOrContents)
           )
         )
@@ -110,6 +122,7 @@ async function assembleContent (playbook, contentCatalog, converter, providers)
           const assemblerMeta = (page.assembler ??= {})
           const exports = (assemblerMeta.exports ??= [])
           const exportEntry = { fragment, file }
+          if (fragment === pages.rootPageFragment) exportEntry.root = true
           const insertIdx = exports.findIndex(
             ({ file: candidate }) =>
               !(candidate.src.component === page.src.component && candidate.src.version === page.src.version)
@@ -129,11 +142,11 @@ async function assembleContent (playbook, contentCatalog, converter, providers)
 }
 
 /**
- * Generates a function that selects the active assembly profile, initializes an assembly model using
+ * Generates a function that selects the active assembler profile, initializes an assembly model using
  * the keys from the profile as well as any inherited shared keys, builds the navigation for the assembly, and
  * returns the initialized assembly model. The assembly model is further populated after the call to this function.
  */
-function generateSelectAssemblyProfile (context, contentCatalog, baseModel, intrinsicAttributes, navigationCatalog) {
+function generateSelectAssemblerProfile (context, contentCatalog, baseModel, intrinsicAttributes, navigationCatalog) {
   const logger = context.getLogger?.(PACKAGE_NAME)
   const { assemblerProfiles } = context.getVariables()
   if (!assemblerProfiles) {
@@ -144,7 +157,7 @@ function generateSelectAssemblyProfile (context, contentCatalog, baseModel, intr
     }
   }
   const boundSendToLog = sendToLog.bind(logger)
-  const { buildAlternateNavigation = require('@antora/navigation-builder').buildAlternateNavigation } =
+  const { buildAlternateNavigation = context.require('@antora/navigation-builder').buildAlternateNavigation } =
     context.getFunctions()
   return (componentVersion) => {
     const componentVersionProfiles = assemblerProfiles.get(componentVersion.version + '@' + componentVersion.name)
@@ -173,73 +186,6 @@ function generateSelectAssemblyProfile (context, contentCatalog, baseModel, intr
   }
 }
 
-async function prepareConvertAttributes (doc, targetExtname, relativeToOutput, assemblerConfig) {
-  const {
-    asciidoc: { attributes: docAttributes } = { attributes: {} },
-    extname: docfilesuffix,
-    path: reldocfile,
-    src: { family, relative },
-  } = doc
-  const { cwd = process.cwd(), dir = cwd, mkdirs } = assemblerConfig.build
-  const docname = family + '$' + relative.substring(0, relative.length - docfilesuffix.length)
-  const docfile = ospath.join(dir, reldocfile)
-  const outdir = ospath.dirname(docfile)
-  const docdir = relativeToOutput ? dir : outdir
-  const outfile = docfile.substring(0, docfile.length - docfilesuffix.length) + targetExtname
-  const attributes = Object.assign({ revdate: `${assemblerConfig.assembly.revdate}@` }, docAttributes, {
-    docdir,
-    docfile,
-    docfilesuffix,
-    docname: `${docname}@`,
-    imagesdir: '',
-    outdir,
-    outfile,
-    outfilesuffix: targetExtname,
-    toArgs (attributeOptionFlag, outputOptionFlag) {
-      const args = []
-      let requireAsciidoctorLogAdapter
-      for (const [name, val] of Object.entries(this)) {
-        let optionValue
-        if (name === 'asciidoctor-log-integration') {
-          if ((val ?? false) !== false) requireAsciidoctorLogAdapter = val
-          continue
-        } else if ((val ?? false) === false) {
-          optionValue = `${name}!${val === false ? '=@' : ''}`
-        } else {
-          optionValue = val === '' ? name : name + '=' + val
-        }
-        args.push(attributeOptionFlag, optionValue)
-      }
-      if (requireAsciidoctorLogAdapter) args.push('-r', requireAsciidoctorLogAdapter)
-      if (outputOptionFlag) args.push(outputOptionFlag, this.outfile)
-      return args
-    },
-  })
-  Object.defineProperty(attributes, 'outfilesuffix', {
-    get () {
-      return ospath.extname(this.outfile)
-    },
-    set (value) {
-      const outfile = this.outfile
-      const extname = ospath.extname(outfile)
-      if (extname && outfile.endsWith(extname)) this.outfile = outfile.substring(0, outfile.length - extname.length)
-      this.outfile += value
-    },
-  })
-  Object.defineProperty(attributes, 'toArgs', { enumerable: false })
-  if (mkdirs) await fsp.mkdir(outdir, { recursive: true, force: true })
-  if (attributes['asciidoctor-log-integration'] != null) {
-    const scriptSourcePath = require.resolve('#asciidoctor-log-adapter')
-    let scriptTargetPath = scriptSourcePath
-    if (attributes['asciidoctor-log-integration'] === 'copy-to-build-dir') {
-      scriptTargetPath = ospath.join(dir, 'asciidoctor-log-adapter.rb')
-      await fsp.cp(scriptSourcePath, scriptTargetPath, { force: true, recursive: true })
-    }
-    attributes['asciidoctor-log-integration'] = scriptTargetPath
-  }
-  return attributes
-}
-
 function coerceToExportFormat (assemblyFile, targetBackend, targetExtname, targetMediaType, fileOrContents) {
   const file =
     fileOrContents == null || Buffer.isBuffer(fileOrContents) || typeof fileOrContents.pipe === 'function'
@@ -287,7 +233,7 @@ function prepareWorkspace (publishFiles, assemblyFiles, buildConfig) {
   })
 }
 
-function resolveFileOrContents (convertResult, convertAttributes, buildConfig, loggerName) {
+function resolveFileOrContents (convertResult, attributes, buildConfig, loggerName) {
   let fileOrContents
   if (convertResult?.status != null) {
     if ('file' in convertResult) {
@@ -299,7 +245,7 @@ function resolveFileOrContents (convertResult, convertAttributes, buildConfig, l
     }
     let logger, match
     if (buildConfig.stderrSink === 'log' && convertResult.stderr?.length && (logger = this.getLogger(loggerName))) {
-      const docfile = convertAttributes.docfile
+      const docfile = attributes.docfile
       const command = buildConfig.command
       const file = { path: docfile }
       const stderr = convertResult.stderr.toString().trimEnd()
@@ -330,8 +276,8 @@ function resolveFileOrContents (convertResult, convertAttributes, buildConfig, l
     return Promise.resolve(convertResult)
   }
   if (fileOrContents !== undefined) return Promise.resolve(fileOrContents)
-  const outfile = convertAttributes.outfile
-  return fsp.access(outfile).then(() => new LazyReadable(() => fs.createReadStream(outfile)), invariably.null)
+  const outfile = attributes.outfile
+  return fsp.access(outfile).then(() => new LazyReadable(outfile), invariably.null)
 }
 
 function isBound (obj) {

package/lib/compile-conversion-attributes.js

@@ -0,0 +1,75 @@
+'use strict'
+
+const fsp = require('node:fs/promises')
+const ospath = require('node:path')
+
+async function compileConversionAttributes (doc, targetExtname, assemblerConfig, relativeToOutput = false) {
+  const {
+    asciidoc: { attributes: docAttributes } = { attributes: {} },
+    extname: docfilesuffix,
+    path: reldocfile,
+    src: { family, relative },
+  } = doc
+  const { cwd = process.cwd(), dir = cwd, mkdirs } = assemblerConfig.build
+  const docname = family + '$' + relative.substring(0, relative.length - docfilesuffix.length)
+  const docfile = (doc.src.path = ospath.join(dir, reldocfile))
+  const outdir = ospath.dirname(docfile)
+  const outfile = docfile.substring(0, docfile.length - docfilesuffix.length) + targetExtname
+  const docdir = relativeToOutput ? dir : outdir
+  const imagesoutdir = ospath.join(outdir, '..', '_images')
+  const attributes = Object.assign({ revdate: `${assemblerConfig.assembly.revdate}@` }, docAttributes, {
+    docdir,
+    docfile,
+    docfilesuffix,
+    docname: `${docname}@`,
+    imagesdir: '',
+    imagesoutdir,
+    outdir,
+    outfile,
+    outfilesuffix: targetExtname,
+    toArgs (attributeOptionFlag, outputOptionFlag) {
+      const args = []
+      let requireAsciidoctorLogAdapter
+      for (const [name, val] of Object.entries(this)) {
+        let optionValue
+        if (name === 'asciidoctor-log-integration') {
+          if ((val ?? false) !== false) requireAsciidoctorLogAdapter = val
+          continue
+        } else if ((val ?? false) === false) {
+          optionValue = `${name}!${val === false ? '=@' : ''}`
+        } else {
+          optionValue = val === '' ? name : name + '=' + val
+        }
+        args.push(attributeOptionFlag, optionValue)
+      }
+      if (requireAsciidoctorLogAdapter) args.push('-r', requireAsciidoctorLogAdapter)
+      if (outputOptionFlag) args.push(outputOptionFlag, this.outfile)
+      return args
+    },
+  })
+  Object.defineProperty(attributes, 'outfilesuffix', {
+    get () {
+      return ospath.extname(this.outfile)
+    },
+    set (value) {
+      const outfile = this.outfile
+      const extname = ospath.extname(outfile)
+      if (extname && outfile.endsWith(extname)) this.outfile = outfile.substring(0, outfile.length - extname.length)
+      this.outfile += value
+    },
+  })
+  Object.defineProperty(attributes, 'toArgs', { enumerable: false })
+  if (mkdirs) await fsp.mkdir(outdir, { recursive: true, force: true })
+  if (attributes['asciidoctor-log-integration'] != null) {
+    const scriptSourcePath = require.resolve('#asciidoctor-log-adapter')
+    let scriptTargetPath = scriptSourcePath
+    if (attributes['asciidoctor-log-integration'] === 'copy-to-build-dir') {
+      scriptTargetPath = ospath.join(dir, 'asciidoctor-log-adapter.rb')
+      await fsp.cp(scriptSourcePath, scriptTargetPath, { force: true, recursive: true })
+    }
+    attributes['asciidoctor-log-integration'] = scriptTargetPath
+  }
+  return attributes
+}
+
+module.exports = compileConversionAttributes

package/lib/configure.js

@@ -53,8 +53,9 @@ function getAssemblerProfiles (contentCatalog, assemblerProfiles = new Map()) {
         [...(componentVersion.origins ?? [])].find((it) => it.descriptor?.ext?.assembler)
       const assemblerConfig = getAssemblerConfigFromDescriptor(source?.descriptor)
       if (!assemblerConfig) return
-      const componentVersionRef = `${componentVersion.version}@${componentVersion.name}`
-      const filesByPath = componentVersion.files.reduce((accum, it) => accum.set(it.path, it), new Map())
+      const { name: componentName, version, files } = componentVersion
+      const componentVersionKey = `${version}@${componentName}`
+      const filesByPath = files.reduce((accum, it) => accum.set(it.path, it), new Map())
       const componentVersionProfiles = assemblerConfig.reduce((accum, entry) => {
         const data = {}
         const profile = entry.profile ?? undefined
@@ -69,8 +70,9 @@ function getAssemblerProfiles (contentCatalog, assemblerProfiles = new Map()) {
           data.navFiles = (nav.length ? [...new Set(nav)] : nav).reduce((navFiles, path_) => {
             const navFile = filesByPath.get(path_)
             if (navFile) {
-              navFiles.push(initNavFile(navFile, component.name, componentVersion.version, navFiles.length))
+              navFiles.push(initNavFile(navFile, componentName, version, navFiles.length))
             } else {
+              const componentVersionRef = `${version === 'master' ? '' : version}@${componentName}`
               ;(data.messages ??= []).push([
                 'warn',
                 { source },
@@ -84,7 +86,7 @@ function getAssemblerProfiles (contentCatalog, assemblerProfiles = new Map()) {
         }
         return accum.set(profile, data)
       }, new Map())
-      assemblerProfiles.set(componentVersionRef, componentVersionProfiles)
+      assemblerProfiles.set(componentVersionKey, componentVersionProfiles)
     })
   })
   return assemblerProfiles

package/lib/constants.js

@@ -19,4 +19,5 @@ module.exports = Object.freeze({
     'rootLevel',
     'sectionMergeStrategy',
   ],
+  CAMEL_CASE_STOP_KEYS: ['asciidoc.attributes', 'assembly.attributes'],
 })

package/lib/index.js

@@ -3,4 +3,4 @@
 const assembleContent = require('./assemble-content')
 const configure = require('./configure')
 
-module.exports = { assembleContent, configure, configureAssembler: configure }
+module.exports = { assembleContent, configure }

package/lib/load-config.js

@@ -1,13 +1,13 @@
 'use strict'
 
+const deepClone = require('./util/deep-clone')
 const expandPath = require('@antora/expand-path-helper')
 const fsp = require('node:fs/promises')
 const os = require('node:os')
 const ospath = require('node:path')
 const yaml = require('js-yaml')
 
-const { LEGACY_ASSEMBLY_KEYS } = require('./constants')
-const CAMEL_CASE_STOP_PATHS = ['asciidoc.attributes', 'assembly.attributes']
+const { CAMEL_CASE_STOP_KEYS, LEGACY_ASSEMBLY_KEYS } = require('./constants')
 const PACKAGE_NAME = require('../package.json').name
 const YAML_SCHEMA = yaml.CORE_SCHEMA.withTags(yaml.mergeTag)
 
@@ -15,7 +15,7 @@ function loadConfig (configSource, playbook, preferredQualifier = '') {
   let resolvedConfigSource
   return (
     configSource?.constructor === Object
-      ? Promise.resolve(configSource)
+      ? Promise.resolve(deepClone(configSource))
       : fileExists(
           (resolvedConfigSource = expandPath(configSource ?? `./antora-assembler${preferredQualifier}.yml`, {
             dot: playbook.dir,
@@ -38,7 +38,7 @@ function loadConfig (configSource, playbook, preferredQualifier = '') {
               return {}
             }
             return fsp.readFile(resolvedConfigSource).then((data) =>
-              Object.assign(camelCaseKeys(yaml.load(data, { schema: YAML_SCHEMA }), CAMEL_CASE_STOP_PATHS), {
+              Object.assign(camelCaseKeys(yaml.load(data, { schema: YAML_SCHEMA }), CAMEL_CASE_STOP_KEYS), {
                 file: resolvedConfigSource,
               })
             )
@@ -141,7 +141,7 @@ function camelCaseKeys (o, stopPaths, p = undefined) {
   const accum = {}
   for (const [k, v] of Object.entries(o)) {
     const camelKey = k.charAt() + k.substring(1).replace(/_([a-z])/g, (_, l) => l.toUpperCase())
-    accum[camelKey] = ~stopPaths.indexOf(pathPrefix + camelKey) ? v : camelCaseKeys(v, stopPaths, pathPrefix + camelKey)
+    accum[camelKey] = stopPaths.includes(pathPrefix + camelKey) ? v : camelCaseKeys(v, stopPaths, pathPrefix + camelKey)
   }
   return accum
 }

package/lib/log-command.js

@@ -1,20 +1,18 @@
 'use strict'
 
-function logCommand (loggerName, command, extraArgsOrAttributeOptionFlag, file, convertAttributes) {
-  const logger = this?.getLogger(loggerName)
+function logCommand (logger, command, extraArgsOrAttributeOptionFlag, file, attributes) {
   if (!logger?.isLevelEnabled('debug')) return
-  const { docfile, 'assembler-filetype': filetype } = convertAttributes
   const args = (
     Array.isArray(extraArgsOrAttributeOptionFlag)
       ? extraArgsOrAttributeOptionFlag
       : extraArgsOrAttributeOptionFlag
-        ? convertAttributes.toArgs(extraArgsOrAttributeOptionFlag)
+        ? attributes.toArgs(extraArgsOrAttributeOptionFlag)
         : []
   ).map((it) => (~it.indexOf(' ') ? `'${it}'` : it))
-  const ctx = { command: [command].concat(args).join(' '), file: { path: docfile } }
+  const ctx = { command: [command].concat(args).join(' '), file: file.src }
   const msg = `Running external command to export assembly in %s to %s: %s`
   const componentVersionStr = file.src.version ? `${file.src.version}@${file.src.component}` : file.src.component
-  logger.debug(ctx, msg, componentVersionStr, filetype, file.src.relative)
+  logger.debug(ctx, msg, componentVersionStr, attributes['assembler-filetype'], file.src.relative)
 }
 
 module.exports = logCommand