@antora/content-classifier 3.2.0-alpha.6 → 3.2.0-alpha.9

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' &&
@@ -157,7 +157,7 @@ function getNavInfo (filepath, nav) {
 }
 
 function resolveAsciiDocConfig (siteAsciiDocConfig, { name, version, asciidoc, origins = [] }) {
-  const scopedAttributes = (asciidoc || {}).attributes
+  const scopedAttributes = asciidoc?.attributes
   if (scopedAttributes) {
     const initial = Object.assign({}, siteAsciiDocConfig.attributes)
     initial['antora-component-name'] = name

package/lib/content-catalog.js

@@ -11,7 +11,6 @@ const summarizeFileLocation = require('./util/summarize-file-location')
 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')
@@ -61,8 +60,13 @@ class ContentCatalog {
    * @returns {Object} The constructed component version object.
    */
   registerComponentVersion (name, version, descriptor = {}) {
-    const { asciidoc, displayVersion, prerelease, startPage: startPageSpec, title, versionSegment } = descriptor
-    const componentVersion = { displayVersion: displayVersion || version || 'default', title: title || name, version }
+    const { asciidoc, displayVersion, prerelease, startPage: startPageRef, title, versionSegment, origins } = descriptor
+    const componentVersion = {
+      displayVersion: displayVersion || version || 'default',
+      title: title || name,
+      version,
+      origins: new Set(origins && typeof origins[Symbol.iterator] === 'function' ? origins : []),
+    }
     if (versionSegment != null) componentVersion.versionSegment = versionSegment
     Object.defineProperty(componentVersion, 'name', { value: name, enumerable: true })
     if (prerelease) {
@@ -87,10 +91,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)
@@ -131,9 +135,9 @@ class ContentCatalog {
         )
       )
     }
-    if (startPageSpec) {
+    if (startPageRef) {
       // @deprecated use separate call to register start page for component version
-      this.registerComponentVersionStartPage(name, componentVersion, startPageSpec === true ? undefined : startPageSpec)
+      this.registerComponentVersionStartPage(name, componentVersion, startPageRef === true ? undefined : startPageRef)
     }
     return componentVersion
   }
@@ -147,22 +151,18 @@ 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
+    // NOTE: assume that if the file is not a vinyl object, the src likely needs to be prepared
     // a vinyl object is one indication the file was created and prepared by the content aggregator
-    //if (!src.path) prepareSrc(src)
-    //if (!File.isVinyl(file)) file = new File(file)
+    // an alternate approach would be to call prepareSrc if the path property is not set
     if (!File.isVinyl(file)) {
       prepareSrc(src)
       file = new File(file)
@@ -172,7 +172,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?
@@ -185,18 +185,25 @@ class ContentCatalog {
     } else if ('out' in file) {
       delete file.out
     } else if (
+      !file.private &&
       (family === 'page' || family === 'image' || family === 'attachment') &&
-      ('/' + src.relative).indexOf('/_') < 0
+      (file.private === false || ('/' + src.relative).indexOf('/_') < 0)
     ) {
       publishable = true
       if (componentVersion == null) componentVersion = this.getComponentVersion(component, version) || { version }
-      activeVersionSegment = computeVersionSegment.call(this, componentVersion)
+      activeVersionSegment =
+        'activeVersionSegment' in componentVersion
+          ? componentVersion.activeVersionSegment
+          : computeVersionSegment.call(this, componentVersion)
       file.out = computeOut(src, family, activeVersionSegment, this.htmlUrlExtensionStyle)
     }
     if (!file.pub && (publishable || family === 'nav')) {
       if (activeVersionSegment == null) {
         if (componentVersion == null) componentVersion = this.getComponentVersion(component, version) || { version }
-        activeVersionSegment = computeVersionSegment.call(this, componentVersion)
+        activeVersionSegment =
+          'activeVersionSegment' in componentVersion
+            ? componentVersion.activeVersionSegment
+            : computeVersionSegment.call(this, componentVersion)
       }
       file.pub = computePub(src, file.out, family, activeVersionSegment, this.htmlUrlExtensionStyle)
     }
@@ -243,7 +250,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 +278,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 +376,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 +407,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) {
@@ -448,26 +455,48 @@ class ContentCatalog {
   }
 
   /**
-   * Attempts to resolve a string contextual page ID spec to a file in the catalog.
+   * Attempts to resolve a page reference within the given context to a page in the catalog.
    *
-   * Parses the specified contextual page ID spec into a page ID object, then attempts to lookup a
-   * file with this page ID in the catalog. If a component is specified, but not a version, the
-   * latest version of the component stored in the catalog is used. If a page cannot be resolved,
-   * the search is attempted again for an "alias". If neither a page or alias can be resolved, the
-   * function returns undefined. If the spec does not match the page ID syntax, this function throws
-   * an error.
+   * Parses the specified page reference (i.e., page ID spec) into a partial page ID, expands it
+   * using the provided context, then attempts to locate a file in the page family with that page ID
+   * in this catalog. The family segment is optional.
    *
-   * @param {String} spec - The contextual page ID spec (e.g., version@component:module:topic/page.adoc).
-   * @param {ContentCatalog} catalog - The content catalog in which to resolve the page file.
-   * @param {Object} [ctx={}] - The context to use to qualified the contextual page ID.
+   * If a component is specified, but no version, the latest version of the component stored in the
+   * catalog is used. If a page cannot be resolved, the search is attempted again for an "alias". If
+   * neither a page or alias can be resolved, the function returns undefined. If the syntax of the
+   * reference is invalid, this function throws an error.
    *
-   * @returns {File} The virtual file to which the contextual page ID spec refers, or undefined if the
-   * file cannot be resolved.
+   * @param {String} spec - The contextual page reference (e.g., version@component:module:topic/page.adoc).
+   * @param {Object} [context={}] - The context to use to qualify the page reference.
+   *
+   * @returns {File} The virtual file to which the contextual page reference resolves, or undefined
+   * if the file cannot be resolved.
    */
   resolvePage (spec, context = {}) {
     return this.resolveResource(spec, context, 'page', ['page'])
   }
 
+  /**
+   * Attempts to resolve a resource reference within the given context to a file in the catalog.
+   *
+   * Parses the specified resource reference (i.e., resource ID spec) into a partial resource ID,
+   * expands it using the provided context, then attempts to locate a file with that resource ID in
+   * this catalog.
+   *
+   * If a component is specified, but no version, the latest version of the component stored in the
+   * catalog is used. If a defaultFamily is not specified, the family must be specified either by
+   * the reference or the context. If permittedFamilies are stated, the family must resolve to a
+   * family in this list. If a file cannot be resolved, the function returns undefined. If the
+   * syntax of the reference is invalid, this function throws an error.
+   *
+   * @param {String} spec - The contextual resource reference (e.g., version@component:module:image$topic/image.png).
+   * @param {Object} [context={}] - The context to use to qualify the resource reference.
+   * @param {String} [defaultFamily=undefined] - The default family to use if one is not provided.
+   * @param {Array<String>} [permittedFamilies=undefined] - A list of families that are permitted.
+   *
+   * @returns {File} The virtual file to which the contextual resource reference resolves, or
+   * undefined if the file cannot be resolved.
+   */
   resolveResource (spec, context = {}, defaultFamily = undefined, permittedFamilies = undefined) {
     return resolveResource(spec, this, context, defaultFamily, permittedFamilies)
   }
@@ -509,29 +538,25 @@ function generateResourceSpec ({ component, version, module: module_, family, re
 
 function prepareSrc (src) {
   let { basename, extname, stem } = src
-  let update
   if (basename == null) {
-    update = true
-    basename = path.basename(src.relative)
+    basename = src.basename = path.basename(src.relative)
   }
   if (stem == null) {
-    update = true
     if (extname == null) {
       if (~(extname = basename.lastIndexOf('.'))) {
-        stem = basename.substr(0, extname)
-        extname = basename.substr(extname)
+        src.stem = basename.substr(0, extname)
+        src.extname = basename.substr(extname)
       } else {
-        stem = basename
-        extname = ''
+        src.stem = basename
+        src.extname = ''
       }
     } else {
-      stem = basename.substr(0, basename.length - extname.length)
+      src.stem = basename.substr(0, basename.length - extname.length)
     }
   } else if (extname == null) {
-    update = true
-    extname = basename.substr(stem.length)
+    src.extname = basename.substr(stem.length)
   }
-  return update ? Object.assign(src, { basename, extname, stem }) : src
+  return src
 }
 
 function computeOut (src, family, versionSegment, htmlUrlExtensionStyle) {
@@ -591,7 +616,7 @@ function computePub (src, out, family, versionSegment, htmlUrlExtensionStyle) {
   } else if ((url = '/' + out.path) === '/.') {
     url = '/'
   }
-  pub.url = ~url.indexOf(' ') ? url.replace(SPACE_RX, '%20') : url
+  pub.url = ~url.indexOf(' ') ? url.replaceAll(' ', '%20') : url
   return out ? Object.assign(pub, { moduleRootPath: out.moduleRootPath, rootPath: out.rootPath }) : pub
 }
 

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.6",
+  "version": "3.2.0-alpha.9",
   "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.6",
-    "@antora/logger": "3.2.0-alpha.6",
+    "@antora/asciidoc-loader": "3.2.0-alpha.9",
+    "@antora/logger": "3.2.0-alpha.9",
     "mime-types": "~2.1",
     "vinyl": "~3.0"
   },