@antora/content-classifier 3.2.0-alpha.8 → 3.2.0-rc.1

package/lib/classify-content.js

@@ -4,6 +4,7 @@ const ContentCatalog = require('./content-catalog')
 const collateAsciiDocAttributes = require('@antora/asciidoc-loader/config/collate-asciidoc-attributes')
 const logger = require('./logger')
 const summarizeFileLocation = require('./util/summarize-file-location')
+const families = { attachments: true, examples: true, images: true, pages: true, partials: true }
 
 /**
  * Organizes the raw aggregate of virtual files into a {ContentCatalog}.
@@ -45,9 +46,21 @@ function addFilesAndRegisterStartPages (contentCatalog, siteStartPage) {
     for (const componentVersion of componentVersions) {
       const { name: component, version, files = [], nav, startPage } = componentVersion
       const navResolved = nav && (nav.resolved = new Set())
-      for (let file, i = 0, len = files.length; i < len; i++) {
-        allocateSrc((file = files[i]), component, version, nav) && contentCatalog.addFile(file, componentVersion)
+      const rootFiles = []
+      for (let file, i = 0; (file = files[i]); i++) {
         files[i] = undefined // free memory
+        const outcome = allocateSrc(file, component, version, componentVersion, nav)
+        if (outcome) {
+          contentCatalog.addFile(file)
+        } else if (outcome == null) {
+          rootFiles.push(file)
+        }
+      }
+      if (rootFiles.length) {
+        for (let file, i = 0; (file = rootFiles[i]); i++) {
+          if (file.src.origin.hasModulesDir) continue
+          allocateSrc(file, component, version, componentVersion, null, true) && contentCatalog.addFile(file)
+        }
       }
       if (navResolved && nav.length > navResolved.size && new Set(nav).size > navResolved.size) {
         const loc = summarizeFileLocation({ path: 'antora.yml', src: { origin: nav.origin } })
@@ -63,21 +76,24 @@ function addFilesAndRegisterStartPages (contentCatalog, siteStartPage) {
   return contentCatalog
 }
 
-function allocateSrc (file, component, version, nav) {
-  const { extname, family } = file.src
+function allocateSrc (file, component, version, componentVersion, nav, implicitRoot) {
+  const { extname, family, origin } = file.src
   if (family && family !== 'nav') {
-    Object.assign(file.src, { component, version })
+    Object.assign(file.src, { component, version, componentVersion })
+    if (!('private' in file) && ~('/' + file.src.relative).indexOf('/_')) file.private = true
     file.src.moduleRootPath ??= calculateRootPath(file.src.relative.split('/').length)
     return true
   }
   const filepath = file.path
-  const pathSegments = filepath.split('/')
+  const pathSegments = implicitRoot ? ['modules', 'ROOT'].concat(filepath.split('/')) : filepath.split('/')
+  const inModules = pathSegments[0] === 'modules'
+  if (!implicitRoot && origin) origin.hasModulesDir ||= inModules
   let navInfo
   if (nav && (navInfo = getNavInfo(filepath, nav))) {
-    if (extname !== '.adoc') return // ignore file
+    if (extname !== '.adoc') return false // ignore file
     file.nav = navInfo
     file.src.family = 'nav'
-    if (pathSegments[0] === 'modules' && pathSegments.length > 2) {
+    if (inModules && pathSegments.length > 2) {
       file.src.module = pathSegments[1]
       // relative to modules/<module>
       file.src.relative = pathSegments.slice(2).join('/')
@@ -86,7 +102,7 @@ function allocateSrc (file, component, version, nav) {
       // relative to content source root
       file.src.relative = filepath
     }
-  } else if (pathSegments[0] === 'modules') {
+  } else if (inModules) {
     let familyFolder = pathSegments[2]
     switch (familyFolder) {
       case 'pages':
@@ -100,45 +116,47 @@ function allocateSrc (file, component, version, nav) {
           // relative to modules/<module>/pages
           file.src.relative = pathSegments.slice(3).join('/')
         } else {
-          return // ignore file
+          return false // ignore file
         }
         break
       case 'assets':
         switch ((familyFolder = pathSegments[3])) {
           case 'attachments':
           case 'images':
-            if (!extname) return // ignore file
-            file.src.family = familyFolder.substr(0, familyFolder.length - 1)
+            if (!extname && familyFolder === 'images') return false // ignore file
+            file.src.family = familyFolder.substring(0, familyFolder.length - 1)
             // relative to modules/<module>/assets/<family>s
             file.src.relative = pathSegments.slice(4).join('/')
             break
           default:
-            return // ignore file
+            return false // ignore file
         }
         break
-      case 'attachments':
       case 'images':
-        if (!extname) return
-        file.src.family = familyFolder.substr(0, familyFolder.length - 1)
+        if (!extname) return false
+        file.src.family = familyFolder.substring(0, familyFolder.length - 1)
         // relative to modules/<module>/<family>s
         file.src.relative = pathSegments.slice(3).join('/')
         break
+      case 'attachments':
       case 'examples':
       case 'partials':
-        file.src.family = familyFolder.substr(0, familyFolder.length - 1)
+        file.src.family = familyFolder.substring(0, familyFolder.length - 1)
         // relative to modules/<module>/<family>s
         file.src.relative = pathSegments.slice(3).join('/')
         break
       default:
-        return // ignore file
+        return false // ignore file
     }
     file.src.module = pathSegments[1]
     file.src.moduleRootPath = calculateRootPath(pathSegments.length - 3)
+    if (!('private' in file) && ~('/' + file.src.relative).indexOf('/_')) file.private = true
+  } else if (origin && pathSegments[0] in families) {
+    return // defer file
   } else {
-    return // ignore file
+    return false // ignore file
   }
-  file.src.component = component
-  file.src.version = version
+  Object.assign(file.src, { component, version, componentVersion })
   return true
 }
 
@@ -152,7 +170,7 @@ function allocateSrc (file, component, version, nav) {
  * index, if this file is a navigation file, or undefined if it's not.
  */
 function getNavInfo (filepath, nav) {
-  const index = nav.findIndex((candidate) => candidate === filepath)
+  const index = nav.indexOf(filepath)
   if (~index) return nav.resolved.add(filepath) && { index }
 }
 

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')
@@ -21,6 +20,7 @@ class ContentCatalog {
   constructor (playbook = {}) {
     this[$components] = new Map()
     this[$files] = new Map()
+    this.publishableFamilies = new Set(['page', 'image', 'attachment'])
     const urls = playbook.urls || {}
     this.htmlUrlExtensionStyle = urls.htmlExtensionStyle || 'default'
     this.urlRedirectFacility = urls.redirectFacility || 'static'
@@ -61,8 +61,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) {
@@ -131,18 +136,18 @@ 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
   }
 
-  addFile (file, componentVersion) {
+  addFile (file) {
     const src = file.src
-    let { component, version, family } = src
-    let filesForFamily = this[$files].get(family)
-    if (!filesForFamily) this[$files].set(family, (filesForFamily = new Map()))
+    const family = src.family
+    let filesForFamily
+    if ((filesForFamily = this[$files].get(family)) == null) this[$files].set(family, (filesForFamily = new Map()))
     const key = generateKey(src)
     if (filesForFamily.has(key)) {
       if (family === 'alias') {
@@ -152,53 +157,73 @@ class ContentCatalog {
         .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 nav file: ${file.path} in ${src.version}@${src.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
+    if (!(file.created && File.isVinyl(file))) file = this.createFile(file)
+    filesForFamily.set(key, file)
+    return file
+  }
+
+  createFile (file) {
+    const src = file.src
+    let { componentVersion, family } = src
+    if (componentVersion) delete src.componentVersion
+    // 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 inflateSrc if the path property is not set
     if (!File.isVinyl(file)) {
-      prepareSrc(src)
+      inflateSrc(src)
       file = new File(file)
     }
+    Object.defineProperty(file, 'created', { configurable: true, writable: true, value: true })
     if (family === 'alias') {
       file.mediaType = 'text/html'
-      // 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 (file.rel.src.family === 'alias' && file.pub?.splat) return file
+      // NOTE the effective family of an alias is a page, which redirects to the target file
+      family = 'page'
       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?
-      file.mediaType = src.mediaType = resolveMimeType(src.extname) || (family === 'page' ? 'text/asciidoc' : undefined)
+      file.mediaType = src.mediaType = src.extname
+        ? resolveMimeType(src.extname) || (family === 'page' ? 'text/asciidoc' : undefined)
+        : 'text/plain'
     }
-    let publishable
-    let activeVersionSegment
+    let activeVersionSegment = false
+    let publishable, referenceable
     if (file.out) {
       publishable = true
     } else if ('out' in file) {
       delete file.out
-    } else if (
-      (family === 'page' || family === 'image' || family === 'attachment') &&
-      ('/' + src.relative).indexOf('/_') < 0
-    ) {
+    } else if (!file.private && this.publishableFamilies.has(family)) {
       publishable = true
-      if (componentVersion == null) componentVersion = this.getComponentVersion(component, version) || { version }
-      activeVersionSegment = computeVersionSegment.call(this, componentVersion)
-      file.out = computeOut(src, family, activeVersionSegment, this.htmlUrlExtensionStyle)
+      componentVersion ??= this.getComponentVersion(src.component, src.version) || { version: src.version }
+      activeVersionSegment =
+        'activeVersionSegment' in componentVersion
+          ? componentVersion.activeVersionSegment
+          : computeVersionSegment.call(this, componentVersion)
+      file.out = computeOut.call(this, src, family, activeVersionSegment)
+    }
+    if (!file.pub) {
+      if ('pub' in file) {
+        delete file.pub
+      } else if (publishable || family === 'nav') {
+        referenceable = true
+      }
     }
-    if (!file.pub && (publishable || family === 'nav')) {
-      if (activeVersionSegment == null) {
-        if (componentVersion == null) componentVersion = this.getComponentVersion(component, version) || { version }
-        activeVersionSegment = computeVersionSegment.call(this, componentVersion)
+    if (referenceable) {
+      if (activeVersionSegment === false) {
+        componentVersion ??= this.getComponentVersion(src.component, src.version) || { version: src.version }
+        activeVersionSegment =
+          'activeVersionSegment' in componentVersion
+            ? componentVersion.activeVersionSegment
+            : computeVersionSegment.call(this, componentVersion)
       }
-      file.pub = computePub(src, file.out, family, activeVersionSegment, this.htmlUrlExtensionStyle)
+      file.pub = computePub.call(this, src, file.out, family, activeVersionSegment)
     }
-    return filesForFamily.set(key, file) && file
+    return file
   }
 
   removeFile (file) {
@@ -254,21 +279,27 @@ class ContentCatalog {
     return this.getComponents().sort((a, b) => a[property].localeCompare(b[property]))
   }
 
-  getFiles () {
-    const accum = []
-    for (const filesForFamily of this[$files].values()) {
-      for (const file of filesForFamily.values()) accum.push(file)
+  getFiles (filter) {
+    const files = []
+    if (filter) {
+      for (const filesForFamily of this[$files].values()) {
+        for (const candidate of filesForFamily.values()) filter(candidate) && files.push(candidate)
+      }
+    } else {
+      for (const filesForFamily of this[$files].values()) {
+        for (const file of filesForFamily.values()) files.push(file)
+      }
     }
-    return accum
+    return files
   }
 
   getPages (filter) {
     const candidates = this[$files].get('page')
     if (!candidates) return []
     if (filter) {
-      const accum = []
-      for (const candidate of candidates.values()) filter(candidate) && accum.push(candidate)
-      return accum
+      const pages = []
+      for (const candidate of candidates.values()) filter(candidate) && pages.push(candidate)
+      return pages
     }
     return [...candidates.values()]
   }
@@ -286,17 +317,14 @@ class ContentCatalog {
     if ((file = this.getById(Object.assign({}, ROOT_INDEX_ALIAS_ID, { version })))) return file.rel
   }
 
-  registerComponentVersionStartPage (name, componentVersion, startPageSpec = undefined) {
-    const component = name
-    let version = componentVersion.version
-    if (version == null) {
+  registerComponentVersionStartPage (component, componentVersion, startPageSpec = undefined) {
+    if (componentVersion.constructor === String) {
       // QUESTION: should we warn or throw error if component version cannot be found?
       if (!(componentVersion = this.getComponentVersion(component, componentVersion))) return
-      version = componentVersion.version
     }
+    const version = componentVersion.version
     const activeVersionSegment = computeVersionSegment.call(this, componentVersion)
-    let startPage
-    let startPageSrc
+    let startPage, startPageSrc
     const indexPageId = Object.assign({}, ROOT_INDEX_PAGE_ID, { component, version })
     if (startPageSpec) {
       if (
@@ -305,11 +333,11 @@ class ContentCatalog {
         startPageSrc.version === version
       ) {
         if (!this.getById(indexPageId)) {
-          const indexAliasId = Object.assign({}, ROOT_INDEX_ALIAS_ID, { component, version })
+          const indexAliasId = Object.assign({}, ROOT_INDEX_ALIAS_ID, { component, version, componentVersion })
           const indexAlias = this.getById(indexAliasId)
           indexAlias
             ? indexAlias.synthetic && Object.assign(indexAlias, { rel: startPage })
-            : this.addFile({ src: indexAliasId, rel: startPage, synthetic: true }, componentVersion)
+            : this.addFile({ src: indexAliasId, rel: startPage, synthetic: true })
         }
       } else {
         // TODO pass componentVersion as logObject
@@ -328,20 +356,21 @@ class ContentCatalog {
     if (startPage) {
       componentVersion.url = startPage.pub.url
     } else if (!componentVersion.url) {
+      startPageSrc = inflateSrc(Object.assign({}, indexPageId, { family: 'page' }))
       // QUESTION: should we warn if the default start page cannot be found?
-      componentVersion.url = computePub(
-        (startPageSrc = prepareSrc(Object.assign({}, indexPageId, { family: 'page' }))),
-        computeOut(startPageSrc, startPageSrc.family, activeVersionSegment, this.htmlUrlExtensionStyle),
+      componentVersion.url = computePub.call(
+        this,
+        startPageSrc,
+        computeOut.call(this, startPageSrc, startPageSrc.family, activeVersionSegment),
         startPageSrc.family,
-        activeVersionSegment,
-        this.htmlUrlExtensionStyle
+        activeVersionSegment
       ).url
     }
     Object.defineProperties(componentVersion, {
       activeVersionSegment:
         activeVersionSegment === version
-          ? { configurable: true, enumerable: false, get: getVersion }
-          : { configurable: true, enumerable: false, value: activeVersionSegment },
+          ? { configurable: true, get: getVersion }
+          : { configurable: true, value: activeVersionSegment },
       files: {
         configurable: true,
         enumerable: false,
@@ -366,7 +395,7 @@ class ContentCatalog {
       const rootIndexAlias = this.getById(ROOT_INDEX_ALIAS_ID)
       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 })
+      return this.addFile({ src, rel, synthetic: true })
     }
     if (rel === false) {
       logger.warn('Start page specified for site has invalid syntax: %s', startPageSpec)
@@ -385,14 +414,9 @@ class ContentCatalog {
     // QUESTION should we throw an error if alias is invalid?
     if (!src || (inferredSpec && src.relative === '.adoc')) return
     const component = this.getComponent(src.component)
-    let componentVersion
     if (component) {
       // NOTE version is not set when alias specifies a component, but not a version
-      if (src.version == null) {
-        src.version = (componentVersion = component.latest).version
-      } else {
-        componentVersion = this.getComponentVersion(component, src.version)
-      }
+      src.version ??= (src.componentVersion = component.latest).version
       const existingPage = this.getById(src)
       if (existingPage) {
         throw new Error(
@@ -417,7 +441,7 @@ class ContentCatalog {
       )
     }
     // NOTE the redirect producer will populate contents when the redirect facility is 'static'
-    const alias = this.addFile({ src, rel: target }, componentVersion)
+    const alias = this.addFile({ src, rel: target })
     // NOTE record the first alias this target claims as the preferred one
     if (!target.rel) target.rel = alias
     return alias
@@ -436,36 +460,64 @@ class ContentCatalog {
     const basePub = { splat: true }
     const { component: fromComponent = to.component, versionSegment: fromVersionSegment } = from
     const fromSrc = Object.assign({ component: fromComponent, version: fromVersionSegment }, baseSrc)
-    const fromPub = Object.assign(computePub(fromSrc, computeOut(fromSrc, family, fromVersionSegment), family), basePub)
+    const fromPub = Object.assign(
+      computePub.call(this, fromSrc, computeOut.call(this, fromSrc, family, fromVersionSegment), family),
+      basePub
+    )
     const { component: toComponent, version: toVersion } = to
     const toVersionSegment =
       to.versionSegment ?? this.getComponentVersion(toComponent, toVersion)?.activeVersionSegment ?? toVersion
     const toSrc = Object.assign({ component: toComponent, version: toVersion ?? toVersionSegment }, baseSrc)
-    const toPub = Object.assign(computePub(toSrc, computeOut(toSrc, family, toVersionSegment), family), basePub)
+    const toPub = Object.assign(
+      computePub.call(this, toSrc, computeOut.call(this, toSrc, family, toVersionSegment), family),
+      basePub
+    )
     return this.addFile({ pub: fromPub, src: fromSrc, rel: { pub: toPub, src: toSrc } })
   }
 
   /**
-   * 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 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.
    *
-   * 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.
+   * 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.
    *
-   * @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.
+   * @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 ID spec refers, or undefined if the
-   * file cannot be resolved.
+   * @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)
   }
@@ -505,34 +557,30 @@ function generateResourceSpec ({ component, version, module: module_, family, re
   )
 }
 
-function prepareSrc (src) {
+function inflateSrc (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.substring(0, extname)
+        src.extname = basename.substring(extname)
       } else {
-        stem = basename
-        extname = ''
+        src.stem = basename
+        src.extname = ''
       }
     } else {
-      stem = basename.substr(0, basename.length - extname.length)
+      src.stem = basename.substring(0, basename.length - extname.length)
     }
   } else if (extname == null) {
-    update = true
-    extname = basename.substr(stem.length)
+    src.extname = basename.substring(stem.length)
   }
-  return update ? Object.assign(src, { basename, extname, stem }) : src
+  return src
 }
 
-function computeOut (src, family, versionSegment, htmlUrlExtensionStyle) {
+function computeOut (src, family, versionSegment) {
   let { component, module: module_, basename, extname, relative, stem } = src
   if (component === 'ROOT') component = ''
   if (module_ === 'ROOT') module_ = ''
@@ -540,16 +588,14 @@ function computeOut (src, family, versionSegment, htmlUrlExtensionStyle) {
   let familyPathSegment = ''
 
   if (family === 'page') {
-    if (stem !== 'index' && htmlUrlExtensionStyle === 'indexify') {
+    if (stem !== 'index' && this.htmlUrlExtensionStyle === 'indexify') {
       basename = 'index.html'
       indexifyPathSegment = stem
     } else if (extname === '.adoc') {
       basename = stem + '.html'
     }
-  } else if (family === 'image') {
-    familyPathSegment = '_images'
-  } else if (family === 'attachment') {
-    familyPathSegment = '_attachments'
+  } else if (this.publishableFamilies.has(family)) {
+    familyPathSegment = '_' + family + 's'
   }
 
   const modulePath = path.join(component, versionSegment, module_)
@@ -561,7 +607,7 @@ function computeOut (src, family, versionSegment, htmlUrlExtensionStyle) {
   return { dirname, basename, path: path_, moduleRootPath, rootPath }
 }
 
-function computePub (src, out, family, versionSegment, htmlUrlExtensionStyle) {
+function computePub (src, out, family, versionSegment) {
   const pub = {}
   let url
   if (family === 'nav') {
@@ -577,19 +623,19 @@ function computePub (src, out, family, versionSegment, htmlUrlExtensionStyle) {
   } else if (family === 'page') {
     const urlSegments = out.path.split('/')
     const lastUrlSegmentIdx = urlSegments.length - 1
-    if (htmlUrlExtensionStyle === 'drop') {
+    if (this.htmlUrlExtensionStyle === 'drop') {
       // drop just the .html extension or, if the filename is index.html, the whole segment
       const lastUrlSegment = urlSegments[lastUrlSegmentIdx]
       urlSegments[lastUrlSegmentIdx] =
-        lastUrlSegment === 'index.html' ? '' : lastUrlSegment.substr(0, lastUrlSegment.length - 5)
-    } else if (htmlUrlExtensionStyle === 'indexify') {
+        lastUrlSegment === 'index.html' ? '' : lastUrlSegment.substring(0, lastUrlSegment.length - 5)
+    } else if (this.htmlUrlExtensionStyle === 'indexify') {
       urlSegments[lastUrlSegmentIdx] = ''
     }
     url = '/' + urlSegments.join('/')
   } 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/parse-resource-id.js

@@ -59,7 +59,7 @@ function parseResourceId (spec, ctx = {}, defaultFamily = 'page', permittedFamil
     const relativeSegments = relative.split('/')
     let from
     if (relativeSegments[0] === '.' && (from = ctx.relative)) {
-      relativeSegments[0] = from.substr(0, (from.lastIndexOf('/') + 1 || 1) - 1)
+      relativeSegments[0] = from.substring(0, (from.lastIndexOf('/') + 1 || 1) - 1)
     }
     relative = relativeSegments
       .reduce((accum, segment) => {

package/lib/util/resolve-resource.js

@@ -26,7 +26,7 @@ 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?.family) return false
   if (id.version == null) {
     const component = catalog.getComponent(id.component)
     if (!component) return

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

@@ -33,7 +33,7 @@ function versionCompareDesc (a, b) {
 function resolveSemver (str) {
   const chr0 = str.charAt()
   if (chr0 === 'v') {
-    if (isDigit(str.charAt(1)) && (str = str.substr(1)) && (~str.indexOf('.') || isDigit(str.charAt()))) {
+    if (isDigit(str.charAt(1)) && (str = str.substring(1)) && (~str.indexOf('.') || isDigit(str.charAt()))) {
       return str
     }
   } else if (isDigit(chr0) && (~str.indexOf('.') || isInteger(Number(str)))) {
@@ -51,12 +51,12 @@ function semverCompare (a, b) {
   const preOffsetA = a.indexOf('-')
   const preOffsetB = b.indexOf('-')
   if (~preOffsetA) {
-    preA = a.substr(preOffsetA + 1)
-    a = a.substr(0, preOffsetA)
+    preA = a.substring(preOffsetA + 1)
+    a = a.substring(0, preOffsetA)
   }
   if (~preOffsetB) {
-    preB = b.substr(preOffsetB + 1)
-    b = b.substr(0, preOffsetB)
+    preB = b.substring(preOffsetB + 1)
+    b = b.substring(0, preOffsetB)
   }
   const numsA = a.split('.')
   const numsB = b.split('.')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/content-classifier",
-  "version": "3.2.0-alpha.8",
+  "version": "3.2.0-rc.1",
   "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)",
@@ -31,13 +31,13 @@
     "#constants": "./lib/constants.js"
   },
   "dependencies": {
-    "@antora/asciidoc-loader": "3.2.0-alpha.8",
-    "@antora/logger": "3.2.0-alpha.8",
-    "mime-types": "~2.1",
+    "@antora/asciidoc-loader": "3.2.0-rc.1",
+    "@antora/logger": "3.2.0-rc.1",
+    "mime-types": "~3.0",
     "vinyl": "~3.0"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "files": [
     "lib/"
@@ -51,7 +51,7 @@
     "web publishing"
   ],
   "scripts": {
-    "test": "_mocha",
+    "test": "node --test",
     "prepublishOnly": "npx -y downdoc@latest --prepublish",
     "postpublish": "npx -y downdoc@latest --postpublish"
   }