@antora/playbook-builder 3.0.0-beta.6 → 3.0.0-rc.4

package/lib/build-playbook.js

@@ -19,8 +19,8 @@ const ospath = require('path')
  *
  * @param {Array} [args=[]] - An array of arguments in the form of command line
  *   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 {Object} [env=process.env] - A map of environment variables.
+ * @param {Object} [schema=require('./config/schema').defaultSchema] - A convict configuration schema.
  * @param {Function} [beforeValidate=undefined] - A function to invoke on the
  *   config before validating it.
  *
@@ -28,9 +28,9 @@ const ospath = require('path')
  *   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, beforeValidate = undefined) {
-  const config = loadConvictConfig(args, env, schema)
-  const playbook = config.get('playbook')
+function buildPlaybook (args = [], env = process.env, schema = defaultSchema, beforeValidate = undefined) {
+  const config = Object.assign(convict(schema, { args, env }), { getModel })
+  const playbook = config.has('playbook') && config.get('playbook')
   let absPlaybookPath
   if (playbook) {
     if (ospath.extname((absPlaybookPath = ospath.resolve(playbook)))) {
@@ -68,10 +68,6 @@ function buildPlaybook (args = [], env = {}, schema = undefined, beforeValidate
   }
 }
 
-function loadConvictConfig (args, env, customSchema) {
-  return Object.assign(convict(customSchema || defaultSchema, { args, env }), { getModel })
-}
-
 function getModel (name = '') {
   let config = this
   const data = config.get(name)

package/lib/config/schema.js

@@ -55,15 +55,11 @@ module.exports = {
       default: {},
       arg: 'key',
     },
-    // NOTE used to map arg and env for site.keys.google_analytics key
+    // NOTE used to map env var for site.keys.google_analytics key
     __private__google_analytics_key: {
-      doc: [
-        'The Google Analytics account key.',
-        '(Deprecated; will be removed in Antora 4; define using --key google-analytics=<key> instead)',
-      ].join('\n'),
+      doc: 'The environment variable mapping for the Google Analytics account key.',
       format: String,
       default: undefined,
-      arg: 'google-analytics-key',
       env: 'GOOGLE_ANALYTICS_KEY',
     },
   },

package/lib/solitary-convict.js

@@ -7,6 +7,7 @@ const yaml = require('js-yaml')
 
 const ARGS_SCANNER_RX = /(?:([^=,]+)|(?==))(?:,|$|=(|("|').*?\3|[^,]+)(?:,|$))/g
 const PRIMITIVE_TYPES = [Boolean, Number, String]
+const YAML_SCHEMA = yaml.CORE_SCHEMA.extend({ implicit: [yaml.types.merge] })
 
 /**
  * A convict function wrapper that registers custom formats and parsers and
@@ -22,8 +23,8 @@ function registerParsers (convict) {
   convict.addParser([
     { extension: 'json', parse: json.parse },
     { extension: 'toml', parse: toml.parse },
-    { extension: 'yaml', parse: (source) => yaml.load(source, { schema: yaml.CORE_SCHEMA }) },
-    { extension: 'yml', parse: (source) => yaml.load(source, { schema: yaml.CORE_SCHEMA }) },
+    { extension: 'yaml', parse: (source) => yaml.load(source, { schema: YAML_SCHEMA }) },
+    { extension: 'yml', parse: (source) => yaml.load(source, { schema: YAML_SCHEMA }) },
     {
       extension: '*',
       parse: () => {
@@ -74,7 +75,7 @@ function registerFormats (convict) {
         if (k) {
           let parsed
           if (v && v !== '-') {
-            parsed = yaml.load(v)
+            parsed = yaml.load(v, { schema: yaml.CORE_SCHEMA })
             if (parsed && PRIMITIVE_TYPES.indexOf(parsed.constructor) < 0) parsed = v
           } else {
             parsed = v || ''

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/playbook-builder",
-  "version": "3.0.0-beta.6",
+  "version": "3.0.0-rc.4",
   "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)",
@@ -39,5 +39,5 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "f9f747965f599442562f59206d870b7e38864806"
+  "gitHead": "5e29b434cf6e83e0e8e02c0793425bdf4d25bed2"
 }