@antora/assembler 1.0.0-beta.17 → 1.0.0-beta.18

package/lib/configure.js

@@ -16,8 +16,17 @@ function internalConfigure (converter, config = {}, providers = {}) {
 
   this.once('navigationBuilt', async ({ playbook, contentCatalog }) => {
     const { assembleContent = require('./assemble-content'), ...assembleContentConfig } = providers
-    assembleContentConfig.configSource ??= config.configFile
-    await assembleContent.call(this, playbook, contentCatalog, converter, assembleContentConfig)
+    if (assembleContentConfig.configSource?.constructor === Object) {
+      await assembleContent.call(this, playbook, contentCatalog, converter, assembleContentConfig)
+    } else {
+      const singleConfig = !('configFiles' in config)
+      const configFiles = singleConfig ? config.configFile : config.configFiles
+      for (const configSource of Array.isArray(configFiles) ? configFiles : [configFiles]) {
+        const assembleContentConfigWithConfigSource = Object.assign({}, assembleContentConfig, { configSource })
+        await assembleContent.call(this, playbook, contentCatalog, converter, assembleContentConfigWithConfigSource)
+        if (singleConfig) break
+      }
+    }
   })
 }
 

package/lib/produce-assembly-file.js

@@ -2,9 +2,10 @@
 
 const createAsciiDocFile = require('./util/create-asciidoc-file')
 const createResourceKey = require('./util/create-resource-key')
-const generateId = require('./util/generate-id')
+const generateScopedId = require('./util/generate-scoped-id')
 const { resolveLinkTarget } = require('./util/resolver')
 const { rewriteXrefs, rewriteImageRef, rewriteInlineImages, rewriteStyleAttribute } = require('./util/rewriter')
+const { NamedIdAttrRx } = require('./util/rx')
 const sanitize = require('./util/sanitize')
 const unconvertInlineAsciiDoc = require('./util/unconvert-inline-asciidoc')
 
