@antora/playbook-builder 3.0.0-alpha.8 → 3.0.0-beta.3

package/README.md

@@ -4,7 +4,7 @@ The Playbook Builder is the configuration component for Antora.
 It's responsible for building a playbook object from user input that's then used for configuring components in an Antora generator pipeline.
 
 [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/build-playbook.js

@@ -1,8 +1,8 @@
 'use strict'
 
 const camelCaseKeys = require('camelcase-keys')
-const { configureLogger } = require('@antora/logger')
 const convict = require('./solitary-convict')
+const defaultSchema = require('./config/schema')
 const fs = require('fs')
 const ospath = require('path')
 
@@ -21,92 +21,96 @@ const ospath = require('path')
  *   option flags and switches. Should begin with the first flag or switch.
  * @param {Object} [env={}] - A map of environment variables.
  * @param {Object} [schema=undefined] - A convict configuration schema.
+ * @param {Function} [beforeValidate=undefined] - A function to invoke on the
+ *   config before validating it.
  *
  * @returns {Object} A playbook object containing a hierarchical structure that
- *   mirrors the configuration schema. With the exception of the top-level asciidoc
- *   key and its descendants, all keys in the playbook are camelCased.
+ *   mirrors the configuration schema. With the exception of keys and descendants
+ *   marked in the schema as preserve, all keys in the playbook are camelCased.
  */
-function buildPlaybook (args = [], env = {}, schema = undefined) {
+function buildPlaybook (args = [], env = {}, schema = undefined, beforeValidate = undefined) {
   const config = loadConvictConfig(args, env, schema)
-  const relSpecFilePath = config.get('playbook')
-  if (relSpecFilePath) {
-    let absSpecFilePath = ospath.resolve(relSpecFilePath)
-    if (ospath.extname(absSpecFilePath)) {
-      if (!fs.existsSync(absSpecFilePath)) {
-        let details = ''
-        if (relSpecFilePath !== absSpecFilePath) {
-          details = ` (path: ${relSpecFilePath}${ospath.isAbsolute(relSpecFilePath) ? '' : ', cwd: ' + process.cwd()})`
-        }
-        throw new Error(`playbook file not found at ${absSpecFilePath}${details}`)
+  const playbook = config.get('playbook')
+  let absPlaybookPath
+  if (playbook) {
+    if (ospath.extname((absPlaybookPath = ospath.resolve(playbook)))) {
+      if (!fs.existsSync(absPlaybookPath)) {
+        throw new Error(`playbook file not found at ${absPlaybookPath}${getDetails(playbook, absPlaybookPath)}`)
       }
-    } else if (fs.existsSync(absSpecFilePath + '.yml')) {
-      absSpecFilePath += '.yml'
-    } else if (fs.existsSync(absSpecFilePath + '.json')) {
-      absSpecFilePath += '.json'
-    } else if (fs.existsSync(absSpecFilePath + '.toml')) {
-      absSpecFilePath += '.toml'
+    } else if (fs.existsSync(absPlaybookPath + '.yml')) {
+      absPlaybookPath += '.yml'
+    } else if (fs.existsSync(absPlaybookPath + '.json')) {
+      absPlaybookPath += '.json'
+    } else if (fs.existsSync(absPlaybookPath + '.toml')) {
+      absPlaybookPath += '.toml'
     } else {
-      const details = `(path: ${relSpecFilePath}${ospath.isAbsolute(relSpecFilePath) ? '' : ', cwd: ' + process.cwd()})`
       throw new Error(
-        `playbook file not found at ${absSpecFilePath}.yml, ${absSpecFilePath}.json, or ${absSpecFilePath}.toml ` +
-          details
+        `playbook file not found at ${absPlaybookPath}.yml, ${absPlaybookPath}.json, or ${absPlaybookPath}.toml` +
+          getDetails(playbook, absPlaybookPath)
       )
     }
-    config.loadFile(absSpecFilePath)
-    if (relSpecFilePath !== absSpecFilePath) config.set('playbook', absSpecFilePath)
   }
-  config.validate({ allowed: 'strict' })
-  return exportModel(config)
+  try {
+    if (playbook) {
+      config.loadFile(absPlaybookPath)
+      if (playbook !== absPlaybookPath) config.set('playbook', absPlaybookPath)
+    }
+    const beforeValidateFromSchema = config._def[Symbol.for('convict.beforeValidate')]
+    if (beforeValidateFromSchema) beforeValidateFromSchema(config)
+    if (beforeValidate) beforeValidate(config)
+    return config.getModel()
+  } catch (err) {
+    if (!playbook) throw err
+    const message = err.message.replace(/( in the schema)?$/m, (_, inTheSchema) => {
+      return `${inTheSchema ? inTheSchema + ' for' : ' in'} ${absPlaybookPath}${getDetails(playbook, absPlaybookPath)}`
+    })
+    throw Object.assign(err, { message })
+  }
 }
 
 function loadConvictConfig (args, env, customSchema) {
-  return convict(customSchema || require('./config/schema'), { args, env })
+  return Object.assign(convict(customSchema || defaultSchema, { args, env }), { getModel })
 }
 
-function deepFreeze (o) {
-  for (const v of Object.values(o)) Object.isFrozen(v) || deepFreeze(v)
-  return Object.freeze(o)
-}
-
-function exportModel (config) {
-  const schemaProperties = config._schema._cvtProperties
-  const data = config.getProperties()
-  if (
-    'site' in schemaProperties &&
-    'keys' in schemaProperties.site._cvtProperties &&
-    '__private__google_analytics_key' in schemaProperties.site._cvtProperties
-  ) {
-    const site = data.site
-    if (site.__private__google_analytics_key != null) site.keys.google_analytics = site.__private__google_analytics_key
-    delete site.__private__google_analytics_key
+function getModel (name = '') {
+  let config = this
+  const data = config.get(name)
+  let schema = config._schema
+  if (name) {
+    schema = name.split('.').reduce((accum, key) => accum._cvtProperties[key], schema)
+    config = Object.assign(convict(name.split('.').reduce((def, key) => def[key], config._def)), { _instance: data })
   }
-  const playbook = camelCaseKeys(data, { deep: true, stopPaths: getStopPaths(schemaProperties) })
-  playbook.dir = playbook.playbook ? ospath.dirname((playbook.file = playbook.playbook)) : process.cwd()
-  Object.defineProperty(playbook, 'env', { value: config.getEnv() })
-  const runtime = (playbook.runtime || false).constructor === Object && playbook.runtime
-  if (runtime) {
-    const log = (runtime.log || false).constructor === Object && runtime.log
-    if (runtime.silent) {
-      if (runtime.quiet === false) runtime.quiet = true
-      if (log && 'level' in log) log.level = 'silent'
-    }
-    if (log) configureLogger(log, playbook.dir)
+  config.validate({ allowed: 'strict' })
+  const model = camelCaseKeys(data, { deep: true, stopPaths: getStopPaths(schema._cvtProperties) })
+  if (!name) {
+    Object.defineProperty(model, 'env', { value: config.getEnv() })
+    model.dir = model.playbook ? ospath.dirname((model.file = model.playbook)) : process.cwd()
+    delete model.playbook
   }
-  delete playbook.playbook
-  return deepFreeze(playbook)
+  return deepFreeze(model)
 }
 
-function getStopPaths (schemaProperties, schemaPath = []) {
-  const stopPaths = []
+function getStopPaths (schemaProperties, schemaPath = [], stopPaths = []) {
   for (const [key, { preserve, _cvtProperties }] of Object.entries(schemaProperties)) {
     if (preserve) {
-      return Array.isArray(preserve)
-        ? preserve.reduce((accum, it) => accum.concat(schemaPath.concat(key, it).join('.')), stopPaths)
-        : stopPaths.concat(schemaPath.concat(key).join('.'))
+      Array.isArray(preserve)
+        ? preserve.forEach((it) => stopPaths.push(schemaPath.concat(key, it).join('.')))
+        : stopPaths.push(schemaPath.concat(key).join('.'))
+    } else if (_cvtProperties) {
+      stopPaths.push(...getStopPaths(_cvtProperties, schemaPath.concat(key)))
     }
-    if (_cvtProperties) stopPaths.push(...getStopPaths(_cvtProperties, schemaPath.concat(key)))
   }
   return stopPaths
 }
 
-module.exports = buildPlaybook
+function deepFreeze (o) {
+  for (const v of Object.values(o)) Object.isFrozen(v) || deepFreeze(v)
+  return Object.freeze(o)
+}
+
+function getDetails (playbook, absPlaybookPath) {
+  if (playbook === absPlaybookPath) return ''
+  return ` (${ospath.isAbsolute(playbook) ? '' : 'cwd: ' + process.cwd() + ', '}playbook: ${playbook})`
+}
+
+module.exports = Object.assign(buildPlaybook, { defaultSchema })

package/lib/config/schema.js

@@ -7,10 +7,16 @@ module.exports = {
     default: undefined,
     arg: 'playbook',
   },
-  pipeline: {
+  antora: {
+    generator: {
+      doc: 'A require request for the generator package name or script to use.',
+      format: String,
+      default: '@antora/site-generator-default',
+      arg: 'generator',
+    },
     extensions: {
       doc:
-        'A list of extensions that listen for pipeline events. ' +
+        'A list of extensions that listen for lifecycle events. ' +
         'Each extension is specified as a require request string or an object with a require key.',
       format: 'require-array',
       default: [],
@@ -65,7 +71,7 @@ module.exports = {
     branches: {
       doc: 'The default branch pattern to use when no specific pattern is provided.',
       format: Array,
-      default: ['HEAD', 'v*'],
+      default: ['HEAD', 'v{0..9}*'],
     },
     edit_url: {
       doc: 'The default edit URL setting when no specific setting is provided.',
@@ -76,6 +82,7 @@ module.exports = {
       doc: 'The list of git repository urls, references, and start paths to use as content sources.',
       format: Array,
       default: [],
+      preserve: ['version'],
     },
     tags: {
       doc: 'The default tag pattern to use when no specific pattern is provided.',
@@ -161,6 +168,11 @@ module.exports = {
       format: Boolean,
       default: true,
     },
+    fetch_concurrency: {
+      doc: 'The maximum number of fetch or clone operations that are permitted to run at once. Use 0 for unlimited.',
+      format: 'int',
+      default: 0,
+    },
     plugins: {
       credential_manager: {
         doc: 'A require request for a plugin to replace the built-in credential manager used by the git client.',
@@ -275,7 +287,7 @@ module.exports = {
         },
         buffer_size: {
           doc: 'The size of the log buffer that must be exceeded before writing a chunk to the destination.',
-          format: Number,
+          format: 'int',
           default: 0,
         },
         sync: {
@@ -310,7 +322,7 @@ module.exports = {
     },
     redirect_facility: {
       doc: 'The facility for handling page alias and start page redirections.',
-      format: ['disabled', 'httpd', 'netlify', 'nginx', 'static'],
+      format: ['disabled', 'gitlab', 'httpd', 'netlify', 'nginx', 'static'],
       default: 'static',
       arg: 'redirect-facility',
     },
@@ -334,4 +346,15 @@ module.exports = {
       default: undefined,
     },
   },
+  [Symbol.for('convict.beforeValidate')]: ({ _schema: schema, _instance: data }) => {
+    const runtime = data.runtime
+    if (runtime.silent) {
+      if (runtime.quiet === false) runtime.quiet = true
+      if (runtime.log.level !== 'silent') runtime.log.level = 'silent'
+    }
+    const site = data.site
+    if (site.__private__google_analytics_key != null) site.keys.google_analytics = site.__private__google_analytics_key
+    delete site.__private__google_analytics_key
+    delete schema._cvtProperties.site._cvtProperties.__private__google_analytics_key
+  },
 }

package/lib/solitary-convict.js

@@ -27,7 +27,7 @@ function registerParsers (convict) {
     {
       extension: '*',
       parse: () => {
-        throw new Error('Unexpected playbook file type (must be yml, json, or toml')
+        throw new Error('Unknown playbook file extension: must be .yml (or .yaml), .json, or .toml')
       },
     },
   ])

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/playbook-builder",
-  "version": "3.0.0-alpha.8",
+  "version": "3.0.0-beta.3",
   "description": "Builds a playbook object from user input for configuring successive documentation components in an Antora pipeline.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -16,15 +16,14 @@
   },
   "main": "lib/index.js",
   "dependencies": {
-    "@antora/logger": "3.0.0-alpha.8",
     "@iarna/toml": "~2.2",
-    "camelcase-keys": "~6.2",
-    "convict": "~6.1",
+    "camelcase-keys": "~7.0",
+    "convict": "~6.2",
     "js-yaml": "~4.1",
     "json5": "~2.2"
   },
   "engines": {
-    "node": ">=10.17.0"
+    "node": ">=12.21.0"
   },
   "files": [
     "lib/"
@@ -37,5 +36,5 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "2e5695bea11fb5719989c329c97e66d36e29659f"
+  "gitHead": "45da95a2e2dea538379d2d9f42013d2208fb86c3"
 }