@antora/assembler 1.0.0-rc.1 → 1.0.0-rc.3

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)+/
 
@@ -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(buildConfig.cwd) : 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
@@ -148,7 +149,7 @@ function generateSelectAssemblyProfile (context, contentCatalog, baseModel, intr
     const navigation = navigationCatalog?.getNavigation(componentVersion.name, componentVersion.version)
     const attributes = Object.assign({}, baseModel.attributes)
     const model = Object.assign({}, baseModel, overrides, { attributes, logger })
-    if (!overrides) return navigation ? Object.assign(model, { navigation }) : model
+    if (!overrides) return Object.assign(model, { navigation: navigation || componentVersion.navigation })
     delete model.navFiles
     delete model.messages
     if (overrides.attributes) Object.entries(overrides.attributes).forEach(([name, val]) => (attributes[name] = val))
@@ -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

@@ -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)
@@ -98,14 +98,19 @@ function loadConfig (playbook, configSource, preferredQualifier = '') {
     build.dir &&= expandPath(build.dir, { dot: playbook.dir })
     // used as cwd of command (and any scripts it requires)
     build.cwd = build.cwd == null ? playbook.dir : expandPath(build.cwd, { dot: playbook.dir })
-    if (build.command?.includes('$')) {
-      const vars = {
-        $NODE: process.execPath,
-        $NPM: ospath.join(process.execPath, '../npm'),
-        $NPX: ospath.join(process.execPath, '../npx'),
-        $PWD: build.cwd,
+    const command = build.command
+    if (command) {
+      if (command.constructor !== String) {
+        build.command = String(command)
+      } else if (~command.indexOf('$')) {
+        const vars = {
+          $NODE: process.execPath,
+          $NPM: ospath.join(process.execPath, '../npm'),
+          $NPX: ospath.join(process.execPath, '../npx'),
+          $PWD: build.cwd,
+        }
+        build.command = build.command.replace(/^\$(?:NODE|NP[MX])(?= )|\$PWD\b/g, (ref) => vars[ref])
       }
-      build.command = build.command.replace(/^\$(?:NODE|NP[MX])(?= )|\$PWD\b/g, (ref) => vars[ref])
     }
     if (!('clean' in build) && 'output' in playbook) build.clean = playbook.output.clean
     if (!('publish' in build)) build.publish = true

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,16 +172,16 @@ 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, siteRoot, logger, rootLevel } = assemblyModel
+  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
   const page = urlType === 'internal' && !unresolved ? pagesInOutline.get(url) : undefined
@@ -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'))) {
@@ -231,13 +231,7 @@ function mergeAsciiDoc (
     let pageFragment = ''
     let pageRoles = []
     let pageStyle = doc.getAttribute('assembly-style', '')
-    if (
-      !pageStyle &&
-      atBookRoot &&
-      rootLevel === 0 &&
-      assemblyModel.sectionMergeStrategy === 'fuse' &&
-      !doc.source_header_attributes['$key?']('assembly-style')
-    ) {
+    if (!pageStyle && atBookRoot && rootLevel === 0 && !doc.source_header_attributes['$key?']('assembly-style')) {
       pageStyle = 'preface'
     }
     let part
@@ -248,6 +242,7 @@ function mergeAsciiDoc (
       pageStyle = pageStyle.substring(0, pageStyle.length - 5)
       if (!supportsParts) part = undefined
     }
+    const hasSections = doc.hasSections()
     let nextSectionLevel = 1
     const lines = doc.getSourceLines()
     const ignoreLines = []
@@ -353,15 +348,16 @@ function mergeAsciiDoc (
             ? ''
             : undefined
         if (htitleOverride != null) {
+          const keepSections = hasSections && sectionMergeStrategy !== 'discrete'
           if (htitleOverride === '') {
-            if (headerHasBlockAttrs || doc.hasSections()) {
+            if (headerHasBlockAttrs || keepSections) {
               htitleAsciiDoc = '{empty}'
               notitle = true
             } else {
               if (hasPrefaceTitleAttr) buffer.splice(++buffer.endHeaderIdx, 0, ':preface-title:')
               htitleAsciiDoc = undefined
             }
-          } else if (hasPrefaceTitleAttr && !(headerHasBlockAttrs || doc.hasSections())) {
+          } else if (hasPrefaceTitleAttr && !headerHasBlockAttrs && !keepSections) {
             buffer.splice(++buffer.endHeaderIdx, 0, `:preface-title: ${unconvertInlineAsciiDoc(htitleOverride)}`)
             htitleAsciiDoc = undefined
           } else {
@@ -405,7 +401,7 @@ function mergeAsciiDoc (
       buffer.push(`${'='.repeat(heading.level)} ${heading.title}`)
     } else {
       if (atDocumentRoot) buffer.unshift(`[#${pageId}]`)
-      if (assemblyModel.sectionMergeStrategy === 'enclose' && hasItems && doc.hasSections()) {
+      if (sectionMergeStrategy === 'enclose' && hasItems && hasSections) {
         enclosed = true
         // TODO: make overview section title configurable
         //let overviewTitle = doc.getDocumentTitle()
@@ -424,14 +420,14 @@ function mergeAsciiDoc (
       }
     }
     assembled.pages.set(page, pageFragment)
-    if (doc.hasSections()) fixSectionLevels(doc.getSections(), nextSectionLevel)
+    if (hasSections) fixSectionLevels(doc.getSections(), nextSectionLevel)
     const allBlocks = doc.findBy({ traverse_documents: true }, (it) =>
       it.getContext() === 'document'
         ? it.getDocument().isNested()
         : !(it.getContext() === 'table_cell' && it.getStyle() === 'asciidoc')
     )
     if (doc.getDoctype() === 'manpage') {
-      const firstSectionIdx = doc.hasSections() ? doc.getSections()[0].getLineNumber() - 1 : lines.length
+      const firstSectionIdx = hasSections ? doc.getSections()[0].getLineNumber() - 1 : lines.length
       for (let idx = 0; idx < firstSectionIdx; idx++) {
         if (~ignoreLines.indexOf(idx)) continue
         const line = lines[idx]
@@ -547,7 +543,7 @@ function mergeAsciiDoc (
       let idx = lineno - 1
       if (context === 'section' && !block.getDocument().isNested()) {
         if (block.getSectionName() === 'header') return
-        let blockStyle = (assemblyModel.sectionMergeStrategy || 'discrete') === 'discrete' ? 'discrete' : undefined
+        let blockStyle = sectionMergeStrategy === 'discrete' ? 'discrete' : undefined
         lines[idx] = lines[idx].replace(/^=+ (.+)/, (_, rest) => {
           let targetMarkerLength = block.level + 1 + level + (enclosed ? 1 : 0)
           if (targetMarkerLength > 6) {

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.1",
+  "version": "1.0.0-rc.3",
   "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)",
@@ -41,7 +41,7 @@
     "@asciidoctor/reducer": "~1.1",
     "@antora/expand-path-helper": "~3.0",
     "@antora/run-command-helper": "~1.1",
-    "js-yaml": "~4.2"
+    "js-yaml": "~4.3"
   },
   "devDependencies": {
     "@antora/asciidoc-loader": "3.2.0-rc.2",