@antora/ui-loader 3.0.0-alpha.7 → 3.0.0-beta.2

package/README.md

@@ -4,7 +4,7 @@ The UI Loader is a component in Antora responsible for downloading and caching t
 The UI files are combined with the content files at the end of the Antora documentation pipeline to produce a complete site.
 
 [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/constants.js

@@ -1,7 +1,17 @@
 'use strict'
 
 module.exports = Object.freeze({
-  SUPPLEMENTAL_FILES_GLOB: '**/*',
   UI_CACHE_FOLDER: 'ui',
   UI_DESC_FILENAME: 'ui.yml',
+  UI_SRC_GLOB: '**/*[!~]',
+  UI_SRC_OPTS: {
+    dot: true,
+    follow: true,
+    ignore: ['.git/**'],
+    nomount: true,
+    nosort: true,
+    nounique: true,
+    removeBOM: false,
+    uniqueBy: (m) => m,
+  },
 })

package/lib/file.js

@@ -18,6 +18,10 @@ class File extends Vinyl {
   get relative () {
     return this.history[this.history.length - 1]
   }
+
+  isDot () {
+    return ('/' + this.history[this.history.length - 1]).indexOf('/.') > -1
+  }
 }
 
 class MemoryFile extends File {

package/lib/load-ui.js

@@ -19,7 +19,7 @@ const yaml = require('js-yaml')
 const vfs = require('vinyl-fs')
 const vzip = require('gulp-vinyl-zip')
 
-const { UI_CACHE_FOLDER, UI_DESC_FILENAME, SUPPLEMENTAL_FILES_GLOB } = require('./constants')
+const { UI_CACHE_FOLDER, UI_DESC_FILENAME, UI_SRC_GLOB, UI_SRC_OPTS } = require('./constants')
 const URI_SCHEME_RX = /^https?:\/\//
 const EXT_RX = /\.[a-z]{2,3}$/
 
@@ -48,7 +48,7 @@ const EXT_RX = /\.[a-z]{2,3}$/
  * @param {String} [playbook.network.noProxy=undefined] - The list of domains and IPs that should not be proxied.
  * @param {Object} playbook.ui - The UI configuration object for Antora.
  * @param {String} playbook.ui.bundle - The UI bundle configuration.
- * @param {String} playbook.ui.bundle.url - The path (relative or absolute) or URI
+ * @param {String} playbook.ui.bundle.url - The path (relative or absolute) or URL
  * of the UI bundle to use.
  * @param {String} [playbook.ui.bundle.startPath=''] - The path inside the bundle from
  * which to start reading files.
@@ -73,29 +73,29 @@ async function loadUi (playbook) {
       const cachePath = ospath.join(absCacheDir, `${sha1(bundleUrl)}.zip`)
       return fetch && bundle.snapshot
         ? downloadBundle(bundleUrl, cachePath, createAgent(bundleUrl, playbook.network || {}))
-        : fsp
-          .stat(cachePath)
-          .then((stat) => new File({ path: cachePath, stat }))
-          .catch(() => downloadBundle(bundleUrl, cachePath, createAgent(bundleUrl, playbook.network || {})))
+        : fsp.stat(cachePath).then(
+          (stat) => new File({ path: cachePath, stat }),
+          () => downloadBundle(bundleUrl, cachePath, createAgent(bundleUrl, playbook.network || {}))
+        )
     })
   } else {
-    const localPath = expandPath(bundleUrl, '~+', startDir)
-    resolveBundle = fsp
-      .stat(localPath)
-      .then((stat) => new File({ path: localPath, stat }))
-      .catch(() => {
+    const localPath = expandPath(bundleUrl, { dot: startDir })
+    resolveBundle = fsp.stat(localPath).then(
+      (stat) => new File({ path: localPath, stat }),
+      () => {
         throw new Error(
           `Specified UI ${path.extname(localPath) ? 'bundle' : 'directory'} does not exist: ` +
             (bundleUrl === localPath ? bundleUrl : `${localPath} (resolved from url: ${bundleUrl})`)
         )
-      })
+      }
+    )
   }
   const files = await Promise.all([
     resolveBundle.then((bundleFile) =>
       new Promise((resolve, reject) =>
         bundleFile.isDirectory()
           ? vfs
-            .src('**/*', { cwd: bundleFile.path, removeBOM: false })
+            .src(UI_SRC_GLOB, Object.assign({ cwd: bundleFile.path }, UI_SRC_OPTS))
             .on('error', reject)
             .pipe(relativizeFiles())
             .pipe(collectFiles(resolve))
@@ -147,28 +147,24 @@ function ensureCacheDir (customCacheDir, startDir) {
   const baseCacheDir =
     customCacheDir == null
       ? getCacheDir('antora' + (process.env.NODE_ENV === 'test' ? '-test' : '')) || ospath.resolve('.antora/cache')
-      : expandPath(customCacheDir, '~+', startDir)
+      : expandPath(customCacheDir, { dot: startDir })
   const cacheDir = ospath.join(baseCacheDir, UI_CACHE_FOLDER)
-  return fsp
-    .mkdir(cacheDir, { recursive: true })
-    .then(() => cacheDir)
-    .catch((err) => {
+  return fsp.mkdir(cacheDir, { recursive: true }).then(
+    () => cacheDir,
+    (err) => {
       throw Object.assign(err, { message: `Failed to create UI cache directory: ${cacheDir}; ${err.message}` })
-    })
+    }
+  )
 }
 
 function createAgent (url, { httpProxy, httpsProxy, noProxy }) {
-  if (httpsProxy || httpProxy) {
+  if ((httpsProxy || httpProxy) && noProxy !== '*') {
     const { HttpProxyAgent, HttpsProxyAgent } = require('hpagent')
+    const shouldProxy = require('should-proxy')
     const proxy = url.startsWith('https:')
-      ? { ProxyAgent: HttpsProxyAgent, url: httpsProxy }
-      : { ProxyAgent: HttpProxyAgent, url: httpProxy }
-    if (proxy.url && require('should-proxy')(url, { no_proxy: noProxy })) {
-      // see https://github.com/delvedor/hpagent/issues/18
-      const { protocol, hostname, port, username, password } = new URL(proxy.url)
-      const proxyUrl = { protocol, hostname, port, username: username || null, password: password || null }
-      return new proxy.ProxyAgent({ proxy: proxyUrl })
-    }
+      ? { Agent: HttpsProxyAgent, url: httpsProxy }
+      : { Agent: HttpProxyAgent, url: httpProxy }
+    if (proxy.url && shouldProxy(url, { no_proxy: noProxy })) return new proxy.Agent({ proxy: proxy.url })
   }
 }
 
@@ -235,11 +231,10 @@ function bufferizeContents () {
     if (file.isStream()) {
       concat(file.contents, (err, contents) => {
         if (err) return next(err)
-        file.stat.size = (file.contents = contents).length
+        file.contents = contents
         next(null, file)
       })
     } else {
-      file.stat.size = file.contents.length
       next(null, file)
     }
   })
@@ -268,7 +263,7 @@ function srcSupplementalFiles (filesSpec, startDir) {
           if (~contents_.indexOf('\n') || !EXT_RX.test(contents_)) {
             accum.push(new MemoryFile({ path: path_, contents: Buffer.from(contents_) }))
           } else {
-            contents_ = expandPath(contents_, '~+', startDir)
+            contents_ = expandPath(contents_, { dot: startDir })
             accum.push(
               fsp
                 .stat(contents_)
@@ -282,14 +277,14 @@ function srcSupplementalFiles (filesSpec, startDir) {
       }, [])
     ).then((files) => files.reduce((accum, file) => accum.set(file.path, file) && accum, new Map()))
   } else {
-    const cwd = expandPath(filesSpec, '~+', startDir)
+    const cwd = expandPath(filesSpec, { dot: startDir })
     return fsp
       .access(cwd)
       .then(
         () =>
           new Promise((resolve, reject) =>
             vfs
-              .src(SUPPLEMENTAL_FILES_GLOB, { cwd, dot: true, removeBOM: false })
+              .src(UI_SRC_GLOB, Object.assign({ cwd, dot: true }, UI_SRC_OPTS))
               .on('error', reject)
               .pipe(relativizeFiles())
               .pipe(collectFiles(resolve))
@@ -342,11 +337,10 @@ function classifyFile (file, config) {
   if (config.staticFiles && isStaticFile(file, config.staticFiles)) {
     file.type = 'static'
     file.out = resolveOut(file, '')
-  } else if (file.local && ~('/' + file.relative).indexOf('/.')) {
+  } else if (file.isDot()) {
     file = undefined
-  } else {
-    file.type = resolveType(file)
-    if (file.type === 'asset') file.out = resolveOut(file, config.outputDir)
+  } else if ((file.type = resolveType(file)) === 'asset') {
+    file.out = resolveOut(file, config.outputDir)
   }
   return file
 }
@@ -357,15 +351,10 @@ function isStaticFile (file, staticFiles) {
 
 function resolveType (file) {
   const firstPathSegment = file.path.split('/', 1)[0]
-  if (firstPathSegment === 'layouts') {
-    return 'layout'
-  } else if (firstPathSegment === 'helpers') {
-    return 'helper'
-  } else if (firstPathSegment === 'partials') {
-    return 'partial'
-  } else {
-    return 'asset'
-  }
+  if (firstPathSegment === 'layouts') return 'layout'
+  if (firstPathSegment === 'helpers') return 'helper'
+  if (firstPathSegment === 'partials') return 'partial'
+  return 'asset'
 }
 
 function resolveOut (file, outputDir = '_') {

package/lib/ui-catalog.js

@@ -8,23 +8,27 @@ class UiCatalog {
   }
 
   getFiles () {
-    return [...this[$files].values()]
+    const accum = []
+    for (const filesForType of this[$files].values()) {
+      for (const file of filesForType.values()) accum.push(file)
+    }
+    return accum
   }
 
   addFile (file) {
-    const key = generateKey(file)
-    if (this[$files].has(key)) {
+    let filesForType = this[$files].get(file.type)
+    if (!filesForType) this[$files].set(file.type, (filesForType = new Map()))
+    const key = file.path
+    if (filesForType.has(key)) {
       throw new Error('Duplicate file')
     }
-    this[$files].set(key, file)
+    filesForType.set(key, file)
+    return file
   }
 
   findByType (type) {
-    const accum = []
-    for (const candidate of this[$files].values()) {
-      if (candidate.type === type) accum.push(candidate)
-    }
-    return accum
+    const filesForType = this[$files].get(type)
+    return filesForType ? [...filesForType.values()] : []
   }
 }
 
@@ -33,8 +37,4 @@ class UiCatalog {
  */
 UiCatalog.prototype.getAll = UiCatalog.prototype.getFiles
 
-function generateKey ({ type, path }) {
-  return type + '$' + path
-}
-
 module.exports = UiCatalog

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/ui-loader",
-  "version": "3.0.0-alpha.7",
+  "version": "3.0.0-beta.2",
   "description": "Downloads a UI bundle, if necessary, and loads the files into a UI catalog for use in an Antora documentation pipeline.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -17,10 +17,10 @@
   },
   "main": "lib/index.js",
   "dependencies": {
-    "@antora/expand-path-helper": "~1.0",
+    "@antora/expand-path-helper": "~2.0",
     "cache-directory": "~2.0",
-    "camelcase-keys": "~6.2",
-    "gulp-vinyl-zip": "~2.2",
+    "camelcase-keys": "~7.0",
+    "gulp-vinyl-zip": "~2.5",
     "hpagent": "~0.1.0",
     "js-yaml": "~4.1",
     "minimatch-all": "~1.1",
@@ -31,7 +31,7 @@
     "vinyl-fs": "~3.0"
   },
   "engines": {
-    "node": ">=10.17.0"
+    "node": ">=12.21.0"
   },
   "files": [
     "lib/"
@@ -45,5 +45,5 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "fbd597b3680474f2083cda8a7facf1e2848c08e0"
+  "gitHead": "5cd3f9cc70622e465cb44daf1aa2035ed5a35f54"
 }