@antora/assembler 1.0.0-rc.10 → 1.0.0-rc.11

package/lib/produce-assembly-file.js

@@ -18,12 +18,13 @@ const ATTR_ENTRY_RX = /^:(!?[\p{Alpha}0-9_][^:]*):(?: |$)/u
 const BUILT_IN_NAMED_ENTITIES = { amp: '&', apos: "'", gt: '>', lt: '<', nbsp: ' ', quot: '"' }
 const CHAR_REF_RX = /&(?:([a-z][a-z]+\d{0,2})|#(?:(\d{2,6})|x([a-z\d]{2,5})));/g
 const DISCARD_ATTRIBUTE_NAMES = [
+  'assembly-docname',
+  'assembly-doctitle',
   'assembly-doctype',
   'assembly-header-attributes',
   'assembly-overview-title',
   'assembly-navtitle',
   'assembly-root-title',
-  'assembly-slug',
   'assembly-style',
   'doctype',
   'leveloffset',
@@ -88,7 +89,9 @@ function produceAssemblyFile (
     assemblyModel
   )
   const stem =
-    (builder.slug ? sanitizeSlug(builder.slug) : generateSlug(rootLevel === 0 ? 'index' : builder.baseDoctitle)) ||
+    (builder.docname
+      ? sanitizeDocname(builder.docname)
+      : generateDocname(rootLevel === 0 ? 'index' : builder.baseDoctitle)) ||
     'export-' + (assemblyModel.stemSeq = (assemblyModel.exportSeq ?? 0) + 1)
   const downloadStem = [component, version, stem === 'index' ? '' : stem].filter((it) => it).join('-')
   const file = contentCatalog.createFile({
@@ -147,7 +150,7 @@ function buildAssemblyHeader (componentVersion, navtitle, assemblyModel) {
   const { name: componentName, version, displayVersion, title } = componentVersion
   const navtitleAsciiDoc = unconvertInlineAsciiDoc(navtitle)
   const navtitlePlain = sanitize(navtitle)
-  const doctitleQualifier = assemblyModel.rootLevel === 0 ? '' : title
+  const doctitleQualifier = assemblyModel.rootLevel === 0 ? undefined : title
   const versioned = !!(version && version !== 'master')
   return {
     header: [
@@ -168,10 +171,10 @@ function buildAssemblyHeader (componentVersion, navtitle, assemblyModel) {
     setAuthor (author) {
       this.header.splice(1, 0, author)
     },
-    setDoctitle (doctitle, doctitleAsciiDoc, doctitlePlain) {
+    updateDoctitle (doctitle, doctitleAsciiDoc, doctitlePlain, useQualifier = true) {
       this.baseDoctitle = doctitle
       this.baseDoctitlePlain = doctitlePlain
-      const qualifyDoctitle = this.doctitleQualifier ? this.doctitleQualifier !== doctitlePlain : false
+      const qualifyDoctitle = useQualifier && !!this.doctitleQualifier && this.doctitleQualifier !== doctitlePlain
       this.header[0] = `= ${qualifyDoctitle ? this.doctitleQualifier + ': ' : ''}${doctitleAsciiDoc}`
     },
     matchesDoctitle (candidate) {
@@ -234,7 +237,7 @@ function mergeAsciiDoc (
   let navtitle = outlineEntry.navtitle ?? (page && hash ? page.asciidoc.navtitle : outlineEntry.content)
   let navtitleAsciiDoc = unconvertInlineAsciiDoc(navtitle)
   let navtitlePlain = sanitize(navtitle)
-  const { doctype, filetype, linkReferenceStyle, pubRoot, siteRoot, logger, rootPageStyle } = assemblyModel
+  const { doctype, filetype, linkReferenceStyle, pubRoot, siteRoot, logger, rootLevel, rootPageStyle } = assemblyModel
   let sectionMergeStrategy = assemblyModel.sectionMergeStrategy
   const atStartOfBody = !builder.body?.length
   const isRootEntry = atStartOfBody && !level
@@ -256,22 +259,32 @@ function mergeAsciiDoc (
     doc.source_header_attributes ??= toHash()
     const isRootPage = isRootEntry
     const { component, version, module: module_, relative, origin } = page.src
-    const doctypeOverride = doc.getAttribute('assembly-doctype')
-    if (doctypeOverride) {
-      if (doctypeOverride !== doctype) builder.setDoctype(doctypeOverride)
-      if (doctypeOverride !== 'book') atBookRoot = supportsParts = false
-    }
-    if (isRootPage && doc.hasAttribute('assembly-slug')) builder.slug = doc.getAttribute('assembly-slug')
     let hasAssemblyNavtitleAttr
     if ((hasAssemblyNavtitleAttr = !!doc.getAttribute('assembly-navtitle'))) {
-      navtitleAsciiDoc = doc.getAttribute('assembly-navtitle')
-      navtitlePlain = sanitize((navtitle = doc.$apply_reftext_subs(navtitleAsciiDoc)))
-      if (isRootPage) builder.setDoctitle(navtitle, navtitleAsciiDoc, navtitlePlain)
+      navtitleAsciiDoc = unconvertInlineAsciiDoc(doc.getAttribute('assembly-navtitle'))
+      navtitlePlain = sanitize((navtitle = doc.$sub_attributes(doc.$apply_reftext_subs(navtitleAsciiDoc))))
+    }
+    if (isRootPage) {
+      const doctypeOverride = doc.getAttribute('assembly-doctype')
+      if (doctypeOverride && doctypeOverride !== doctype) {
+        builder.setDoctype(doctypeOverride)
+        if (doctypeOverride !== 'book') atBookRoot = supportsParts = false
+      }
+      if (doc.hasAttribute('assembly-docname')) builder.docname = doc.getAttribute('assembly-docname')
+      const doctitleOverride = doc.getAttribute('assembly-doctitle')
+      if (doctitleOverride) {
+        let doctitle
+        const doctitleAsciiDoc = unconvertInlineAsciiDoc(doctitleOverride)
+        const doctitlePlain = sanitize((doctitle = doc.$sub_attributes(doc.$apply_reftext_subs(doctitleAsciiDoc))))
+        builder.updateDoctitle(doctitle, doctitleAsciiDoc, doctitlePlain, false)
+      } else if (hasAssemblyNavtitleAttr && rootLevel) {
+        builder.updateDoctitle(navtitle, navtitleAsciiDoc, navtitlePlain)
+      }
     }
-    const overviewTitle = doc.getAttribute('assembly-overview-title', 'Overview')
+    const overviewTitle = doc.getAttribute('assembly-overview-title') || 'Overview'
     let overviewTitleAsciiDoc
     // NOTE: in Antora, docname is relative src path from module without file extension
-    const docname = doc.getAttribute('docname')
+    const pageDocname = doc.getAttribute('docname')
     const pageId = generateScopedId(page.src, componentVersion, idSeparators, filetype)
     const pageIdLeader = pageId + idSeparators.scope
     let pageFragment = `#${pageId}`
@@ -299,6 +312,7 @@ function mergeAsciiDoc (
     const ignoreLines = []
     const buffer = (builder.body ??= [])
     if (buffer.length) buffer.push('')
+    let headerHasBlockAttrs
     if (doc.hasHeader()) {
       for (const entry of processPageHeader(doc, lines, ignoreLines, isRootPage)) {
         if (entry.type === 'author_line') {
@@ -315,8 +329,8 @@ function mergeAsciiDoc (
               (val = doc.getAttribute(name)) &&
               (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(':')) {
+              if (newVal !== val) entry.value = newVal
+            } else if (~(val = entry.value).indexOf(':')) {
               newVal = val
               if (~newVal.indexOf('image:')) {
                 newVal = rewriteInlineImages(
@@ -343,19 +357,19 @@ function mergeAsciiDoc (
                   { file: relative, lineno: entry.lineno }
                 )
               }
-              if (newVal !== val) entry.lines = `:${entry.name}: ${newVal}`.split('\n')
+              if (newVal !== val) entry.value = newVal
             }
           }
           ;(entry.promote ? builder.header : buffer).push(...entry.lines)
         } else {
-          if (entry.type === 'attrlist') builder.headerHasBlockAttrs = true
+          if (entry.type === 'attrlist') headerHasBlockAttrs = true
           buffer.push(...entry.lines)
         }
       }
       pageRoles = doc.getRoles()
     }
     if (roles.length) pageRoles = pageRoles.concat(roles[0] === 'page' ? roles.slice(1) : roles)
-    buffer.push(`:page-docname: ${docname}`)
+    buffer.push(`:page-docname: ${pageDocname}`)
     if (component !== builder.currentComponentVersion.name) {
       const thisComponentVersion =
         component === componentVersion.name && version === componentVersion.version
@@ -398,7 +412,7 @@ function mergeAsciiDoc (
         }
         if (htitleOverride === '') {
           nextSectionLevel = 2
-          if (builder.headerHasBlockAttrs) {
+          if (headerHasBlockAttrs) {
             htitleAsciiDoc = ''
           } else {
             sectionMergeStrategy = 'discrete'
@@ -410,7 +424,7 @@ function mergeAsciiDoc (
           htitleAsciiDoc = htitleOverride == null ? navtitleAsciiDoc : unconvertInlineAsciiDoc(htitleOverride)
           if (htitleOverride === overviewTitle) overviewTitleAsciiDoc = htitleAsciiDoc // optimization
           if (atBookRoot && hasPrefaceTitleAttr) {
-            if (!builder.headerHasBlockAttrs && (sectionMergeStrategy === 'discrete' || !hasSections)) {
+            if (!headerHasBlockAttrs && (sectionMergeStrategy === 'discrete' || !hasSections)) {
               builder.header.push(`:preface-title: ${htitleAsciiDoc}`)
               htitleAsciiDoc = undefined
             }
@@ -447,15 +461,17 @@ function mergeAsciiDoc (
     } else if (level) {
       if (atStartOfBody && !pageStyle && builder.matchesDoctitle(navtitlePlain)) {
         level--
-      } else if ((heading = { title: navtitleAsciiDoc, hlevel: level + 1 }).hlevel > 6) {
-        Object.assign(heading, { hlevel: 6, style: `discrete.h${heading.hlevel}` })
+        if (headerHasBlockAttrs) heading = { title: '', hlevel: ++level + 1 }
+      } else {
+        heading = { title: navtitleAsciiDoc, hlevel: level + 1 }
       }
     }
     if (heading) {
+      if (heading.hlevel > 6) Object.assign(heading, { hlevel: 6, style: `discrete.h${heading.hlevel}` })
       const rolesAttr = pageRoles.reduce((str, it) => str + '.' + it, '')
       const notitle = (heading.title ||= '{empty}') === '{empty}'
       // remove conditional if we always want to promote ID of root page to docid
-      if (notitle) {
+      if (notitle && atStartOfBody) {
         builder.setDocid(pageId)
         pageFragment = '#' + idSeparators.generateIdFromTitle('', idSeparators, pageIdLeader)
       }
@@ -799,6 +815,14 @@ function processPageHeader (doc, lines, ignoreLines, isRootPage) {
         } else {
           if (line.endsWith(' \\')) open = ':'
           entries.push((current = { type: 'attribute_entry', name, negated, lines: [], lineno: idx + 1 }))
+          Object.defineProperty(current, 'value', {
+            get () {
+              return this.lines.join('\n').substring(this.name.length + 3)
+            },
+            set (newValue) {
+              this.lines = `:${this.name}: ${newValue}`.split('\n')
+            },
+          })
           current.lines.push(negated ? `:!${name}:` : line)
           current.appendLine = Array.prototype.push.bind(negated ? [] : current.lines)
           if (assemblyHeaderAttributes.has(name)) current.promote = true
@@ -824,9 +848,9 @@ function processPageHeader (doc, lines, ignoreLines, isRootPage) {
   return entries
 }
 
-function generateSlug (string) {
+function generateDocname (string) {
   if (string === 'index') return string
-  return sanitizeSlug(
+  return sanitizeDocname(
     string
       .toLowerCase()
       .replace(/<[^>]+>/g, '')
@@ -839,8 +863,8 @@ function generateSlug (string) {
   )
 }
 
-function sanitizeSlug (slug) {
-  return slug.replace(/[^\p{Alpha}0-9_.-]/gu, '-').replace(/^-+|-+$|(-)-+/g, '$1')
+function sanitizeDocname (docname) {
+  return docname.replace(/[^\p{Alpha}0-9_.-]/gu, '-').replace(/^-+|-+$|(-)-+/g, '$1')
 }
 
 function fixSectionLevels (sections, expectedLevel) {

package/lib/util/unconvert-inline-asciidoc.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const ATTRIBUTE_REFERENCE_RX = /\{[a-z0-9_][a-z0-9_-]*\}/g
+const ATTRIBUTE_REFERENCE_RX = /\{[A-Za-z0-9_][A-Za-z0-9_-]*\}/g
 const STRICT_WORD_CHAR_RX = /[\p{L}\d_]/u
 const WORD_CHAR_RX = /[\p{L}\d_;}:<>]/u
 const XML_SPECIAL_CHARS = { '&lt;': '<', '&gt;': '>', '&amp;': '&' }

package/package.json

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