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

package/lib/assemble-content.js

@@ -78,7 +78,13 @@ async function assembleContent (playbook, contentCatalog, converter, providers)
   buildConfig.command ??= typeof getDefaultCommand === 'function' ? await getDefaultCommand(cwd, playbook) : null
   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 })
@@ -116,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)

package/lib/compile-conversion-attributes.js

@@ -12,16 +12,18 @@ async function compileConversionAttributes (doc, targetExtname, assemblerConfig,
   } = 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 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: relativeToOutput ? dir : outdir,
+    docdir,
     docfile,
     docfilesuffix,
     docname: `${docname}@`,
     imagesdir: '',
-    imagesoutdir: ospath.join(outdir, '..', '_images'),
+    imagesoutdir,
     outdir,
     outfile,
     outfilesuffix: targetExtname,

package/lib/log-command.js

@@ -1,9 +1,7 @@
 'use strict'
 
-function logCommand (loggerName, command, extraArgsOrAttributeOptionFlag, file, attributes) {
-  const logger = this?.getLogger(loggerName)
+function logCommand (logger, command, extraArgsOrAttributeOptionFlag, file, attributes) {
   if (!logger?.isLevelEnabled('debug')) return
-  const { docfile, 'assembler-filetype': filetype } = attributes
   const args = (
     Array.isArray(extraArgsOrAttributeOptionFlag)
       ? extraArgsOrAttributeOptionFlag
@@ -11,10 +9,10 @@ function logCommand (loggerName, command, extraArgsOrAttributeOptionFlag, file,
         ? 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

package/lib/produce-assembly-file.js

@@ -44,9 +44,13 @@ function produceAssemblyFile (
   const pagesByUrl = files.reduce((map, it) => (it.src.family === 'page' ? map.set(it.pub.url, it) : map), new Map())
   const pagesInOutline = selectPagesInOutline(outline, pagesByUrl)
   if (outline.urlType === 'internal' && !pagesByUrl.has(outline.pathname) && !outline.items?.length) return
+  const { name: component, version } = componentVersion
   const { rootLevel, xmlIds } = assemblyModel
   const scratchDoc = loadAsciiDoc(
-    { contents: Buffer.alloc(0), src: { family: 'page', relative: '_scratch.adoc' } },
+    {
+      contents: Buffer.alloc(0),
+      src: { component, version, module: 'ROOT', family: 'page', relative: '_.adoc', path: '_.adoc' },
+    },
     undefined,
     asciidocConfig
   )
@@ -57,7 +61,6 @@ function produceAssemblyFile (
     coordinate: xmlIds ? '----' : ':',
     generateIdFromTitle: generateIdFromTitle.bind(scratchDoc),
   }
-  const { name: component, version } = componentVersion
   asciidocConfig = prepareAsciiDocConfig(
     contentCatalog,
     { component, version },
@@ -92,7 +95,7 @@ function produceAssemblyFile (
     src: { component, version, componentVersion, module: 'ROOT', family: 'export', relative: stem + '.adoc' },
     pub: false,
   })
-  file.path = file.src.path = file.out.path // use out path as path so assets can be published to same hierarchy
+  file.path = file.out.path // use out path as path so assets can be published to same hierarchy
   delete file.out
   return file
 }
@@ -232,7 +235,7 @@ function mergeAsciiDoc (
       return builder
     }
     const pageAsAsciiDoc = new page.constructor(
-      Object.assign({}, page, { contents: trimAsciiDoc(contents), mediaType: page.src.mediaType })
+      Object.assign({}, page, { contents: Buffer.from(contents.toString().trimEnd()), mediaType: page.src.mediaType })
     )
     const doc = loadAsciiDoc(pageAsAsciiDoc, contentCatalog, asciidocConfig)
     doc.catalog.syntheticIds = {}
@@ -271,7 +274,7 @@ function mergeAsciiDoc (
     const docname = doc.getAttribute('docname')
     const pageId = generateScopedId(page.src, componentVersion, idSeparators, filetype)
     const pageIdLeader = pageId + idSeparators.scope
-    let pageFragment = ''
+    let pageFragment = `#${pageId}`
     let pageRoles = []
     let pageStyle = doc.getAttribute('assembly-style', '')
     if (!pageStyle && atBookRoot && rootLevel === 0 && !doc.source_header_attributes['$key?']('assembly-style')) {
@@ -324,7 +327,7 @@ function mergeAsciiDoc (
             if (
               name.endsWith('-image') &&
               (val = doc.getAttribute(name)) &&
-              (newVal = rewriteImageAttr(val, contentCatalog, assemblyModel, page.src, assembled.assets))
+              (newVal = rewriteImageAttr(val, contentCatalog, assemblyModel, page.src, assembled.assets)) != null
             ) {
               if (newVal !== val) entry.lines = [`:${name}: ${newVal}`]
             } else if (~(val = entry.lines.join('\n').substring(name.length + 3)).indexOf(':')) {
@@ -403,8 +406,6 @@ function mergeAsciiDoc (
           // Q: should we use htitleAsciiDoc to generate ID if not {empty} instead of pageStyle
           pageFragment = `#_${idSeparators.coordinate}${pageIdLeader}${pageStyle}`
           builder.setDocid(pageId)
-        } else {
-          pageFragment = `#${pageId}`
         }
         heading = { title: htitleAsciiDoc, level: part ? 1 : 2 }
         if (notitle) heading.notitle = true
@@ -414,14 +415,12 @@ function mergeAsciiDoc (
       if (atDocumentRoot && rootLevel === 0 && navtitlePlain === componentVersion.title && !hasAssemblyNavtitleAttr) {
         level--
       } else {
-        pageFragment = `#${pageId}`
         if (part && level === 1) level--
         if ((heading = { title: navtitleAsciiDoc, level: level + 1 }).level > 6) {
           Object.assign(heading, { level: 6, style: `discrete.h${heading.level}` })
         }
       }
     } else if (atDocumentRoot && rootLevel === 0 && hasAssemblyNavtitleAttr) {
-      pageFragment = `#${pageId}`
       heading = { title: navtitleAsciiDoc, level: (nextSectionLevel = part ? 1 : 2) }
     } else if (atBookRoot) {
       nextSectionLevel = undefined
@@ -434,6 +433,8 @@ function mergeAsciiDoc (
     } else if (atDocumentRoot) {
       builder.setDocid(pageId)
     }
+    if (isRootPage || (atDocumentRoot && !heading)) assembled.pages.rootPageFragment = pageFragment
+    assembled.pages.set(page, pageFragment)
     if (sectionMergeStrategy === 'enclose' && hasItems && hasSections && !(atDocumentRoot && heading)) {
       // TODO: make overview section title configurable
       //let overviewTitle = doc.getDocumentTitle()
@@ -451,7 +452,6 @@ function mergeAsciiDoc (
       }
       buffer.push(`${'='.repeat(hlevel)} ${overviewTitle}`)
     }
-    assembled.pages.set(page, pageFragment)
     if (hasSections) fixSectionLevels(doc.getSections(), nextSectionLevel)
     const allBlocks = doc.findBy({ traverse_documents: true }, (it) =>
       it.getContext() === 'document'
@@ -822,24 +822,10 @@ function fixSectionLevels (sections, expectedLevel) {
   })
 }
 
-// NOTE: blank lines at top and bottom of document create mismatch when using line numbers to navigate source lines
-// IMPORTANT: this must not leave behind lines the parser will drop!
-// IDEA: another option is to capture initial lineno of reader and use as offset (but preseves those blank lines)
-function trimAsciiDoc (buffer) {
-  return Buffer.from(
-    buffer
-      .toString()
-      .replace(/^(?:[ \t]*\r\n?|[ \t]*\n)+/, '')
-      .trimRight()
-  )
-}
-
 function safePush (onto, entries) {
   try {
     onto.push(...entries)
-  } catch (err) {
-    /* istanbul ignore if */
-    if (!(err instanceof RangeError)) throw err
+  } catch {
     for (const e of entries) onto.push(e)
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/assembler",
-  "version": "1.0.0-rc.7",
+  "version": "1.0.0-rc.8",
   "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)",