@antora/playbook-builder 3.2.0-alpha.1 → 3.2.0-alpha.2

package/README.md

@@ -10,4 +10,4 @@ Its site generator aggregates documents from versioned content repositories and
 
 Copyright (C) 2017-present [OpenDevise Inc.](https://opendevise.com) and the [Antora Project](https://antora.org).
 
-Use of this software is granted under the terms of the [Mozilla Public License Version 2.0](https://www.mozilla.org/en-US/MPL/2.0/) (MPL-2.0).
+Use of this software is granted under the terms of the [Mozilla Public License Version 2.0](https://www.mozilla.org/en-US/MPL/2.0/) (MPL-2.0).

package/lib/config/schema.js

@@ -66,7 +66,7 @@ module.exports = {
   content: {
     branches: {
       doc: 'The default branch pattern to use when no specific pattern is provided.',
-      format: Array,
+      format: 'array-or-string',
       default: ['HEAD', 'v{0..9}*'],
     },
     edit_url: {
@@ -82,7 +82,7 @@ module.exports = {
     },
     tags: {
       doc: 'The default tag pattern to use when no specific pattern is provided.',
-      format: Array,
+      format: 'array-or-string',
       default: undefined,
     },
   },
@@ -253,23 +253,13 @@ module.exports = {
         arg: 'log-failure-level',
         env: 'ANTORA_LOG_FAILURE_LEVEL',
       },
-      format: new Proxy(
-        {
-          doc: 'Set the format of log messages. Defaults to pretty if CI=true or stdout is a TTY, json otherwise.',
-          format: ['json', 'pretty'],
-          default: undefined,
-          arg: 'log-format',
-          env: 'ANTORA_LOG_FORMAT',
-        },
-        {
-          get (target, property) {
-            if (property !== 'default') return target[property]
-            return process.env.CI === 'true' || (process.env.IS_TTY || String(process.stdout.isTTY)) === 'true'
-              ? 'pretty'
-              : 'json'
-          },
-        }
-      ),
+      format: {
+        doc: 'Set the format of log messages. Defaults to pretty if CI=true or stdout is a TTY, json otherwise.',
+        format: ['json', 'pretty'],
+        default: 'auto',
+        arg: 'log-format',
+        env: 'ANTORA_LOG_FORMAT',
+      },
       destination: {
         file: {
           doc: 'Write log messages to this file or stream. Defaults to stderr if format is pretty, stdout otherwise.',
@@ -344,8 +334,13 @@ module.exports = {
       default: undefined,
     },
   },
-  [Symbol.for('convict.beforeValidate')]: ({ _schema: schema, _instance: data }) => {
+  [Symbol.for('convict.beforeValidate')]: ({ getEnv, _instance: data, _schema: schema }) => {
     const runtime = data.runtime
+    const log = runtime.log
+    if (log.format === 'auto') {
+      const env = getEnv()
+      log.format = env.CI === 'true' || (env.IS_TTY || String(process.stdout.isTTY)) === 'true' ? 'pretty' : 'json'
+    }
     if (runtime.silent) {
       if (runtime.quiet === false) runtime.quiet = true
       if (runtime.log.level !== 'silent') runtime.log.level = 'silent'

package/lib/solitary-convict.js

@@ -35,6 +35,14 @@ function registerParsers (convict) {
 }
 
 function registerFormats (convict) {
+  convict.addFormat({
+    name: 'array-or-string',
+    validate: (val) => {
+      if (!(val == null || val.constructor === String || Array.isArray(val))) {
+        throw new Error('must be an array, string, or null')
+      }
+    },
+  })
   convict.addFormat({
     name: 'map',
     validate: (val) => {
@@ -44,8 +52,8 @@ function registerFormats (convict) {
       if (config == null) return val
       const accum = config.has(name) ? config.get(name) : {}
       let match
-      ARGS_SCANNER_RX.lastIndex = 0
-      while ((match = ARGS_SCANNER_RX.exec(val))) {
+      const scanner = new RegExp(ARGS_SCANNER_RX)
+      while ((match = scanner.exec(val))) {
         const [, k, v] = match
         if (k) accum[k] = v ? (v === '-' ? '-' : yaml.load(v, { schema: yaml.CORE_SCHEMA })) : ''
       }
@@ -69,8 +77,8 @@ function registerFormats (convict) {
       if (config == null) return val
       const accum = config.has(name) ? config.get(name) : {}
       let match
-      ARGS_SCANNER_RX.lastIndex = 0
-      while ((match = ARGS_SCANNER_RX.exec(val))) {
+      const scanner = new RegExp(ARGS_SCANNER_RX)
+      while ((match = scanner.exec(val))) {
         const [, k, v] = match
         if (k) {
           let parsed
@@ -89,7 +97,7 @@ function registerFormats (convict) {
   convict.addFormat({
     name: 'require-array',
     validate: (val) => {
-      if (!Array.isArray(val)) throw new Error('must be of type Array')
+      if (!Array.isArray(val)) throw new Error('must be an array')
     },
     coerce: (val, config, name) => {
       const accum = config && config.has(name) ? config.get(name) : []
@@ -109,7 +117,7 @@ function registerFormats (convict) {
     name: 'boolean-or-string',
     validate: (val) => {
       if (!(val == null || val.constructor === String || val.constructor === Boolean)) {
-        throw new Error('must be a boolean or string')
+        throw new Error('must be a boolean, string, or null')
       }
     },
   })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/playbook-builder",
-  "version": "3.2.0-alpha.1",
+  "version": "3.2.0-alpha.2",
   "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)",