@antora/playbook-builder 3.0.0-beta.2 → 3.0.0-beta.6

package/lib/build-playbook.js

@@ -25,42 +25,47 @@ const ospath = require('path')
  *   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, 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)
   }
-  const beforeValidateFromSchema = config._def[Symbol.for('convict.beforeValidate')]
-  if (beforeValidateFromSchema) beforeValidateFromSchema(config)
-  if (beforeValidate) beforeValidate(config)
-  return config.getModel()
+  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) {
@@ -103,4 +108,9 @@ function deepFreeze (o) {
   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

@@ -11,7 +11,7 @@ module.exports = {
     generator: {
       doc: 'A require request for the generator package name or script to use.',
       format: String,
-      default: '@antora/site-generator-default',
+      default: '@antora/site-generator',
       arg: 'generator',
     },
     extensions: {
@@ -259,7 +259,7 @@ module.exports = {
       },
       format: new Proxy(
         {
-          doc: 'Set the format of log messages. Defaults to json if CI=true, pretty otherwise.',
+          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',
@@ -268,7 +268,7 @@ module.exports = {
         {
           get (target, property) {
             if (property !== 'default') return target[property]
-            return process.env.CI === 'true' || process.env.NODE_ENV === 'test' ? 'json' : 'pretty'
+            return process.env.CI === 'true' || process.stdout.isTTY ? 'pretty' : 'json'
           },
         }
       ),

package/lib/solitary-convict.js

@@ -22,12 +22,12 @@ function registerParsers (convict) {
   convict.addParser([
     { extension: 'json', parse: json.parse },
     { extension: 'toml', parse: toml.parse },
-    { extension: 'yaml', parse: yaml.load },
-    { extension: 'yml', parse: yaml.load },
+    { extension: 'yaml', parse: (source) => yaml.load(source, { schema: yaml.CORE_SCHEMA }) },
+    { extension: 'yml', parse: (source) => yaml.load(source, { schema: yaml.CORE_SCHEMA }) },
     {
       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')
       },
     },
   ])
@@ -46,7 +46,7 @@ function registerFormats (convict) {
       ARGS_SCANNER_RX.lastIndex = 0
       while ((match = ARGS_SCANNER_RX.exec(val))) {
         const [, k, v] = match
-        if (k) accum[k] = v ? (v === '-' ? '-' : yaml.load(v)) : ''
+        if (k) accum[k] = v ? (v === '-' ? '-' : yaml.load(v, { schema: yaml.CORE_SCHEMA })) : ''
       }
       return accum
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/playbook-builder",
-  "version": "3.0.0-beta.2",
+  "version": "3.0.0-beta.6",
   "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)",
@@ -15,6 +15,9 @@
     "url": "https://gitlab.com/antora/antora/issues"
   },
   "main": "lib/index.js",
+  "scripts": {
+    "test": "_mocha"
+  },
   "dependencies": {
     "@iarna/toml": "~2.2",
     "camelcase-keys": "~7.0",
@@ -36,5 +39,5 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "5cd3f9cc70622e465cb44daf1aa2035ed5a35f54"
+  "gitHead": "f9f747965f599442562f59206d870b7e38864806"
 }