@antora/site-publisher 3.0.0-alpha.6 → 3.0.0-beta.1

package/README.md

@@ -5,7 +5,7 @@ More than one destination may be specified, and this component supports differen
 Custom providers can be used to add support for additional destinations.
 
 [Antora](https://antora.org) is a modular static site generator designed for creating documentation sites from AsciiDoc documents.
-Its site generator pipeline aggregates documents from versioned content repositories and processes them using [Asciidoctor](https://asciidoctor.org).
+Its site generator aggregates documents from versioned content repositories and processes them using [Asciidoctor](https://asciidoctor.org).
 
 ## Copyright and License
 

package/lib/index.js

@@ -3,8 +3,8 @@
 /**
  * Site Publisher component for Antora
  *
- * Publishes the files generated in an Antora documentation pipeline to the
- * destination(s) specified in the playbook.
+ * Publishes the files generated by the Antora generator to the destination(s)
+ * specified in the playbook.
  *
  * @namespace site-publisher
  */

package/lib/providers/archive.js

@@ -9,7 +9,7 @@ const { DEFAULT_DEST_ARCHIVE } = require('../constants.js')
 // FIXME right now we're assuming the archive is a zip
 function publishToArchive (config, files, playbook) {
   const destFile = config.path || DEFAULT_DEST_ARCHIVE
-  const absDestFile = expandPath(destFile, '~+', playbook.dir || '.')
+  const absDestFile = expandPath(destFile, { dot: playbook.dir })
   const report = { provider: 'archive', path: destFile, resolvedPath: absDestFile }
   return publishStream(vzipDest(absDestFile), files).then(() => report)
 }

package/lib/providers/fs.js

@@ -11,7 +11,7 @@ const { DEFAULT_DEST_FS } = require('../constants.js')
 
 function publishToFs (config, files, playbook) {
   const destDir = config.path || DEFAULT_DEST_FS
-  const absDestDir = expandPath(destDir, '~+', playbook.dir || '.')
+  const absDestDir = expandPath(destDir, { dot: playbook.dir })
   const report = {
     provider: 'fs',
     path: destDir,
@@ -19,40 +19,10 @@ function publishToFs (config, files, playbook) {
     fileUri: 'file://' + (posixify ? '/' + posixify(absDestDir) : absDestDir),
   }
   return config.clean
-    ? rmdir(absDestDir)
+    ? fsp['rm' in fsp ? 'rm' : 'rmdir'](absDestDir, { recursive: true, force: true })
       .then(() => publishStream(vfsDest(absDestDir), files))
       .then(() => report)
     : publishStream(vfsDest(absDestDir), files).then(() => report)
 }
 
-/**
- * Removes the specified directory (including all of its contents) or file.
- * Equivalent to fs.promises.rmdir(dir, { recursive: true }) in Node 12.
- */
-function rmdir (dir) {
-  return fsp
-    .readdir(dir, { withFileTypes: true })
-    .then((lst) =>
-      Promise.all(
-        lst.map((it) =>
-          it.isDirectory()
-            ? rmdir(ospath.join(dir, it.name))
-            : fsp.unlink(ospath.join(dir, it.name)).catch((unlinkErr) => {
-              if (unlinkErr.code !== 'ENOENT') throw unlinkErr
-            })
-        )
-      )
-    )
-    .then(() => fsp.rmdir(dir))
-    .catch((err) => {
-      if (err.code === 'ENOENT') return
-      if (err.code === 'ENOTDIR') {
-        return fsp.unlink(dir).catch((unlinkErr) => {
-          if (unlinkErr.code !== 'ENOENT') throw unlinkErr
-        })
-      }
-      throw err
-    })
-}
-
 module.exports = publishToFs

package/lib/publish-site.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const ReadableOutputFileArray = require('./readable-output-file-array')
-const requireProvider = require('./require-provider')()
+const userRequire = require('@antora/user-require-helper')
 
 const { DEFAULT_DEST_FS } = require('./constants.js')
 
@@ -52,9 +52,12 @@ async function publishSite (playbook, catalogs) {
         return require('./providers/' + provider).bind(null, options)
       default:
         try {
-          return requireProvider(provider, playbook.dir || '.').bind(null, options)
-        } catch {
-          throw new Error('Unsupported destination provider: ' + provider)
+          const userRequireContext = { dot: playbook.dir, paths: [playbook.dir || '', __dirname] }
+          return userRequire(provider, userRequireContext).bind(null, options)
+        } catch (err) {
+          const prettyErr = new Error('Unsupported destination provider: ' + provider)
+          prettyErr.stack += `\nCaused by: ${err.stack || err}`
+          throw prettyErr
         }
     }
   })
@@ -73,7 +76,7 @@ function getDestinations (output) {
   let destinations = output.destinations
   if (output.dir) {
     if (destinations && destinations.length) {
-      destinations = destinations.slice(0)
+      destinations = destinations.slice()
       const primaryFsDestIdx = destinations.findIndex(({ provider: candidate }) => candidate === 'fs')
       if (~primaryFsDestIdx) {
         ;(destinations[primaryFsDestIdx] = Object.assign({}, destinations[primaryFsDestIdx])).path = output.dir

package/lib/readable-output-file-array.js

@@ -12,13 +12,17 @@ class File extends Vinyl {
 class ReadableOutputFileArray extends Readable {
   constructor (array) {
     super({ objectMode: true })
-    this.array = array.slice(0)
+    this.array = array.slice().reverse()
   }
 
   _read (size) {
-    const read = this.array.splice(0, size)
-    while (read.length) this.push(toOutputFile(read.shift()))
-    if (!this.array.length) this.push(null)
+    const array = this.array
+    while (size--) {
+      const next = array.pop()
+      if (next === undefined) break
+      this.push(toOutputFile(next))
+    }
+    if (size > -1) this.push(null)
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/site-publisher",
-  "version": "3.0.0-alpha.6",
+  "version": "3.0.0-beta.1",
   "description": "Publishes the files generated in an Antora documentation pipeline to the destination(s) specified in the playbook.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -15,13 +15,14 @@
   },
   "main": "lib/index.js",
   "dependencies": {
-    "@antora/expand-path-helper": "~1.0",
-    "gulp-vinyl-zip": "~2.2",
+    "@antora/expand-path-helper": "~2.0",
+    "@antora/user-require-helper": "~2.0",
+    "gulp-vinyl-zip": "~2.5",
     "vinyl": "~2.2",
     "vinyl-fs": "~3.0"
   },
   "engines": {
-    "node": ">=10.17.0"
+    "node": ">=12.21.0"
   },
   "files": [
     "lib/"
@@ -34,5 +35,5 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "38ec002e88eede3ce5c401a6e226d1a0356945c5"
+  "gitHead": "7c5ef1ea93dd489af533c80a936c736013c41769"
 }

package/lib/require-provider.js

@@ -1,51 +0,0 @@
-'use strict'
-
-const ospath = require('path')
-
-const DOT_RELATIVE_RX = new RegExp(`^\\.{1,2}[/${ospath.sep.replace('/', '').replace('\\', '\\\\')}]`)
-
-/**
- * Generates a function to resolve and require a custom provider.
- *
- * @memberof site-publisher
- *
- * @returns {Function} A function to require a provider.
- */
-function createRequireProvider () {
-  const requestCache = new Map()
-  /**
-   * Requires a provider, first resolving the path if necessary.
-   *
-   * If the request is an absolute path, that value is used as is. If the
-   * request begins with a dot (.), the value is resolved relative to the
-   * specified base directory. Otherwise, the request is resolved as the name
-   * of a node module, a search which includes the node_modules folder in the
-   * specified base directory. The resolved value is then passed to the require
-   * function and the result returned.
-   *
-   * @param {String} request - The path or module name to resolve.
-   * @param {String} requireBase - The absolute path from which to resolve a
-   *   relative path or module name.
-   *
-   * @returns {Object} The object returned by calling require on the resolved path.
-   */
-  return function requireProvider (request, requireBase) {
-    let resolved = requestCache.get(request)
-    if (!resolved) {
-      if (request.charAt() === '.' && DOT_RELATIVE_RX.test(request)) {
-        resolved = ospath.resolve(requireBase, request)
-      } else if (ospath.isAbsolute(request)) {
-        resolved = request
-      } else {
-        // NOTE appending node_modules prevents require from looking elsewhere before looking in these paths
-        const paths = [requireBase, ospath.dirname(__dirname)].map((start) => ospath.join(start, 'node_modules'))
-        resolved = require.resolve(request, { paths })
-      }
-      requestCache.set(request, resolved)
-    }
-
-    return require(resolved)
-  }
-}
-
-module.exports = createRequireProvider