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

package/lib/classify-content.js

@@ -2,6 +2,8 @@
 
 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')
 
 /**
  * Organizes the raw aggregate of virtual files into a {ContentCatalog}.
@@ -42,10 +44,18 @@ function addFilesAndRegisterStartPages (contentCatalog, siteStartPage) {
   for (const { versions: componentVersions } of contentCatalog.getComponents()) {
     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)
         files[i] = undefined // free memory
       }
+      if (navResolved && nav.length > navResolved.size && new Set(nav).size > navResolved.size) {
+        const loc = summarizeFileLocation({ path: 'antora.yml', src: { origin: nav.origin } })
+        for (const filepath of nav) {
+          if (navResolved.has(filepath)) continue
+          logger.warn('Could not resolve nav entry for %s@%s defined in %s: %s', version, component, loc, filepath)
+        }
+      }
       contentCatalog.registerComponentVersionStartPage(component, componentVersion, startPage)
     }
   }
@@ -61,9 +71,9 @@ function allocateSrc (file, component, version, nav) {
     return true
   }
   const filepath = file.path
-  const navInfo = nav && getNavInfo(filepath, nav)
   const pathSegments = filepath.split('/')
-  if (navInfo) {
+  let navInfo
+  if (nav && (navInfo = getNavInfo(filepath, nav))) {
     if (extname !== '.adoc') return // ignore file
     file.nav = navInfo
     file.src.family = 'nav'
@@ -73,14 +83,14 @@ function allocateSrc (file, component, version, nav) {
       file.src.relative = pathSegments.slice(2).join('/')
       file.src.moduleRootPath = calculateRootPath(pathSegments.length - 3)
     } else {
-      // relative to root
+      // relative to content source root
       file.src.relative = filepath
     }
   } else if (pathSegments[0] === 'modules') {
     let familyFolder = pathSegments[2]
     switch (familyFolder) {
       case 'pages':
-        // pages/_partials location for partials is @deprecated; special designation scheduled to be removed in Antora 4
+        // pages/_partials location for partials is @deprecated; special designation scheduled for removal in Antora 4
         if (pathSegments[3] === '_partials') {
           file.src.family = 'partial'
           // relative to modules/<module>/pages/_partials
@@ -143,7 +153,7 @@ function allocateSrc (file, component, version, nav) {
  */
 function getNavInfo (filepath, nav) {
   const index = nav.findIndex((candidate) => candidate === filepath)
-  if (~index) return { index }
+  if (~index) return nav.resolved.add(filepath) && { index }
 }
 
 function resolveAsciiDocConfig (siteAsciiDocConfig, { asciidoc, origins = [] }) {

package/lib/content-catalog.js

@@ -5,8 +5,9 @@ const invariably = { void: () => undefined }
 const logger = require('./logger')
 const { lookup: resolveMimeType } = require('./mime-types-with-asciidoc')
 const parseResourceId = require('./util/parse-resource-id')
-const { posix: path } = require('path')
+const { posix: path } = require('node:path')
 const resolveResource = require('./util/resolve-resource')
+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')
@@ -75,6 +76,7 @@ class ContentCatalog {
         }
       }
     }
+    // NOTE if no AsciiDoc attributes are defined in the component descriptor, asciidoc is the siteAsciiDocConfig object
     if (asciidoc) componentVersion.asciidoc = asciidoc
     const component = this[$components].get(name)
     if (component) {
@@ -147,10 +149,10 @@ class ContentCatalog {
         throw new Error(`Duplicate alias: ${generateResourceSpec(src)}`)
       } else {
         const details = [filesForFamily.get(key), file]
-          .map((it, idx) => `${idx + 1}: ${getFileLocation(it)}`)
+          .map((it, idx) => `${idx + 1}: ${summarizeFileLocation(it)}`)
           .join(LOG_WRAP)
         if (family === 'nav') {
-          throw new Error(`Duplicate nav in ${version}@${component}: ${file.path}${LOG_WRAP}${details}`)
+          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}`)
         }
@@ -398,10 +400,10 @@ class ContentCatalog {
         throw new Error(
           existingPage === target
             ? `Page cannot define alias that references itself: ${generateResourceSpec(src)}` +
-              ` (specified as: ${spec})${LOG_WRAP}source: ${getFileLocation(existingPage)}`
+              ` (specified as: ${spec})${LOG_WRAP}source: ${summarizeFileLocation(existingPage)}`
             : `Page alias cannot reference an existing page: ${generateResourceSpec(src)} (specified as: ${spec})` +
-              `${LOG_WRAP}source: ${getFileLocation(target)}` +
-              `${LOG_WRAP}existing page: ${getFileLocation(existingPage)}`
+              `${LOG_WRAP}source: ${summarizeFileLocation(target)}` +
+              `${LOG_WRAP}existing page: ${summarizeFileLocation(existingPage)}`
         )
       }
     } else if (src.version == null) {
@@ -413,7 +415,7 @@ class ContentCatalog {
     if (existingAlias) {
       throw new Error(
         `Duplicate alias: ${generateResourceSpec(src)} (specified as: ${spec})` +
-          `${LOG_WRAP}source: ${getFileLocation(target)}`
+          `${LOG_WRAP}source: ${summarizeFileLocation(target)}`
       )
     }
     // NOTE the redirect producer will populate contents when the redirect facility is 'static'
@@ -631,15 +633,6 @@ function computeVersionSegment (componentVersion, mode) {
   return versionSegment
 }
 
-function getFileLocation ({ path: path_, src: { abspath, origin } }) {
-  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})`
-}
-
 function getComponentVersionFiles (componentVersionId) {
   return this.findBy(componentVersionId)
 }

package/lib/util/summarize-file-location.js

@@ -0,0 +1,14 @@
+'use strict'
+
+const { posix: path } = require('node:path')
+
+function summarizeFileLocation ({ path: path_, src: { abspath, origin } }) {
+  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 = summarizeFileLocation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/content-classifier",
-  "version": "3.2.0-alpha.4",
+  "version": "3.2.0-alpha.5",
   "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)",
@@ -27,13 +27,13 @@
     "#constants": "./lib/constants.js"
   },
   "dependencies": {
-    "@antora/asciidoc-loader": "3.2.0-alpha.4",
-    "@antora/logger": "3.2.0-alpha.4",
+    "@antora/asciidoc-loader": "3.2.0-alpha.5",
+    "@antora/logger": "3.2.0-alpha.5",
     "mime-types": "~2.1",
-    "vinyl": "~2.2"
+    "vinyl": "~3.0"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
   "files": [
     "lib/"