@antora/content-classifier 3.0.0-beta.3 → 3.0.0-rc.1

package/lib/classify-content.js

@@ -64,10 +64,10 @@ function allocateSrc (file, component, version, nav) {
     let familyFolder = pathSegments[2]
     switch (familyFolder) {
       case 'pages':
-        // this location for partials is deprecated; warn starting in Antora 3.x
+        // pages/_partials location for partials is @deprecated; special designation scheduled to be removed in Antora 4
         if (pathSegments[3] === '_partials') {
           file.src.family = 'partial'
-          // relative to modules/<module>/pages/_partials (deprecated)
+          // relative to modules/<module>/pages/_partials
           file.src.relative = pathSegments.slice(4).join('/')
         } else if (extname === '.adoc') {
           file.src.family = 'page'

package/lib/content-catalog.js

@@ -268,8 +268,12 @@ class ContentCatalog {
         (startPageSrc = startPage.src).component === name &&
         startPageSrc.version === version
       ) {
-        if ((startPageSrc.module !== 'ROOT' || startPageSrc.relative !== 'index.adoc') && !this.getById(indexPageId)) {
-          this.addFile({ src: Object.assign({}, indexPageId, { family: 'alias' }), rel: startPage })
+        if (!this.getById(indexPageId)) {
+          const indexAliasId = Object.assign({}, ROOT_INDEX_ALIAS_ID, { component: name, version })
+          const indexAlias = this.getById(indexAliasId)
+          indexAlias
+            ? indexAlias.synthetic && Object.assign(indexAlias, { rel: startPage })
+            : this.addFile({ src: indexAliasId, rel: startPage, synthetic: true })
         }
       } else {
         // TODO pass componentVersion as logObject
@@ -312,7 +316,9 @@ class ContentCatalog {
     if (!startPageSpec) return
     const rel = this.resolvePage(startPageSpec)
     if (rel) {
-      if (!(this.getSiteStartPage() || { synthetic: true }).synthetic) return
+      if (this.getById(ROOT_INDEX_PAGE_ID)) return
+      const indexAlias = this.getById(ROOT_INDEX_ALIAS_ID)
+      if (indexAlias) return indexAlias.synthetic ? Object.assign(indexAlias, { rel }) : undefined
       return this.addFile({ src: Object.assign({}, ROOT_INDEX_ALIAS_ID), rel, synthetic: true })
     } else if (rel === false) {
       logger.warn('Start page specified for site has invalid syntax: %s', startPageSpec)
@@ -325,7 +331,7 @@ class ContentCatalog {
 
   // QUESTION should this be addPageAlias?
   registerPageAlias (spec, target) {
-    // .adoc file extension will be required on ID spec for page alias starting in Antora 4 (possibly in Antora 3)
+    // adding .adoc file extension to page alias if missing is @deprecated; scheduled to be removed in Antora 4
     const inferredSpec = spec.endsWith('.adoc') ? undefined : spec + '.adoc'
     const src = parseResourceId(inferredSpec || spec, target.src, 'page', ['page'])
     // QUESTION should we throw an error if alias is invalid?
@@ -519,9 +525,9 @@ function computePub (src, out, family, version, htmlUrlExtensionStyle) {
 }
 
 function computeVersionSegment (name, version, mode) {
+  // special designation for master verson is @deprecated; special designation scheduled to be removed in Antora 4
   if (mode === 'original') return !version || version === 'master' ? '' : version
   const strategy = this.latestVersionUrlSegmentStrategy
-  // NOTE: special exception; revisit in Antora 3
   if (!version || version === 'master') {
     if (mode !== 'alias') return ''
     if (strategy === 'redirect:to') return
@@ -565,15 +571,9 @@ function createSymbolicVersionAlias (component, version, symbolicVersionSegment,
       family
     ),
   }
-  if (strategy === 'redirect:to') {
-    originalVersionAlias.out = undefined
-    originalVersionAlias.rel = symbolicVersionAlias
-    return originalVersionAlias
-  } else {
-    symbolicVersionAlias.out = undefined
-    symbolicVersionAlias.rel = originalVersionAlias
-    return symbolicVersionAlias
-  }
+  return strategy === 'redirect:to'
+    ? Object.assign(originalVersionAlias, { out: undefined, rel: symbolicVersionAlias })
+    : Object.assign(symbolicVersionAlias, { out: undefined, rel: originalVersionAlias })
 }
 
 function getFileLocation ({ path: path_, src: { abspath, origin } }) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/content-classifier",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.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)",
@@ -15,8 +15,11 @@
     "url": "https://gitlab.com/antora/antora/issues"
   },
   "main": "lib/index.js",
+  "scripts": {
+    "test": "_mocha"
+  },
   "dependencies": {
-    "@antora/logger": "3.0.0-beta.3",
+    "@antora/logger": "3.0.0-rc.1",
     "mime-types": "~2.1",
     "vinyl": "~2.2"
   },
@@ -34,5 +37,5 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "45da95a2e2dea538379d2d9f42013d2208fb86c3"
+  "gitHead": "044371a33e2c0fed9724d30945bbb549d64845d5"
 }