@antora/content-classifier 3.2.0-alpha.5 → 3.2.0-alpha.8

package/lib/classify-content.js

@@ -20,7 +20,7 @@ const summarizeFileLocation = require('./util/summarize-file-location')
  *
  * @returns {ContentCatalog} A structured catalog of content components, versions, and virtual content files.
  */
-function classifyContent (playbook, aggregate, siteAsciiDocConfig = {}, onComponentsRegistered) {
+function classifyContent (playbook, aggregate, siteAsciiDocConfig = {}, onComponentsRegistered = undefined) {
   const siteStartPage = playbook.site.startPage
   let contentCatalog = registerComponentVersions(new ContentCatalog(playbook), aggregate, siteAsciiDocConfig)
   return typeof onComponentsRegistered === 'function' &&
@@ -156,13 +156,19 @@ function getNavInfo (filepath, nav) {
   if (~index) return nav.resolved.add(filepath) && { index }
 }
 
-function resolveAsciiDocConfig (siteAsciiDocConfig, { asciidoc, origins = [] }) {
-  const scopedAttributes = (asciidoc || {}).attributes
+function resolveAsciiDocConfig (siteAsciiDocConfig, { name, version, asciidoc, origins = [] }) {
+  const scopedAttributes = asciidoc?.attributes
   if (scopedAttributes) {
-    const initial = siteAsciiDocConfig.attributes
+    const initial = Object.assign({}, siteAsciiDocConfig.attributes)
+    initial['antora-component-name'] = name
+    initial['antora-component-version'] = version
     const mdc = { file: { path: 'antora.yml', origin: origins[origins.length - 1] } }
     const attributes = collateAsciiDocAttributes(scopedAttributes, { initial, mdc, merge: true })
-    if (attributes !== initial) return Object.assign({}, siteAsciiDocConfig, { attributes })
+    if (attributes !== initial) {
+      delete attributes['antora-component-name']
+      delete attributes['antora-component-version']
+      return Object.assign({}, siteAsciiDocConfig, { attributes })
+    }
   }
   return siteAsciiDocConfig
 }

package/lib/content-catalog.js

@@ -87,10 +87,10 @@ class ContentCatalog {
       let lastVerdict
       const insertIdx = version
         ? componentVersions.findIndex(({ version: candidateVersion, prerelease: candidatePrerelease }) => {
-          return (lastVerdict = versionCompare(candidateVersion, version)) > 1
-            ? !!prerelease === !!candidatePrerelease
-            : lastVerdict > 0 || (lastVerdict < -1 && prerelease && !candidatePrerelease)
-        })
+            return (lastVerdict = versionCompare(candidateVersion, version)) > 1
+              ? !!prerelease === !!candidatePrerelease
+              : lastVerdict > 0 || (lastVerdict < -1 && prerelease && !candidatePrerelease)
+          })
         : prerelease
           ? -1
           : ~(~componentVersions.findIndex(({ prerelease: candidatePrerelease }) => !candidatePrerelease) || -1)
@@ -147,16 +147,14 @@ class ContentCatalog {
     if (filesForFamily.has(key)) {
       if (family === 'alias') {
         throw new Error(`Duplicate alias: ${generateResourceSpec(src)}`)
-      } else {
-        const details = [filesForFamily.get(key), file]
-          .map((it, idx) => `${idx + 1}: ${summarizeFileLocation(it)}`)
-          .join(LOG_WRAP)
-        if (family === 'nav') {
-          throw new Error(`Duplicate nav file: ${file.path} in ${version}@${component}${LOG_WRAP}${details}`)
-        } else {
-          throw new Error(`Duplicate ${family}: ${generateResourceSpec(src)}${LOG_WRAP}${details}`)
-        }
       }
+      const details = [filesForFamily.get(key), file]
+        .map((it, idx) => `${idx + 1}: ${summarizeFileLocation(it)}`)
+        .join(LOG_WRAP)
+      if (family === 'nav') {
+        throw new Error(`Duplicate nav file: ${file.path} in ${version}@${component}${LOG_WRAP}${details}`)
+      }
+      throw new Error(`Duplicate ${family}: ${generateResourceSpec(src)}${LOG_WRAP}${details}`)
     }
     // NOTE: if the path property is not set, assume the src likely needs to be prepared
     // another option is to assume that if the file is not a vinyl object, the src likely needs to be prepared
@@ -172,7 +170,7 @@ class ContentCatalog {
       // NOTE: an alias masquerades as the target file
       family = file.rel.src.family
       // NOTE: short circuit in case of splat alias (alias -> alias)
-      if (family === 'alias' && (file.pub || {}).splat) return filesForFamily.set(key, file) && file
+      if (family === 'alias' && file.pub?.splat) return filesForFamily.set(key, file) && file
       src.mediaType = 'text/asciidoc'
     } else if (!(file.mediaType = src.mediaType) && !('mediaType' in src)) {
       // QUESTION: should we preserve the mediaType property on file if already defined?
@@ -243,7 +241,7 @@ class ContentCatalog {
   }
 
   getComponentVersion (component, version) {
-    return (component.versions || (this.getComponent(component) || {}).versions || []).find(
+    return (component.versions || this.getComponent(component)?.versions || []).find(
       ({ version: candidate }) => candidate === version
     )
   }
@@ -271,9 +269,8 @@ class ContentCatalog {
       const accum = []
       for (const candidate of candidates.values()) filter(candidate) && accum.push(candidate)
       return accum
-    } else {
-      return [...candidates.values()]
     }
+    return [...candidates.values()]
   }
 
   // TODO add `follow` argument to control whether alias is followed
@@ -370,7 +367,8 @@ class ContentCatalog {
       if (rootIndexAlias) return rootIndexAlias.synthetic ? Object.assign(rootIndexAlias, { rel }) : undefined
       const src = Object.assign({}, ROOT_INDEX_ALIAS_ID)
       return this.addFile({ src, rel, synthetic: true }, { version: src.version })
-    } else if (rel === false) {
+    }
+    if (rel === false) {
       logger.warn('Start page specified for site has invalid syntax: %s', startPageSpec)
     } else if (startPageSpec.lastIndexOf(':') > startPageSpec.indexOf(':')) {
       logger.warn('Start page specified for site not found: %s', startPageSpec)
@@ -400,10 +398,10 @@ class ContentCatalog {
         throw new Error(
           existingPage === target
             ? `Page cannot define alias that references itself: ${generateResourceSpec(src)}` +
-              ` (specified as: ${spec})${LOG_WRAP}source: ${summarizeFileLocation(existingPage)}`
+                ` (specified as: ${spec})${LOG_WRAP}source: ${summarizeFileLocation(existingPage)}`
             : `Page alias cannot reference an existing page: ${generateResourceSpec(src)} (specified as: ${spec})` +
-              `${LOG_WRAP}source: ${summarizeFileLocation(target)}` +
-              `${LOG_WRAP}existing page: ${summarizeFileLocation(existingPage)}`
+                `${LOG_WRAP}source: ${summarizeFileLocation(target)}` +
+                `${LOG_WRAP}existing page: ${summarizeFileLocation(existingPage)}`
         )
       }
     } else if (src.version == null) {

package/lib/util/resolve-resource.js

@@ -26,7 +26,6 @@ const parseResourceId = require('./parse-resource-id')
  */
 function resolveResource (spec, catalog, ctx = {}, defaultFamily = undefined, permittedFamilies = undefined) {
   const id = parseResourceId(spec, ctx, defaultFamily, permittedFamilies)
-
   if (!id || !id.family) return false
   if (id.version == null) {
     const component = catalog.getComponent(id.component)
@@ -34,10 +33,9 @@ function resolveResource (spec, catalog, ctx = {}, defaultFamily = undefined, pe
     id.version = component.latest.version
   }
   if (!id.module) id.module = 'ROOT'
-
   return (
     catalog.getById(id) ||
-    (id.family === 'page' ? (catalog.getById(Object.assign({}, id, { family: 'alias' })) || {}).rel : undefined)
+    (id.family === 'page' ? catalog.getById(Object.assign({}, id, { family: 'alias' }))?.rel : undefined)
   )
 }
 

package/lib/util/version-compare-desc.js

@@ -24,11 +24,8 @@ function versionCompareDesc (a, b) {
   if (a && b) {
     const semverA = resolveSemver(a)
     const semverB = resolveSemver(b)
-    if (semverA) {
-      return semverB ? -semverCompare(semverA, semverB) : 1
-    } else {
-      return semverB ? -1 : -2 * a.localeCompare(b, 'en', { numeric: true })
-    }
+    if (semverA) return semverB ? -semverCompare(semverA, semverB) : 1
+    return semverB ? -1 : -2 * a.localeCompare(b, 'en', { numeric: true })
   }
   return a ? 1 : -1
 }
@@ -64,23 +61,18 @@ function semverCompare (a, b) {
   const numsA = a.split('.')
   const numsB = b.split('.')
   for (let i = 0; i < 3; i++) {
-    const numA = Number(numsA[i] || 0)
-    const numB = Number(numsB[i] || 0)
-    if (numA > numB) {
-      return 1
-    } else if (numB > numA) {
-      return -1
-    } else if (isNaN(numA)) {
-      if (!isNaN(numB)) return -1
-    } else if (isNaN(numB)) {
+    const numA = Number(numsA[i] ?? 0)
+    const numB = Number(numsB[i] ?? 0)
+    if (numA > numB) return 1
+    if (numB > numA) return -1
+    if (Number.isNaN(numA)) {
+      if (!Number.isNaN(numB)) return -1
+    } else if (Number.isNaN(numB)) {
       return 1
     }
   }
-  if (preA == null) {
-    return preB == null ? 0 : 1
-  } else {
-    return preB == null ? -1 : preA.localeCompare(preB, 'en', { numeric: true })
-  }
+  if (preA == null) return preB == null ? 0 : 1
+  return preB == null ? -1 : preA.localeCompare(preB, 'en', { numeric: true })
 }
 
 module.exports = versionCompareDesc

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/content-classifier",
-  "version": "3.2.0-alpha.5",
+  "version": "3.2.0-alpha.8",
   "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)",
@@ -10,7 +10,11 @@
     "Hubert SABLONNIÈRE <hubert.sablonniere@gmail.com>"
   ],
   "homepage": "https://antora.org",
-  "repository": "gitlab:antora/antora",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/antora/antora.git",
+    "directory": "packages/content-classifier"
+  },
   "bugs": {
     "url": "https://gitlab.com/antora/antora/issues"
   },
@@ -27,8 +31,8 @@
     "#constants": "./lib/constants.js"
   },
   "dependencies": {
-    "@antora/asciidoc-loader": "3.2.0-alpha.5",
-    "@antora/logger": "3.2.0-alpha.5",
+    "@antora/asciidoc-loader": "3.2.0-alpha.8",
+    "@antora/logger": "3.2.0-alpha.8",
     "mime-types": "~2.1",
     "vinyl": "~3.0"
   },