@antora/content-classifier 3.0.3 → 3.1.0

package/lib/classify-content.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const ContentCatalog = require('./content-catalog')
+const collateAsciiDocAttributes = require('@antora/asciidoc-loader/config/collate-asciidoc-attributes')
 
 /**
  * Organizes the raw aggregate of virtual files into a {ContentCatalog}.
@@ -34,7 +35,7 @@ function classifyContent (playbook, aggregate, siteAsciiDocConfig = {}) {
     .forEach((componentVersionData, componentVersion) => {
       const { name, version } = componentVersion
       const { files, nav, startPage } = componentVersionData
-      delete componentVersionData.files // clean up memory
+      componentVersionData.files = undefined // clean up memory
       files.forEach((file) => allocateSrc(file, name, version, nav) && contentCatalog.addFile(file))
       contentCatalog.registerComponentVersionStartPage(name, componentVersion, startPage)
     })
@@ -130,29 +131,15 @@ function getNavInfo (filepath, nav) {
   if (~index) return { index }
 }
 
-function resolveAsciiDocConfig (siteAsciiDocConfig, { asciidoc }) {
+function resolveAsciiDocConfig (siteAsciiDocConfig, { asciidoc, origins = [] }) {
   const scopedAttributes = (asciidoc || {}).attributes
   if (scopedAttributes) {
-    const siteAttributes = siteAsciiDocConfig.attributes
-    if (siteAttributes) {
-      const attributes = Object.keys(scopedAttributes).reduce((accum, name) => {
-        if (name in siteAttributes) {
-          const currentVal = siteAttributes[name]
-          if (currentVal === false || String(currentVal).endsWith('@')) accum[name] = scopedAttributes[name]
-        } else {
-          accum[name] = scopedAttributes[name]
-        }
-        return accum
-      }, {})
-      return Object.keys(attributes).length
-        ? Object.assign({}, siteAsciiDocConfig, { attributes: Object.assign({}, siteAttributes, attributes) })
-        : siteAsciiDocConfig
-    } else {
-      return Object.assign({}, siteAsciiDocConfig, { attributes: scopedAttributes })
-    }
-  } else {
-    return siteAsciiDocConfig
+    const initial = siteAsciiDocConfig.attributes
+    const mdc = { file: { path: 'antora.yml', origin: origins[origins.length - 1] } }
+    const attributes = collateAsciiDocAttributes(scopedAttributes, { initial, mdc, merge: true })
+    if (attributes !== initial) siteAsciiDocConfig = Object.assign({}, siteAsciiDocConfig, { attributes })
   }
+  return siteAsciiDocConfig
 }
 
 function calculateRootPath (depth) {

package/lib/content-catalog.js

@@ -11,6 +11,7 @@ const versionCompare = require('./util/version-compare-desc')
 
 const { ROOT_INDEX_ALIAS_ID, ROOT_INDEX_PAGE_ID } = require('./constants')
 const SPACE_RX = / /g
+const LOG_WRAP = '\n    '
 
 const $components = Symbol('components')
 const $files = Symbol('files')
@@ -140,12 +141,12 @@ class ContentCatalog {
         throw new Error(`Duplicate alias: ${generateResourceSpec(src)}`)
       } else {
         const details = [filesForFamily.get(key), file]
-          .map((it, idx) => `  ${idx + 1}: ${getFileLocation(it)}`)
-          .join('\n')
+          .map((it, idx) => `${idx + 1}: ${getFileLocation(it)}`)
+          .join(LOG_WRAP)
         if (family === 'nav') {
-          throw new Error(`Duplicate nav in ${src.version}@${src.component}: ${file.path}\n${details}`)
+          throw new Error(`Duplicate nav in ${src.version}@${src.component}: ${file.path}${LOG_WRAP}${details}`)
         } else {
-          throw new Error(`Duplicate ${family}: ${generateResourceSpec(src)}\n${details}`)
+          throw new Error(`Duplicate ${family}: ${generateResourceSpec(src)}${LOG_WRAP}${details}`)
         }
       }
     }
@@ -189,6 +190,12 @@ class ContentCatalog {
     return file
   }
 
+  removeFile (file) {
+    const src = file.src
+    const filesForFamily = this[$files].get(src.family)
+    return filesForFamily ? filesForFamily.delete(generateKey(src)) : false
+  }
+
   findBy (criteria) {
     const criteriaEntries = Object.entries(criteria)
     const family = criteria.family
@@ -354,10 +361,10 @@ class ContentCatalog {
         throw new Error(
           existingPage === target
             ? `Page cannot define alias that references itself: ${generateResourceSpec(src)}` +
-              ` (specified as: ${spec})\n  source: ${getFileLocation(existingPage)}`
-            : `Page alias cannot reference an existing page: ${generateResourceSpec(src)} (specified as: ${spec})\n` +
-              `  source: ${getFileLocation(target)}\n` +
-              `  existing page: ${getFileLocation(existingPage)}`
+              ` (specified as: ${spec})${LOG_WRAP}source: ${getFileLocation(existingPage)}`
+            : `Page alias cannot reference an existing page: ${generateResourceSpec(src)} (specified as: ${spec})` +
+              `${LOG_WRAP}source: ${getFileLocation(target)}` +
+              `${LOG_WRAP}existing page: ${getFileLocation(existingPage)}`
         )
       }
     } else if (src.version == null) {
@@ -368,7 +375,8 @@ class ContentCatalog {
     const existingAlias = this.getById(src)
     if (existingAlias) {
       throw new Error(
-        `Duplicate alias: ${generateResourceSpec(src)} (specified as: ${spec})\n  source: ${getFileLocation(target)}`
+        `Duplicate alias: ${generateResourceSpec(src)} (specified as: ${spec})` +
+          `${LOG_WRAP}source: ${getFileLocation(target)}`
       )
     }
     // NOTE the redirect producer will populate contents when the redirect facility is 'static'
@@ -587,10 +595,12 @@ function createSymbolicVersionAlias (component, version, symbolicVersionSegment,
 }
 
 function getFileLocation ({ path: path_, src: { abspath, origin } }) {
-  return (
-    abspath ||
-    (origin ? `${path.join(origin.startPath, path_)} in ${origin.url} (ref: ${origin.branch || origin.tag})` : path_)
-  )
+  if (!origin) return abspath || path_
+  const { url, gitdir, worktree, refname, tag, reftype = tag ? 'tag' : 'branch', remote, startPath } = origin
+  let details = `${reftype}: ${refname}`
+  if ('worktree' in origin) details += worktree ? ' <worktree>' : remote ? ` <remotes/${remote}>` : ''
+  if (startPath) details += ` | start path: ${startPath}`
+  return `${abspath || path.join(startPath, path_)} in ${'worktree' in origin ? worktree || gitdir : url} (${details})`
 }
 
 module.exports = ContentCatalog

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/content-classifier",
-  "version": "3.0.3",
+  "version": "3.1.0",
   "description": "Organizes aggregated content into a virtual file catalog for use in an Antora documentation pipeline.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -15,13 +15,25 @@
     "url": "https://gitlab.com/antora/antora/issues"
   },
   "main": "lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./content-catalog": "./lib/content-catalog.js",
+    "./file": "./lib/file.js",
+    "./util/*": "./lib/util/*.js",
+    "./lib/util/*": "./lib/util/*.js",
+    "./package.json": "./package.json"
+  },
+  "imports": {
+    "#constants": "./lib/constants.js"
+  },
   "dependencies": {
-    "@antora/logger": "3.0.3",
+    "@antora/asciidoc-loader": "3.1.0",
+    "@antora/logger": "3.1.0",
     "mime-types": "~2.1",
     "vinyl": "~2.2"
   },
   "engines": {
-    "node": ">=12.21.0"
+    "node": ">=16.0.0"
   },
   "files": [
     "lib/"