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

package/lib/aggregate-content.js

@@ -18,13 +18,13 @@ const { NotFoundError, ObjectTypeError, UnknownTransportError, UrlParseError } =
 const globStream = require('glob-stream')
 const invariably = require('./invariably')
 const { makeMatcherRx, versionMatcherOpts: VERSION_MATCHER_OPTS } = require('./matcher')
-const MultiProgress = require('multi-progress')
+const MultiProgress = require('multi-progress') // calls require('progress') as a peer dependencies
 const ospath = require('path')
 const { posix: path } = ospath
 const posixify = ospath.sep === '\\' ? (p) => p.replace(/\\/g, '/') : undefined
 const { fs: resolvePathGlobsFs, git: resolvePathGlobsGit } = require('./resolve-path-globs')
-const { pipeline, Transform } = require('stream')
-const map = (transform) => new Transform({ objectMode: true, transform })
+const { pipeline, Writable } = require('stream')
+const forEach = (write) => new Writable({ objectMode: true, write })
 const userRequire = require('@antora/user-require-helper')
 const yaml = require('js-yaml')
 
@@ -227,9 +227,8 @@ async function loadRepository (url, opts) {
     try {
       await git.resolveRef(Object.assign({ ref: 'HEAD', depth: 1 }, repo))
     } catch {
-      throw new Error(
-        `Local content source must be a git repository: ${dir}${url !== dir ? ' (url: ' + url + ')' : ''}`
-      )
+      const msg = `Local content source must be a git repository: ${dir}${url !== dir ? ' (url: ' + url + ')' : ''}`
+      throw new Error(msg)
     }
   } else {
     throw new Error(`Local content source does not exist: ${dir}${url !== dir ? ' (url: ' + url + ')' : ''}`)
@@ -429,14 +428,15 @@ function collectFilesFromStartPath (startPath, repo, authStatus, ref, worktreePa
       return componentVersionBucket
     })
     .catch((err) => {
+      const msg = err.message
       const refInfo = `ref: ${ref.fullname.replace(HEADS_DIR_RX, '')}${worktreePath ? ' <worktree>' : ''}`
-      const pathInfo = !startPath || err.message.startsWith('the start path ') ? '' : ' | path: ' + startPath
-      throw Object.assign(err, { message: `${err.message} in ${repo.url || repo.dir} (${refInfo}${pathInfo})` })
+      const pathInfo = !startPath || msg.startsWith('the start path ') ? '' : ' | path: ' + startPath
+      throw Object.assign(err, { message: msg.replace(/$/m, ` in ${repo.url || repo.dir} (${refInfo}${pathInfo})`) })
     })
 }
 
 function readFilesFromWorktree (worktreePath, startPath) {
-  const cwd = ospath.join(worktreePath, startPath)
+  const cwd = ospath.join(worktreePath, startPath, '.') // . shaves off trailing slash
   return fsp.stat(cwd).then(
     (startPathStat) => {
       if (!startPathStat.isDirectory()) throw new Error(`the start path '${startPath}' is not a directory`)
@@ -449,23 +449,24 @@ function readFilesFromWorktree (worktreePath, startPath) {
 }
 
 function srcFs (cwd) {
-  return new Promise((resolve, reject, cache = {}, files = []) =>
+  const relpathStart = cwd.length + 1
+  return new Promise((resolve, reject, cache = Object.create(null), files = []) =>
     pipeline(
       globStream(CONTENT_SRC_GLOB, Object.assign({ cache, cwd }, CONTENT_SRC_OPTS)),
-      map(({ path: abspathPosix }, _, next) => {
-        if (Array.isArray(cache[abspathPosix])) return next() // optimization, but not guaranteed
+      forEach(({ path: abspathPosix }, _, done) => {
+        if (Array.isArray(cache[abspathPosix])) return done() // detects some directories, but not all
         const abspath = posixify ? ospath.normalize(abspathPosix) : abspathPosix
-        const relpath = abspath.substr(cwd.length + 1)
+        const relpath = abspath.substr(relpathStart)
         symlinkAwareStat(abspath).then(
           (stat) => {
-            if (stat.isDirectory()) return next()
+            if (stat.isDirectory()) return done() // detects remaining directories
             fsp.readFile(abspath).then(
               (contents) => {
                 files.push(new File({ path: posixify ? posixify(relpath) : relpath, contents, stat, src: { abspath } }))
-                next()
+                done()
               },
               (readErr) => {
-                next(Object.assign(readErr, { message: readErr.message.replace(`'${abspath}'`, relpath) }))
+                done(Object.assign(readErr, { message: readErr.message.replace(`'${abspath}'`, relpath) }))
               }
             )
           },
@@ -478,7 +479,7 @@ function srcFs (cwd) {
             } else {
               statErr.message = statErr.message.replace(`'${abspath}'`, relpath)
             }
-            next(statErr)
+            done(statErr)
           }
         )
       }),
@@ -652,7 +653,7 @@ function loadComponentDescriptor (files, ref, version) {
   files.splice(descriptorFileIdx, 1)
   let data
   try {
-    data = yaml.load(descriptorFile.contents.toString())
+    data = yaml.load(descriptorFile.contents.toString(), { schema: yaml.CORE_SCHEMA })
   } catch (err) {
     throw Object.assign(err, { message: `${COMPONENT_DESC_FILENAME} has invalid syntax; ${err.message}` })
   }
@@ -664,7 +665,8 @@ function loadComponentDescriptor (files, ref, version) {
   if ('version' in data) version = data.version
   if (!version) {
     if (version === undefined) throw new Error(`${COMPONENT_DESC_FILENAME} is missing a version`)
-    version = ''
+    if (version === false) throw new Error(`${COMPONENT_DESC_FILENAME} has an invalid version`)
+    version = '' + (typeof version === 'number' ? version : '')
   } else if (version === true) {
     version = ref.shortname.replace(PATH_SEPARATOR_RX, '-')
   } else if (version.constructor === Object) {
@@ -686,7 +688,7 @@ function loadComponentDescriptor (files, ref, version) {
       throw new Error(`version in ${COMPONENT_DESC_FILENAME} cannot have path segments: ${matched}`)
     }
     version = matched.replace(PATH_SEPARATOR_RX, '-')
-  } else if ((version = String(version)) === '.' || version === '..' || ~version.indexOf('/')) {
+  } else if ((version = '' + version) === '.' || version === '..' || ~version.indexOf('/')) {
     throw new Error(`version in ${COMPONENT_DESC_FILENAME} cannot have path segments: ${version}`)
   }
   data.version = version
@@ -702,7 +704,8 @@ function computeOrigin (url, authStatus, gitdir, ref, startPath, worktreePath =
   } else {
     if (worktreePath) {
       origin.fileUriPattern =
-        (posixify ? 'file:///' + posixify(worktreePath) : 'file://' + worktreePath) + path.join('/', startPath, '%s')
+        (posixify ? 'file:///' + posixify(worktreePath) : 'file://' + worktreePath) +
+        (startPath ? '/' + startPath + '/%s' : '/%s')
     } else {
       origin.refhash = refhash
     }
@@ -890,7 +893,8 @@ function resolveRemoteUrl (repo, remoteName) {
         return 'https://' + url.substr(url.indexOf('@') + 1 || 6).replace(URL_PORT_CLEANER_RX, '$1')
       }
     }
-    return posixify ? 'file:///' + posixify(repo.dir) : 'file://' + repo.dir
+    url = posixify ? 'file:///' + posixify(repo.dir) : 'file://' + repo.dir
+    return ~url.indexOf(' ') ? url.replace(SPACE_RX, '%20') : url
   })
 }
 

package/lib/git-credential-manager-store.js

@@ -9,10 +9,9 @@ const ospath = require('path')
 class GitCredentialManagerStore {
   configure ({ config, startDir }) {
     this.entries = undefined
+    this.path = undefined
     this.urls = {}
-    if ((this.contents = (config = config || {}).contents) || !config.path) {
-      this.path = undefined
-    } else {
+    if (!(this.contents = (config = config || {}).contents) && config.path) {
       this.path = expandPath(config.path, { dot: startDir })
     }
     return this
@@ -35,14 +34,13 @@ class GitCredentialManagerStore {
           'git',
           'credentials'
         )
-        contentsPromise = fsp
-          .access(homeGitCredentialsPath)
-          .then(() => fsp.readFile(homeGitCredentialsPath, 'utf8'))
-          .catch(() =>
+        contentsPromise = fsp.access(homeGitCredentialsPath).then(
+          () => fsp.readFile(homeGitCredentialsPath, 'utf8'),
+          () =>
             fsp
               .access(xdgConfigGitCredentialsPath)
               .then(() => fsp.readFile(xdgConfigGitCredentialsPath, 'utf8'), invariably.void)
-          )
+        )
       }
       contentsPromise.then((contents) => {
         if (contents) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/content-aggregator",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-rc.1",
   "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)",
@@ -16,12 +16,16 @@
     "url": "https://gitlab.com/antora/antora/issues"
   },
   "main": "lib/index.js",
+  "scripts": {
+    "test": "_mocha"
+  },
   "dependencies": {
     "@antora/expand-path-helper": "~2.0",
     "@antora/user-require-helper": "~2.0",
     "braces": "~3.0",
     "cache-directory": "~2.0",
     "camelcase-keys": "~7.0",
+    "glob-stream": "~7.0",
     "hpagent": "~0.1.0",
     "isomorphic-git": "~1.10",
     "js-yaml": "~4.1",
@@ -48,5 +52,5 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "45da95a2e2dea538379d2d9f42013d2208fb86c3"
+  "gitHead": "044371a33e2c0fed9724d30945bbb549d64845d5"
 }