@antora/assembler 1.0.0-rc.2 → 1.0.0-rc.4

package/lib/assemble-content.js

@@ -11,7 +11,7 @@ const produceAssemblyFiles = require('./produce-assembly-files')
 const PromiseQueue = require('./util/promise-queue')
 const runCommand = require('@antora/run-command-helper')
 
-const invariably = { new: () => ({}), void: () => undefined }
+const invariably = { true: () => true, false: () => false, new: () => ({}), void: () => undefined }
 const PACKAGE_NAME = require('../package.json').name
 const NEWLINE_RX = /(?:\r?\n)+/
 
@@ -25,8 +25,8 @@ async function assembleContent (playbook, contentCatalog, converter, { configSou
     mediaType: targetMediaType,
     loggerName = PACKAGE_NAME,
   } = converter ?? {}
-  const assemblerConfig = await loadConfig.call(this, playbook, configSource, '-' + targetBackend)
-  if (assemblerConfig.enabled === false) return []
+  const assemblerConfig = await loadConfig.call(this, configSource, playbook, '-' + targetBackend)
+  if (assemblerConfig.enabled === false || !contentCatalog.publishableFamilies?.has('export')) return []
   const context = isBound(this)
     ? this
     : {
@@ -40,7 +40,7 @@ async function assembleContent (playbook, contentCatalog, converter, { configSou
   assemblyConfig.embedReferenceStyle = embedReferenceStyle
   const profile = (assemblyConfig.profile ??= targetBackend)
   const intrinsicAttributes = { 'loader-assembler': '' }
-  buildConfig.cwd ??= process.cwd()
+  const cwd = (buildConfig.cwd ??= process.cwd())
   if (profile) {
     buildConfig.dir ??= ospath.join(playbook.dir ?? process.cwd(), `build/assembler/${profile}`)
     intrinsicAttributes[`assembler-profile-${profile}`] = ''
@@ -65,35 +65,36 @@ async function assembleContent (playbook, contentCatalog, converter, { configSou
     generateSelectAssemblyProfile(context, contentCatalog, assemblyConfig, intrinsicAttributes, navigationCatalog)
   )
   if (!(assemblyFiles.length && typeof convert === 'function')) return assemblyFiles
-  if (buildConfig.command == null && typeof getDefaultCommand === 'function') {
-    buildConfig.command = await getDefaultCommand(buildConfig.cwd)
-  }
+  buildConfig.command ??= typeof getDefaultCommand === 'function' ? await getDefaultCommand(cwd, playbook) : null
   const { publishSite: publishFiles = require('@antora/site-publisher') } = generatorFunctions
   await prepareWorkspace(publishFiles, assemblyFiles, buildConfig)
   const helpers = { logCommand: logCommand.bind(context, loggerName), runCommand }
   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 = prepareConvertAttributes(doc, targetExtname, relativeToOutput, assemblerConfig)
         if (buildConfig.mkdirs) await fsp.mkdir(convertAttributes.outdir, { recursive: true, force: true })
-        return boundConvert(doc, convertAttributes, buildConfig, helpers).then((result) => {
-          const fileOrContents = resolveFileOrContents.call(context, result, convertAttributes, buildConfig, loggerName)
-          return coerceToExportFormat(doc, targetBackend, targetExtname, targetMediaType, fileOrContents)
-        })
+        return boundConvert(doc, convertAttributes, buildConfig, helpers).then((result) =>
+          boundResolveFileOrContents(result, convertAttributes, buildConfig, loggerName).then((fileOrContents) =>
+            coerceToExportFormat(doc, targetBackend, targetExtname, targetMediaType, fileOrContents)
+          )
+        )
       })
     )
     .toPromise()
     .then((files) => {
-      if (!buildConfig.publish) {
+      const { publish, qualifyExports } = buildConfig
+      if (!publish) {
         for (const file of files) delete file.assembler.assembled
         return files
       }
-      const qualifyExports = buildConfig.qualifyExports
       return files.map((file) => {
-        const pages = file.assembler.assembled.pages
+        const pages = file.isNull() ? undefined : file.assembler.assembled.pages
         delete file.assembler.assembled
+        if (!pages) return file
         file = contentCatalog.addFile(file)
         const extname = file.extname
         const download = file.assembler.downloadStem + extname
@@ -208,10 +209,10 @@ function prepareConvertAttributes (doc, targetExtname, relativeToOutput, assembl
   return Object.defineProperty(attributes, 'toArgs', { enumerable: false })
 }
 
-function coerceToExportFormat (originalFile, targetBackend, targetExtname, targetMediaType, fileOrContents) {
+function coerceToExportFormat (assemblyFile, targetBackend, targetExtname, targetMediaType, fileOrContents) {
   const file =
     fileOrContents == null || Buffer.isBuffer(fileOrContents) || typeof fileOrContents.pipe === 'function'
-      ? Object.assign(originalFile, { contents: fileOrContents })
+      ? Object.assign(assemblyFile, { contents: fileOrContents })
       : fileOrContents
   ;(file.assembler ??= {}).backend = targetBackend
   if (file.extname === targetExtname) return file
@@ -253,7 +254,7 @@ function prepareWorkspace (publishFiles, assemblyFiles, buildConfig) {
   })
 }
 
-function resolveFileOrContents (convertResult, convertAttributes, buildConfig, loggerName) {
+async function resolveFileOrContents (convertResult, convertAttributes, buildConfig, loggerName) {
   let fileOrContents
   if (convertResult?.status != null) {
     if ('file' in convertResult) {
@@ -292,9 +293,10 @@ function resolveFileOrContents (convertResult, convertAttributes, buildConfig, l
   } else if (convertResult !== undefined) {
     return convertResult
   }
-  return fileOrContents === undefined
-    ? new LazyReadable(() => fs.createReadStream(convertAttributes.outfile))
-    : fileOrContents
+  if (fileOrContents !== undefined) return fileOrContents
+  const outfile = convertAttributes.outfile
+  const outfileExists = await fsp.access(outfile).then(invariably.true, invariably.false)
+  return outfileExists ? new LazyReadable(() => fs.createReadStream(outfile)) : null
 }
 
 function isBound (obj) {

package/lib/load-config.js

@@ -10,7 +10,7 @@ const { LEGACY_ASSEMBLY_KEYS } = require('./constants')
 const CAMEL_CASE_STOP_PATHS = ['asciidoc.attributes', 'assembly.attributes']
 const PACKAGE_NAME = require('../package.json').name
 
-function loadConfig (playbook, configSource, preferredQualifier = '') {
+function loadConfig (configSource, playbook, preferredQualifier = '') {
   let resolvedConfigSource
   return (
     configSource?.constructor === Object
@@ -52,7 +52,7 @@ function loadConfig (playbook, configSource, preferredQualifier = '') {
     }
     if (componentVersionFilter.names == null) {
       componentVersionFilter.names = ['*']
-    } else if (typeof componentVersionFilter.names === 'string') {
+    } else if (componentVersionFilter.names.constructor === String) {
       componentVersionFilter.names = componentVersionFilter.names.split(', ')
     }
     const remapAssemblyKeys = !('assembly' in config)
@@ -102,7 +102,7 @@ function loadConfig (playbook, configSource, preferredQualifier = '') {
     if (command) {
       if (command.constructor !== String) {
         build.command = String(command)
-      } else if (command.includes('$')) {
+      } else if (~command.indexOf('$')) {
         const vars = {
           $NODE: process.execPath,
           $NPM: ospath.join(process.execPath, '../npm'),

package/lib/produce-assembly-file.js

@@ -101,7 +101,7 @@ function prepareAsciiDocConfig (contentCatalog, ctx, pagesInOutline, asciidocCon
     if (configShared == null) {
       const assets = pagesInOutline.assembled.assets
       for (const [name, val] of Object.entries(sharedAttributes)) {
-        if (!(typeof val === 'string' && ~val.indexOf(':'))) continue
+        if (!(val?.constructor === String && ~val.indexOf(':'))) continue
         let newVal
         if (!name.endsWith('-image') || !(newVal = rewriteImageAttr(val, contentCatalog, assemblyModel, ctx, assets))) {
           if (~(newVal = val).indexOf('image:')) {
@@ -112,7 +112,7 @@ function prepareAsciiDocConfig (contentCatalog, ctx, pagesInOutline, asciidocCon
       }
     }
     for (const [name, val] of Object.entries(sharedAttributes)) {
-      if (!(typeof val === 'string' && ~val.indexOf(':'))) continue
+      if (!(val?.constructor === String && ~val.indexOf(':'))) continue
       if (~val.indexOf('xref:')) {
         const newVal = rewriteXrefs(val, contentCatalog, assemblyModel, ctx, false, pagesInOutline, idSeparators)
         if (newVal !== val) (attributesModified ??= {})[name] = newVal
@@ -133,7 +133,7 @@ function buildAsciiDocHeader (componentVersion, navtitle, assemblyModel) {
   const buffer = [
     `= ${doctitle}`,
     ...(version ? [`:revnumber: ${displayVersion}`] : []),
-    ...(doctype === 'article' ? [] : [`:doctype: ${doctype ?? 'book'}`]),
+    ...(doctype === 'article' ? [] : [`:doctype: ${doctype}`]),
     ':underscore: _',
     // Q: should we pass these via the CLI so they cannot be modified?
     `:page-component-name: ${componentVersion.name}`,
@@ -172,15 +172,15 @@ function mergeAsciiDoc (
   level = 0,
   supportsParts = false
 ) {
+  const { items = [], roles = [], unresolved, urlType, url, hash } = outlineEntry
   // TODO: we could try to be smart about it and make sure the page with fragment is included at least once
-  if (outlineEntry.hash) {
+  if (hash || roles.includes('site-only')) {
     buffer.inBody ??= false
     return buffer
   }
   let navtitle = outlineEntry.navtitle ?? outlineEntry.content
   let navtitlePlain = sanitize(navtitle)
   let navtitleAsciiDoc = unconvertInlineAsciiDoc(navtitle)
-  const { items = [], roles = [], unresolved, urlType, url } = outlineEntry
   const { filetype, linkReferenceStyle, pubRoot, sectionMergeStrategy, siteRoot, logger, rootLevel } = assemblyModel
   const assembled = pagesInOutline.assembled
   // FIXME: ideally, resource ID would be stored in navigation so we can look up the page more efficiently
@@ -194,10 +194,8 @@ function mergeAsciiDoc (
       buffer.inBody ??= false
       return buffer
     }
-    const isRootPage = atDocumentRoot && !level
-    const { component, version, module: module_, relative, origin, mediaType } = page.src
     const pageAsAsciiDoc = new page.constructor(
-      Object.assign({}, page, { contents: trimAsciiDoc(contents), mediaType })
+      Object.assign({}, page, { contents: trimAsciiDoc(contents), mediaType: page.src.mediaType })
     )
     const doc = loadAsciiDoc(pageAsAsciiDoc, contentCatalog, asciidocConfig)
     doc.logger = logger
@@ -210,6 +208,8 @@ function mergeAsciiDoc (
         })
       : doc.getLogger()
     doc.source_header_attributes ??= doc.parent.$to_h()
+    const isRootPage = atDocumentRoot && !level
+    const { component, version, module: module_, relative, origin } = page.src
     if (isRootPage && doc.hasAttribute('assembly-slug')) buffer.slug = doc.getAttribute('assembly-slug')
     let hasAssemblyNavtitleAttr
     if ((hasAssemblyNavtitleAttr = !!doc.getAttribute('assembly-navtitle'))) {
@@ -365,10 +365,10 @@ function mergeAsciiDoc (
           }
         }
       }
-      if (htitleAsciiDoc != null) {
+      if (htitleAsciiDoc) {
         if (atDocumentRoot) {
-          // NOTE use pageStyle as fallback because this section must have a unique ID
-          pageFragment = `#${pageIdLeader}${doc.getId() ?? pageStyle}`
+          // Q: should we use htitleAsciiDoc to generate ID if not {empty} instead of pageStyle
+          pageFragment = `#_${idSeparators.coordinate}${pageIdLeader}${pageStyle}`
           buffer.unshift(`[#${pageId}]`)
         } else {
           pageFragment = `#${pageId}`
@@ -393,31 +393,30 @@ function mergeAsciiDoc (
     } else if (atBookRoot) {
       nextSectionLevel = undefined
     }
-    let enclosed
     if (heading) {
       const rolesAttr = pageRoles.reduce((str, it) => str + '.' + it, '')
       const notitleAttrs = heading.notitle ? '%notitle,toclevels=0,outlinelevels=0' : ''
       buffer.push(`[${heading.style ?? pageStyle}${pageFragment}${rolesAttr}${notitleAttrs}]`)
       buffer.push(`${'='.repeat(heading.level)} ${heading.title}`)
-    } else {
-      if (atDocumentRoot) buffer.unshift(`[#${pageId}]`)
-      if (sectionMergeStrategy === 'enclose' && hasItems && hasSections) {
-        enclosed = true
-        // TODO: make overview section title configurable
-        //let overviewTitle = doc.getDocumentTitle()
-        //if (overviewTitle === navtitle) overviewTitle = doc.getAttribute('overview-title', 'Overview')
-        const overviewTitle = doc.getAttribute('overview-title', 'Overview')
-        const syntheticId = idSeparators.generateIdFromTitle(navtitleAsciiDoc, idSeparators)
-        let hlevel = level + 2
-        if (hlevel > 6) {
-          const blockStyle = `discrete.h${hlevel}`
-          hlevel = 6
-          buffer.push(`[${blockStyle}#${syntheticId}]`)
-        } else {
-          buffer.push(`[#${syntheticId}]`)
-        }
-        buffer.push(`${'='.repeat(hlevel)} ${overviewTitle}`)
+    } else if (atDocumentRoot) {
+      buffer.unshift(`[#${pageId}]`)
+    }
+    if (sectionMergeStrategy === 'enclose' && hasItems && hasSections && !(atDocumentRoot && heading)) {
+      // TODO: make overview section title configurable
+      //let overviewTitle = doc.getDocumentTitle()
+      //if (overviewTitle === navtitle) overviewTitle = doc.getAttribute('overview-title', 'Overview')
+      const overviewTitle = doc.getAttribute('overview-title', 'Overview')
+      const syntheticId = idSeparators.generateIdFromTitle(overviewTitle, idSeparators, pageIdLeader)
+      if (heading) buffer.push('')
+      let hlevel = level + (nextSectionLevel = 2)
+      if (hlevel > 6) {
+        const blockStyle = `discrete.h${hlevel}`
+        hlevel = 6
+        buffer.push(`[${blockStyle}#${syntheticId}]`)
+      } else {
+        buffer.push(`[#${syntheticId}]`)
       }
+      buffer.push(`${'='.repeat(hlevel)} ${overviewTitle}`)
     }
     assembled.pages.set(page, pageFragment)
     if (hasSections) fixSectionLevels(doc.getSections(), nextSectionLevel)
@@ -545,7 +544,7 @@ function mergeAsciiDoc (
         if (block.getSectionName() === 'header') return
         let blockStyle = sectionMergeStrategy === 'discrete' ? 'discrete' : undefined
         lines[idx] = lines[idx].replace(/^=+ (.+)/, (_, rest) => {
-          let targetMarkerLength = block.level + 1 + level + (enclosed ? 1 : 0)
+          let targetMarkerLength = block.level + 1 + level
           if (targetMarkerLength > 6) {
             blockStyle = `discrete.h${targetMarkerLength}`
             targetMarkerLength = 6
@@ -806,9 +805,10 @@ function safePush (onto, entries) {
   }
 }
 
-function generateIdFromTitle (titleAsciiDoc, idSeparators) {
+function generateIdFromTitle (titleAsciiDoc, idSeparators, idLeader) {
   const Section = this.$class().$const_get('::Asciidoctor::Section')
   const baseId = Section.$generate_id(titleAsciiDoc, this)
+  if (idLeader) return `_${idSeparators.coordinate}${idLeader}${baseId}`
   this.getCatalog().refs['$[]='](baseId, true)
   return `_${idSeparators.coordinate}${baseId}`
 }

package/lib/util/generate-scoped-id.js

@@ -6,6 +6,7 @@ function generateScopedId (componentSrc, componentVersion, separators, filetype,
   let { component, module: mod, relative } = componentSrc
   let id = relative.replace(/\.adoc$/, '').replace(/[/.]/g, '-')
   let { coordinate: coordinateSeparator, prefix: prefixSeparator } = separators
+  if (mod !== 'ROOT' && ~mod.indexOf('.')) mod = mod.replace(/[.]/g, '-')
   if (component !== componentVersion.name) {
     id = [component, mod === 'ROOT' ? '' : mod, id].join(coordinateSeparator)
   } else if (mod !== 'ROOT') {

package/lib/util/lazy-readable.js

@@ -8,7 +8,13 @@ class LazyReadable extends PassThrough {
     super(options)
     this._read = function () {
       delete this._read // restores original method
-      fn.call(this, options).on('error', this.emit.bind(this, 'error')).pipe(this)
+      fn.call(this, options)
+        .on('error', (err) => {
+          let msg = 'Failed to create stream'
+          if (err.syscall === 'open') msg += ` for path '${err.path}'`
+          this.emit('error', new Error(msg, { cause: err }))
+        })
+        .pipe(this)
       return this._read.apply(this, arguments)
     }
     this.emit('readable')

package/lib/util/matcher.js

@@ -27,7 +27,7 @@ function filterCollection (candidates, patterns, opts = {}) {
 }
 
 function compilePattern (str) {
-  const negated = str.charAt() === '!' ? typeof (str = str.substring(1)) === 'string' : false
+  const negated = str.charAt() === '!' ? (str = str.substring(1)).constructor === String : false
   if (str === '**') return Object.assign(new RegExp(), { globstar: true, negated })
   if (str === '*') return Object.assign(new RegExp(), { star: true, negated })
   const buffer = { result: '', brace: undefined, group: undefined }

package/package.json

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