@antora/content-aggregator 3.2.0-alpha.8 → 3.2.0-alpha.9

package/lib/aggregate-content.js

@@ -132,7 +132,7 @@ async function collectFiles (sourcesByUrl, loadOpts, concurrency, fetchedUrls =
     }
     return Promise.all(
       results.map(({ repo, authStatus, sources }) =>
-        selectStartPathsForRepository(repo, authStatus, sources).then((startPaths) =>
+        selectStartPathsForRepository(repo, sources).then((startPaths) =>
           collectFilesFromStartPaths.bind(null, startPaths, repo, authStatus)
         )
       )
@@ -249,19 +249,32 @@ function extractCredentials (url) {
   return { displayUrl: url, url }
 }
 
-async function selectStartPathsForRepository (repo, authStatus, sources) {
+async function selectStartPathsForRepository (repo, sources) {
   const startPaths = []
   const originUrls = {}
   for (const source of sources) {
     const { version, editUrl } = source
-    // NOTE if repository is managed (has a url property), we can assume the remote name is origin
-    // TODO if the repo has no remotes, then remoteName should be undefined
-    const remoteName = repo.url ? 'origin' : source.remote || 'origin'
-    const originUrl = repo.url || (originUrls[remoteName] ||= await resolveRemoteUrl(repo, remoteName))
+    let remoteName, originUrl
+    if (repo.url) {
+      remoteName = 'origin' // NOTE if repository is managed (has url property), we can assume remote name is origin
+      originUrl = repo.url
+    } else {
+      remoteName = source.remote || 'origin'
+      originUrl =
+        remoteName in originUrls
+          ? originUrls[remoteName]
+          : (originUrls[remoteName] = await resolveRemoteUrl(repo, remoteName))
+      if (!originUrl) {
+        remoteName = undefined
+        if ((originUrl = posixify ? 'file:///' + posixify(repo.dir) : 'file://' + repo.dir).indexOf(' ')) {
+          originUrl = originUrl.replace(SPACE_RX, '%20')
+        }
+      }
+    }
     const refs = await selectReferences(source, repo, remoteName)
     if (refs.length) {
       for (const ref of refs) {
-        for (const startPath of await selectStartPaths(source, repo, remoteName, ref)) {
+        for (const startPath of await selectStartPaths(source, repo, ref)) {
           startPaths.push({ startPath, ref, originUrl, editUrl, version })
         }
       }
@@ -361,45 +374,40 @@ async function selectReferences (source, repo, remote) {
     }
   }
   // NOTE isomorphic-git includes HEAD in list of remote branches (see https://isomorphic-git.org/docs/listBranches)
-  const remoteBranches = (await git.listBranches(Object.assign({ remote }, repo))).filter((it) => it !== 'HEAD')
+  const remoteBranches = remote
+    ? (await git.listBranches(Object.assign({ remote }, repo))).filter((it) => it !== 'HEAD')
+    : []
   if (remoteBranches.length) {
     for (const shortname of filterRefs(remoteBranches, branchPatterns, patternCache)) {
       const fullname = 'remotes/' + remote + '/' + shortname
       refs.set(shortname, { shortname, fullname, type: 'branch', remote, head: noWorktree })
     }
   }
-  // NOTE only consider local branches if repo has a worktree or there are no remote tracking branches
-  if (!isBare) {
+  if (!managed) {
     const localBranches = await git.listBranches(repo).then((branches) => {
-      if (branches.length) return branches
-      if (currentBranch == null) return getCurrentBranchName(repo).then((branch) => (branch ? [branch] : []))
-      return currentBranch ? [currentBranch] : []
+      if (branches.length || isBare) return branches
+      if (currentBranch != null) return [currentBranch]
+      return getCurrentBranchName(repo).then((branch) => (branch ? [branch] : []))
     })
-    if (localBranches.length) {
-      const worktrees = await findWorktrees(repo, worktreePatterns)
-      let onMatch
-      if ((worktreePatterns.join('') || '.') !== '.') {
-        const symbolicNames = new Map()
-        worktrees.forEach(({ name, symbolicName = 'HEAD@' + name }, shortname) => {
-          localBranches.push(symbolicName)
-          symbolicNames.set(symbolicName, shortname)
-        })
-        onMatch = (candidate, { pattern }) => {
-          const shortname = symbolicNames.get(candidate)
-          return shortname ? (pattern.startsWith('HEAD@') ? shortname : undefined) : candidate
-        }
-      }
-      for (const shortname of filterRefs(localBranches, branchPatterns, patternCache, onMatch)) {
-        const head = (worktrees.get(shortname) || { head: noWorktree }).head
-        refs.set(shortname, { shortname, fullname: 'heads/' + shortname, type: 'branch', head })
+    const worktrees = await findWorktrees(repo, worktreePatterns)
+    let onMatch
+    if ((worktreePatterns.join('') || '.') !== '.') {
+      const symbolicNames = new Map()
+      worktrees.forEach(({ name, symbolicName = 'HEAD@' + name }, shortname) => {
+        localBranches.push(symbolicName)
+        symbolicNames.set(symbolicName, shortname)
+      })
+      onMatch = (candidate, { pattern }) => {
+        const shortname = symbolicNames.get(candidate)
+        return shortname ? (pattern.startsWith('HEAD@') ? shortname : undefined) : candidate
       }
     }
-  } else if (!managed || !remoteBranches.length) {
-    const localBranches = await git.listBranches(repo)
     if (localBranches.length) {
-      for (const shortname of filterRefs(localBranches, branchPatterns, patternCache)) {
-        if (refs.has(shortname)) continue // NOTE prefer remote branches in bare repository
-        refs.set(shortname, { shortname, fullname: 'heads/' + shortname, type: 'branch', head: noWorktree })
+      const preferRemote = isBare && remoteBranches.length > 0
+      for (const shortname of filterRefs(localBranches, branchPatterns, patternCache, onMatch)) {
+        if (preferRemote && refs.has(shortname)) continue
+        const head = (worktrees.get(shortname) || { head: false }).head
+        refs.set(shortname, { shortname, fullname: 'heads/' + shortname, type: 'branch', head })
       }
     }
   }
@@ -419,7 +427,7 @@ function getCurrentBranchName (repo, remote) {
   ).then((ref) => (ref.startsWith('refs/') ? ref.replace(SHORTEN_REF_RX, '') : undefined))
 }
 
-async function selectStartPaths (source, repo, remoteName, ref) {
+async function selectStartPaths (source, repo, ref) {
   const url = repo.url
   const displayUrl = url || repo.dir
   const worktreePath = ref.head
@@ -734,18 +742,18 @@ function loadComponentDescriptor (files, ref, version) {
   if (!version) {
     if (version === undefined) throw new Error(`${COMPONENT_DESC_FILENAME} is missing a version`)
     if (version === false) throw new Error(`${COMPONENT_DESC_FILENAME} has an invalid version`)
-    version = '' + (typeof version === 'number' ? version : '')
+    version = typeof version === 'number' ? '' + version : ''
   } else if (version === true) {
     version = ref.shortname.replace(PATH_SEPARATOR_RX, '-')
   } else if (version.constructor === Object) {
     const refname = ref.shortname
     let matched
     if (refname in version) {
-      matched = version[refname]
+      matched = '' + (version[refname] ?? '')
     } else if (
       !Object.entries(version).some(([pattern, replacement]) => {
-        const result = refname.replace(makeMatcherRx(pattern, VERSION_MATCHER_OPTS), '\0' + replacement)
-        if (result === refname) return false
+        const result = refname.replace(makeMatcherRx(pattern, VERSION_MATCHER_OPTS), '\0' + (replacement ?? ''))
+        if (result === refname) return false // no match
         matched = result.substr(1)
         return true
       })
@@ -914,21 +922,18 @@ function generateCloneFolderName (url) {
  *
  * @param {Repository} repo - The repository on which to operate.
  * @param {String} remoteName - The name of the remote to resolve.
- * @returns {String} The URL of the specified remote, if defined, or the file URI to the local repository.
+ * @returns {String} The URL of the specified remote, if defined
  */
 function resolveRemoteUrl (repo, remoteName) {
   return git.getConfig(Object.assign({ path: 'remote.' + remoteName + '.url' }, repo)).then((url) => {
-    if (url) {
-      if (url.startsWith('https://') || url.startsWith('http://')) {
-        return ~url.indexOf('@') ? url.replace(URL_AUTH_CLEANER_RX, '$1') : url
-      }
-      if (url.startsWith('git@')) return 'https://' + url.substr(4).replace(':', '/')
-      if (url.startsWith('ssh://')) {
-        return 'https://' + url.substr(url.indexOf('@') + 1 || 6).replace(URL_PORT_CLEANER_RX, '$1')
-      }
+    if (!url) return
+    if (url.startsWith('https://') || url.startsWith('http://')) {
+      return ~url.indexOf('@') ? url.replace(URL_AUTH_CLEANER_RX, '$1') : url
+    }
+    if (url.startsWith('git@')) return 'https://' + url.substr(4).replace(':', '/')
+    if (url.startsWith('ssh://')) {
+      return 'https://' + url.substr(url.indexOf('@') + 1 || 6).replace(URL_PORT_CLEANER_RX, '$1')
     }
-    url = posixify ? 'file:///' + posixify(repo.dir) : 'file://' + repo.dir
-    return ~url.indexOf(' ') ? url.replace(SPACE_RX, '%20') : url
   })
 }
 
@@ -1065,31 +1070,29 @@ function resolveRepositoryFromWorktree (repo) {
 function findWorktrees (repo, patterns) {
   if (!patterns.length) return new Map()
   const mainWorktree =
-    patterns[0] === '.' && (patterns = patterns.slice(1))
+    patterns[0] === '.' && (patterns = patterns.slice(1)) && !repo.noCheckout
       ? getCurrentBranchName(repo).then((branch) => branch && [branch, { head: repo.dir, name: '.' }])
       : Promise.resolve()
-  const worktreesDir = patterns.length ? ospath.join(repo.dir, '.git', 'worktrees') : undefined
+  if (!patterns.length) return mainWorktree.then((entry) => new Map(entry && [entry]))
+  const worktreesDir = ospath.join(repo.dir, repo.dir === repo.gitdir ? '' : '.git', 'worktrees')
   const patternCache = repo.cache[REF_PATTERN_CACHE_KEY]
-  return (
-    worktreesDir
-      ? fsp
-          .readdir(worktreesDir)
-          .then((worktreeNames) => filterRefs(worktreeNames, patterns, patternCache), invariably.emptyArray)
-          .then((worktreeNames) =>
-            Promise.all(
-              worktreeNames.map((worktreeName) => {
-                const gitdir = ospath.resolve(worktreesDir, worktreeName)
-                // NOTE branch name defaults to worktree name if HEAD is detached
-                return getCurrentBranchName(Object.assign({}, repo, { gitdir })).then((branch = worktreeName) =>
-                  fsp
-                    .readFile(ospath.join(gitdir, 'gitdir'), 'utf8')
-                    .then((contents) => [branch, { head: ospath.dirname(contents.trimEnd()), name: worktreeName }])
-                )
-              })
-            )
+  return fsp
+    .readdir(worktreesDir)
+    .then((worktreeNames) => filterRefs(worktreeNames, patterns, patternCache), invariably.emptyArray)
+    .then((worktreeNames) =>
+      Promise.all(
+        worktreeNames.map((worktreeName) => {
+          const gitdir = ospath.resolve(worktreesDir, worktreeName)
+          // NOTE branch name defaults to worktree name if HEAD is detached
+          return getCurrentBranchName(Object.assign({}, repo, { gitdir })).then((branch = worktreeName) =>
+            fsp
+              .readFile(ospath.join(gitdir, 'gitdir'), 'utf8')
+              .then((contents) => [branch, { head: ospath.dirname(contents.trimEnd()), name: worktreeName }])
           )
-      : Promise.resolve()
-  ).then((entries = []) => mainWorktree.then((entry) => new Map(entry ? entries.push(entry) && entries : entries)))
+        })
+      )
+    )
+    .then((entries) => mainWorktree.then((main) => (main ? new Map(entries).set(main[0], main[1]) : new Map(entries))))
 }
 
 async function gracefulPromiseAllWithLimit (tasks, limit = Infinity) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/content-aggregator",
-  "version": "3.2.0-alpha.8",
+  "version": "3.2.0-alpha.9",
   "description": "Fetches and aggregates content from distributed sources for use in an Antora documentation pipeline.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "@antora/expand-path-helper": "~3.0",
-    "@antora/logger": "3.2.0-alpha.8",
+    "@antora/logger": "3.2.0-alpha.9",
     "@antora/user-require-helper": "~3.0",
     "braces": "~3.0",
     "cache-directory": "~2.0",