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

package/lib/assemble-content.js

@@ -23,10 +23,11 @@ async function assembleContent (playbook, contentCatalog, converter, { configSou
     backend: targetBackend = targetExtname.substring(1),
     embedReferenceStyle = 'relative',
     mediaType: targetMediaType,
-    loggerName = PACKAGE_NAME,
+    loggerName = `${PACKAGE_NAME} [${targetBackend}-exporter]`,
+    xmlCompliant,
   } = 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
     : {
@@ -38,9 +39,10 @@ async function assembleContent (playbook, contentCatalog, converter, { configSou
   const { loadAsciiDoc = require('@antora/asciidoc-loader') } = generatorFunctions
   const { assembly: assemblyConfig, build: buildConfig } = assemblerConfig
   assemblyConfig.embedReferenceStyle = embedReferenceStyle
+  if (xmlCompliant) assemblyConfig.xmlIds ??= true
   const profile = (assemblyConfig.profile ??= targetBackend)
-  const intrinsicAttributes = { 'loader-assembler': '' }
-  buildConfig.cwd ??= process.cwd()
+  const intrinsicAttributes = { 'loader-assembler': '', 'assembler-root-level': assemblyConfig.rootLevel }
+  const cwd = (buildConfig.cwd ??= process.cwd())
   if (profile) {
     buildConfig.dir ??= ospath.join(playbook.dir ?? process.cwd(), `build/assembler/${profile}`)
     intrinsicAttributes[`assembler-profile-${profile}`] = ''
@@ -65,7 +67,7 @@ async function assembleContent (playbook, contentCatalog, converter, { configSou
     generateSelectAssemblyProfile(context, contentCatalog, assemblyConfig, intrinsicAttributes, navigationCatalog)
   )
   if (!(assemblyFiles.length && typeof convert === 'function')) return assemblyFiles
-  buildConfig.command ??= typeof getDefaultCommand === 'function' ? await getDefaultCommand(buildConfig.cwd) : null
+  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 }
@@ -150,16 +152,21 @@ function generateSelectAssemblyProfile (context, contentCatalog, baseModel, intr
     const attributes = Object.assign({}, baseModel.attributes)
     const model = Object.assign({}, baseModel, overrides, { attributes, logger })
     if (!overrides) return Object.assign(model, { navigation: navigation || componentVersion.navigation })
+    if ('rootLevel' in overrides) attributes['assembler-root-level'] = overrides.rootLevel
     delete model.navFiles
     delete model.messages
-    if (overrides.attributes) Object.entries(overrides.attributes).forEach(([name, val]) => (attributes[name] = val))
+    if (overrides.attributes) {
+      for (const [name, val] of Object.entries(overrides.attributes)) {
+        if (!(name in intrinsicAttributes)) attributes[name] = val
+      }
+    }
     if (navigation) return Object.assign(model, { navigation })
     overrides.messages?.forEach(boundSendToLog)
     const navFiles = overrides.navFiles
     if (!navFiles) return Object.assign(model, { navigation: componentVersion.navigation })
     if (!navFiles.length) return Object.assign(model, { navigation: [] })
     model.navigation = buildAlternateNavigation(contentCatalog, componentVersion, navFiles, {
-      attributes: intrinsicAttributes,
+      attributes: model.attributes,
     })
     return model
   }
@@ -182,7 +189,7 @@ function prepareConvertAttributes (doc, targetExtname, relativeToOutput, assembl
     docdir,
     docfile,
     docfilesuffix,
-    'docname@': docname,
+    docname: `${docname}@`,
     imagesdir: '',
     outdir,
     outfile,
@@ -206,6 +213,17 @@ function prepareConvertAttributes (doc, targetExtname, relativeToOutput, assembl
       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
+    },
+  })
   return Object.defineProperty(attributes, 'toArgs', { enumerable: false })
 }
 
@@ -265,12 +283,14 @@ async function resolveFileOrContents (convertResult, convertAttributes, buildCon
       fileOrContents = convertResult.stdout
     }
     let logger, match
-    if (buildConfig.stderrSink === 'log' && convertResult.stderr.length && (logger = this.getLogger(loggerName))) {
+    if (buildConfig.stderrSink === 'log' && convertResult.stderr?.length && (logger = this.getLogger(loggerName))) {
       const docfile = convertAttributes.docfile
       const command = buildConfig.command
+      const file = { path: docfile }
       const stderr = convertResult.stderr.toString().trimEnd()
+      const additionalLines = ['Additional stderr lines from command:']
       stderr.split(NEWLINE_RX).forEach((line) => {
-        const ctx = { command, file: { path: docfile } }
+        const ctx = { command, file }
         if (line.charAt() === '{' && line.charAt(line.length - 1) === '}') {
           const entry = JSON.parse(line)
           if (entry.name) ctx.program = entry.name
@@ -286,9 +306,10 @@ async function resolveFileOrContents (convertResult, convertAttributes, buildCon
           if (lineno) ctx.line = parseInt(lineno, 10)
           logger[level === 'WARNING' ? 'warn' : level.toLowerCase()](ctx, msg)
         } else {
-          logger.info(ctx, line)
+          additionalLines.push(line)
         }
       })
+      if (additionalLines.length > 1) logger.info({ command, file }, additionalLines.join('\n'))
     }
   } else if (convertResult !== undefined) {
     return convertResult

package/lib/configure.js

@@ -17,7 +17,8 @@ function internalConfigure (converter, config = {}, providers = {}) {
 
   this.once('navigationBuilt', async ({ playbook, contentCatalog }) => {
     const { assembleContent = require('./assemble-content'), ...assembleContentConfig } = providers
-    if (assembleContentConfig.configSource?.constructor === Object) {
+    if (config.configSource?.constructor === Object) {
+      assembleContentConfig.configSource = config.configSource
       await assembleContent.call(this, playbook, contentCatalog, converter, assembleContentConfig)
     } else {
       const singleConfig = !('configFiles' in config)

package/lib/load-config.js

@@ -9,8 +9,9 @@ const yaml = require('js-yaml')
 const { LEGACY_ASSEMBLY_KEYS } = require('./constants')
 const CAMEL_CASE_STOP_PATHS = ['asciidoc.attributes', 'assembly.attributes']
 const PACKAGE_NAME = require('../package.json').name
+const YAML_SCHEMA = yaml.CORE_SCHEMA.withTags(yaml.mergeTag)
 
-function loadConfig (playbook, configSource, preferredQualifier = '') {
+function loadConfig (configSource, playbook, preferredQualifier = '') {
   let resolvedConfigSource
   return (
     configSource?.constructor === Object
@@ -36,11 +37,11 @@ function loadConfig (playbook, configSource, preferredQualifier = '') {
               }
               return {}
             }
-            return fsp
-              .readFile(resolvedConfigSource)
-              .then((data) =>
-                Object.assign(camelCaseKeys(yaml.load(data), CAMEL_CASE_STOP_PATHS), { file: resolvedConfigSource })
-              )
+            return fsp.readFile(resolvedConfigSource).then((data) =>
+              Object.assign(camelCaseKeys(yaml.load(data, { schema: YAML_SCHEMA }), CAMEL_CASE_STOP_PATHS), {
+                file: resolvedConfigSource,
+              })
+            )
           })
   ).then((config) => {
     if (config.enabled === false) return config

package/lib/produce-assembly-file.js

@@ -198,6 +198,7 @@ function mergeAsciiDoc (
       Object.assign({}, page, { contents: trimAsciiDoc(contents), mediaType: page.src.mediaType })
     )
     const doc = loadAsciiDoc(pageAsAsciiDoc, contentCatalog, asciidocConfig)
+    doc.catalog.syntheticIds = {}
     doc.logger = logger
       ? Object.assign(doc.getLogger().$dup(), {
           delegate: {
@@ -365,10 +366,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 +394,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)
@@ -476,7 +476,7 @@ function mergeAsciiDoc (
       if (~ignoreLines.indexOf(idx)) continue
       let line = lines[idx]
       if (line.startsWith('//')) {
-        if (line[2] !== '/') continue
+        if (line.charAt(2) !== '/') continue
         if (line.length > 3 && line === '/'.repeat(line.length)) {
           if (skipping) {
             if (line === skipping) skipping = undefined
@@ -545,7 +545,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,11 +806,20 @@ 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)
-  this.getCatalog().refs['$[]='](baseId, true)
-  return `_${idSeparators.coordinate}${baseId}`
+  const baseId = Section.$generate_id(titleAsciiDoc, this) // refs in catalog will always be empty
+  let id = `_${idSeparators.coordinate}${idLeader ?? ''}${baseId}`
+  const syntheticIds = (this.catalog.syntheticIds ??= {})
+  if (id in syntheticIds) {
+    const sep = (this.getAttribute('idseparator') ?? '_').charAt()
+    let cnt = this.$class().$const_get('::Asciidoctor::Compliance').unique_id_start_index
+    let candidate
+    while ((candidate = `${id}${sep}${cnt}`) in syntheticIds) cnt++
+    id = candidate
+  }
+  syntheticIds[id] = true
+  return id
 }
 
 module.exports = produceAssemblyFile

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/assembler",
-  "version": "1.0.0-rc.3",
+  "version": "1.0.0-rc.5",
   "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.3"
+    "js-yaml": "~5.2"
   },
   "devDependencies": {
     "@antora/asciidoc-loader": "3.2.0-rc.2",