@@ -25,7 +26,14 @@ function produceAssemblyFile (
 ) {
   const pagesByUrl = files.reduce((map, it) => (it.src.family === 'page' ? map.set(it.pub.url, it) : map), new Map())
   if (outline.urlType === 'internal' && !pagesByUrl.get(outline.url) && !(outline.items || []).length) return
-  const pagesInOutline = selectPagesInOutline(outline, pagesByUrl, componentVersion)
+  const pagesInOutline = selectPagesInOutline(outline, pagesByUrl)
+  pagesInOutline.generateIdFromTitle = generateIdFromTitle.bind(
+    loadAsciiDoc(
+      { contents: Buffer.alloc(0), src: { family: 'page', relative: 'generate-id.adoc' } },
+      undefined,
+      asciidocConfig
+    )
+  )
   const buffer = mergeAsciiDoc(
     loadAsciiDoc,
     contentCatalog,
@@ -64,29 +72,30 @@ function buildAsciiDocHeader (componentVersion, navtitle, assemblyModel) {
   let doctitle = navtitleAsciiDoc
   if (navtitlePlain !== componentVersion.title) doctitle = `${componentVersion.title}: ${doctitle}`
   const version = componentVersion.version === 'master' ? '' : componentVersion.version
+  const displayVersion = componentVersion.displayVersion
   const buffer = [
     `= ${doctitle}`,
-    ...(version ? [`:revnumber: ${version}`] : []),
+    ...(version ? [`:revnumber: ${displayVersion}`] : []),
     ...(doctype === 'article' ? [] : [`:doctype: ${doctype ?? 'book'}`]),
     ':underscore: _',
     // Q: should we pass these via the CLI so they cannot be modified?
     `:page-component-name: ${componentVersion.name}`,
     `:page-component-version:${version ? ' ' + version : ''}`,
     ':page-version: {page-component-version}',
-    `:page-component-display-version: ${componentVersion.displayVersion}`,
+    `:page-component-display-version: ${displayVersion}`,
     `:page-component-title: ${componentVersion.title}`,
   ]
   return Object.assign(buffer, { navtitle })
 }
 
-function selectPagesInOutline (outlineEntry, pagesByUrl, componentVersion, accum) {
+function selectPagesInOutline (outlineEntry, pagesByUrl, accum) {
   accum ??= Object.assign(new Map(), { assembled: { pages: new Map(), assets: new Set() } })
   const page = outlineEntry.urlType === 'internal' ? pagesByUrl.get(outlineEntry.url) : undefined
   if (page) {
     accum.set(createResourceKey(page.src), page)
     accum.set(outlineEntry.url, page)
   }
-  for (const item of outlineEntry.items || []) selectPagesInOutline(item, pagesByUrl, componentVersion, accum)
+  for (const item of outlineEntry.items || []) selectPagesInOutline(item, pagesByUrl, accum)
   return accum
 }
 
@@ -114,7 +123,7 @@ function mergeAsciiDoc (
   let navtitlePlain = sanitize(navtitle)
   let navtitleAsciiDoc = unconvertInlineAsciiDoc(navtitle)
   const { items = [], unresolved, urlType, url } = outlineEntry
-  const { doctype, linkReferenceStyle, pubRoot, siteRoot, xmlIds, logger } = assemblyModel
+  const { doctype, filetype, linkReferenceStyle, pubRoot, siteRoot, xmlIds, logger } = 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
@@ -173,12 +182,13 @@ function mergeAsciiDoc (
     }
     // NOTE: in Antora, docname is relative src path from module without file extension
     const docname = doc.getAttribute('docname')
-    const { idLeader, id: idScope } = generateId(
+    const { idLeader: idScopeLeader, id: idScope } = generateScopedId(
       page.src,
       componentVersion,
       idCoordinateSeparator,
       idScopeSeparator,
-      idPrefix
+      idPrefix,
+      filetype
     )
     let pageFragment = ''
     let pageRoles = ''
@@ -235,7 +245,7 @@ function mergeAsciiDoc (
         assemblyModel = Object.assign({}, assemblyModel, { sectionMergeStrategy: 'discrete' })
       } else {
         if (atDocumentRoot) {
-          pageFragment = `#${idLeader}${doc.getId() ?? pageStyle}`
+          pageFragment = `#${idScopeLeader}${doc.getId() ?? pageStyle}`
           buffer.unshift(`[#${idScope}]`)
         } else {
           pageFragment = `#${idScope}`
@@ -268,26 +278,16 @@ function mergeAsciiDoc (
       //if (overviewTitle === navtitle) overviewTitle = doc.getAttribute('overview-title', 'Overview')
       const overviewTitle = doc.getAttribute('overview-title', 'Overview')
       buffer.push('')
-      // NOTE: try to toggle sectids; otherwise, fallback to globally unique synthetic ID
-      let toggleSectids, syntheticId
-      if (doc.isAttribute('sectids')) {
-        if (doc.isAttributeLocked('sectids')) {
-          syntheticId = `__object-id-${getObjectId(outlineEntry)}`
-        } else {
-          buffer.push(':!sectids:')
-          toggleSectids = true
-        }
-      }
+      const syntheticId = pagesInOutline.generateIdFromTitle(navtitleAsciiDoc, idCoordinateSeparator)
       let hlevel = level + 2
       if (hlevel > 6) {
         const blockStyle = `discrete.h${hlevel}`
         hlevel = 6
-        buffer.push(syntheticId ? `[${blockStyle}#${syntheticId}]` : `[${blockStyle}]`)
-      } else if (syntheticId) {
+        buffer.push(`[${blockStyle}#${syntheticId}]`)
+      } else {
         buffer.push(`[#${syntheticId}]`)
       }
       buffer.push(`${'='.repeat(hlevel)} ${overviewTitle}`)
-      if (toggleSectids) buffer.push(':sectids:')
     }
     assembled.pages.set(page, pageFragment)
     if (doc.hasSections()) {
@@ -375,13 +375,13 @@ function mergeAsciiDoc (
           if (!refs['$key?'](refid) && (~refid.indexOf(' ') || refid.toLowerCase() !== refid)) {
             if ((refid = doc.$resolve_id(refid))['$nil?']()) return m
           }
-          return `<<${idLeader}${refid}${text ? ',' + text : ''}>>`
+          return `<<${idScopeLeader}${refid}${text ? ',' + text : ''}>>`
         })
       }
       // NOTE: the next check takes care of inline and block anchors
       if (~line.indexOf('[[')) {
         line = line.replace(/\[\[([\p{Alpha}_:][\p{Alpha}0-9_\-:.]*)(|, *.+?)\]\]/gu, (_, refid, text) => {
-          return `[[${idLeader}${refid}${text}]]`
+          return `[[${idScopeLeader}${refid}${text}]]`
         })
       }
       if (~line.indexOf('xref:')) {
@@ -394,7 +394,7 @@ function mergeAsciiDoc (
           idCoordinateSeparator,
           idScopeSeparator,
           idPrefix,
-          idLeader,
+          idScopeLeader,
           pagesInOutline,
           doc,
           { file: relative, lineno: idx + 1 }
@@ -427,7 +427,7 @@ function mergeAsciiDoc (
           return '='.repeat(targetMarkerLength) + ' ' + rest
         })
         // NOTE: ID will be undefined if sectids are turned off
-        if (block.getId()) rewriteStyleAttribute(block, lines, idx, idLeader, blockStyle)
+        if (block.getId()) rewriteStyleAttribute(block, lines, idx, idScopeLeader, blockStyle)
       } else {
         if (context === 'image') {
           let line = lines[idx] || ''
@@ -456,7 +456,7 @@ function mergeAsciiDoc (
           // nested document
           idx = (block.getHeader().getLineNumber() || idx + 1) - 1
         }
-        if (block.getId()) rewriteStyleAttribute(block, lines, idx, idLeader)
+        if (block.getId()) rewriteStyleAttribute(block, lines, idx, idScopeLeader)
       }
     })
     safePush(
@@ -491,20 +491,7 @@ function mergeAsciiDoc (
     } else {
       buffer.inBody = true
       buffer.push('')
-      // NOTE: try to toggle sectids; otherwise, fallback to globally unique synthetic ID
-      // Q: should we unset docname, page-module, etc?
-      let toggleSectids, syntheticId
-      if (!('sectids' in asciidocConfig.attributes)) {
-        buffer.push(':!sectids:')
-        toggleSectids = true
-      } else if (typeof asciidocConfig.attributes.sectids === 'string') {
-        if ('sectids' in mutableAttributes) {
-          buffer.push(':!sectids:')
-          toggleSectids = true
-        } else {
-          syntheticId = `__object-id-${global.Opal.hash(outlineEntry).$object_id()}`
-        }
-      }
+      const syntheticId = pagesInOutline.generateIdFromTitle(navtitleAsciiDoc, idCoordinateSeparator)
       let sectionTitle = navtitleAsciiDoc
       if (urlType === 'external') {
         sectionTitle = `${url}[${navtitleAsciiDoc.replace(/\]/g, '\\]')}]`
@@ -512,14 +499,15 @@ function mergeAsciiDoc (
         const resource = files.find((it) => it.pub.url === url)
         if (resource) {
           if (resource.src.family === 'page' && pagesInOutline.has(resource.pub.url)) {
-            const refid = generateId(
+            const { id: refid } = generateScopedId(
               resource.src,
               componentVersion,
               idCoordinateSeparator,
               idScopeSeparator,
               idPrefix,
+              filetype,
               true
-            ).id
+            )
             sectionTitle = `xref:${refid}[${navtitleAsciiDoc.replace(/\]/g, '\\]')}]`
           } else if (siteRoot) {
             sectionTitle = `${resolveLinkTarget(resource, siteRoot, pubRoot, linkReferenceStyle, true)}[${navtitleAsciiDoc.replace(/\]/g, '\\]')}]`
@@ -529,12 +517,11 @@ function mergeAsciiDoc (
       let hlevel = level + 1
       if (hlevel > 6) {
         hlevel = 6
-        buffer.push(syntheticId ? `[discrete#${syntheticId}]` : '[discrete]')
-      } else if (syntheticId) {
+        buffer.push(`[discrete#${syntheticId}]`)
+      } else {
         buffer.push(`[#${syntheticId}]`)
       }
       buffer.push(`${'='.repeat(hlevel)} ${sectionTitle}`)
-      if (toggleSectids) buffer.push(':sectids:')
     }
   }
 
@@ -610,6 +597,7 @@ function processDocumentHeader (doc, lines, buffer, ignoreLines) {
           .slice(1, -1)
           .trim()
           .replace(/(?:^\w[\w-]*(?!=|[\w-]))?([#.%]\w[\w-]*)*/, '')
+          .replace(NamedIdAttrRx, '')
         if (attrlist) buffer.push('[' + attrlist + ']')
       }
     } else if (belowDoctitle) {
@@ -645,10 +633,6 @@ function fixSectionLevels (sections, expectedLevel) {
   })
 }
 
-function getObjectId (obj) {
-  return global.Opal.id(obj)
-}
-
 // 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)
@@ -671,4 +655,11 @@ function safePush (onto, entries) {
   }
 }
 
+function generateIdFromTitle (titleAsciiDoc, sep) {
+  const Section = this.$class().$const_get('::Asciidoctor::Section')
+  const baseId = Section.$generate_id(titleAsciiDoc, this)
+  this.getCatalog().refs['$[]='](baseId, true)
+  return `_${sep}${baseId}`
+}
+
 module.exports = produceAssemblyFile

package/lib/util/{generate-id.js → generate-scoped-id.js}

@@ -2,7 +2,7 @@
 
 const ReservedIdNames = 'content header footnotes footer footer-text premable toc toctitle'.split(' ')
 
-function generateId (componentSrc, componentVersion, coordinateSep, scopeSep, prefix, asXrefTarget, fragment) {
+function generateScopedId (componentSrc, componentVersion, coordinateSep, scopeSep, prefix, filetype, asXrefTarget) {
   let { component, module: mod, relative } = componentSrc
   let id = relative.replace(/\.adoc$/, '').replace(/[/.]/g, '-')
   if (component !== componentVersion.name) {
@@ -13,13 +13,13 @@ function generateId (componentSrc, componentVersion, coordinateSep, scopeSep, pr
       mod = mod.replace(/(?:pass|stem)$/, '\\$&')
     }
     id = mod + coordinateSep + id
-  } else if (ReservedIdNames.includes(id)) {
-    id += scopeSep
-    scopeSep = ''
+  } else if (filetype === 'html' && ReservedIdNames.includes(id)) {
+    id = prefix + id
+    prefix = ''
   }
   if (prefix && !/^[\p{Alpha}_:]/u.test(id)) id = prefix + id
   const idLeader = id + scopeSep
-  return { idLeader, id: fragment ? idLeader + fragment : id }
+  return { idLeader, id }
 }
 
-module.exports = generateId
+module.exports = generateScopedId

package/lib/util/rewriter.js

@@ -1,9 +1,10 @@
 'use strict'
 
 const createResourceKey = require('./create-resource-key')
-const generateId = require('./generate-id')
-const { resolveEmbedTarget, resolveLinkTarget } = require('./resolver')
+const generateScopedId = require('./generate-scoped-id')
 const parseResourceRef = require('./parse-resource-ref')
+const { resolveEmbedTarget, resolveLinkTarget } = require('./resolver')
+const { NamedIdAttrRx } = require('./rx')
 
 function rewriteXrefs (
   line,
@@ -96,16 +97,16 @@ function rewriteXref (
     text = ''
   }
   const componentVersionCtx = { name: ctx.component, version: ctx.version }
-  const refid = generateId(
+  const { idLeader: refidLeader, id: refid } = generateScopedId(
     resource.src,
     componentVersionCtx,
     idCoordinateSep,
     idScopeSep,
     idPrefix,
-    text.length > 0,
-    fragment
-  ).id
-  return `xref:${refid}[${text}]`
+    assemblyModel.filetype,
+    text.length > 0
+  )
+  return `xref:${fragment ? refidLeader + fragment : refid}[${text}]`
 }
 
 function rewriteImageAttr (val, contentCatalog, assemblyModel, ctx, assets) {
@@ -160,6 +161,8 @@ function rewriteStyleAttribute (block, lines, idx, idLeader, replacementStyle =
     if (cellSpec) {
       prevLine = cellSpec[2]
       cellSpec = cellSpec[1]
+    } else if (~prevLine.indexOf('id=')) {
+      prevLine = `[${prevLine.slice(1, -1).replace(NamedIdAttrRx, '')}]`
     }
     let rawStyle
     const commaIdx = prevLine.indexOf(',')

package/lib/util/rx.js

@@ -0,0 +1,5 @@
+'use strict'
+
+const NamedIdAttrRx = /(?:^|, *)id=(?:("[^"]*"|'[^']*'|[^,]*))/
+
+module.exports = { NamedIdAttrRx }

package/package.json

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