@antora/playbook-builder 3.2.0-alpha.9 → 3.2.0-rc.1

package/lib/build-playbook.js

@@ -4,7 +4,6 @@ const convict = require('./solitary-convict')
 const defaultSchema = require('./config/schema')
 const fs = require('node:fs')
 const ospath = require('node:path')
-const parseArgs = require('yargs-parser')
 const yaml = require('js-yaml')
 
 /**
@@ -30,7 +29,7 @@ const yaml = require('js-yaml')
  *   marked in the schema as preserve, all keys in the playbook are camelCased.
  */
 function buildPlaybook (args = [], env = process.env, schema = defaultSchema, beforeValidate = undefined) {
-  const parsedArgs = parseArgs(args, { configuration: { 'dot-notation': false } })
+  const parsedArgs = args.length ? parseArgs(args) : {}
   const opts = { args: [], env: {} }
   const config = Object.assign(convict(schema, opts), { getModel, getSchema })
   Object.assign(opts, { args, env })
@@ -151,4 +150,28 @@ function getDetails (playbook, absPlaybookPath) {
   return ` (${ospath.isAbsolute(playbook) ? '' : 'cwd: ' + process.cwd() + ', '}playbook: ${playbook})`
 }
 
+function parseArgs (args) {
+  let currentOptionName
+  return Object.assign(
+    args.reduce((accum, it) => {
+      if (it.startsWith('--') && it !== '--') {
+        if (currentOptionName) accum[currentOptionName] = true
+        currentOptionName = it.substring(2)
+      } else if (currentOptionName) {
+        const currentOptionValue = accum[currentOptionName]
+        if (currentOptionValue == null || currentOptionValue === true) {
+          accum[currentOptionName] = it
+        } else if (currentOptionValue.constructor === Array) {
+          currentOptionValue.push(it)
+        } else {
+          accum[currentOptionName] = [currentOptionValue, it]
+        }
+        currentOptionName = undefined
+      }
+      return accum
+    }, {}),
+    currentOptionName ? { [currentOptionName]: true } : undefined
+  )
+}
+
 module.exports = Object.assign(buildPlaybook, { defaultSchema })

package/lib/config/schema.js

@@ -86,6 +86,11 @@ module.exports = {
       format: 'array-or-string',
       default: undefined,
     },
+    worktrees: {
+      doc: 'The default worktrees pattern to use when no specific pattern is provided.',
+      format: 'boolean-or-array-or-string',
+      default: '.',
+    },
   },
   ui: {
     bundle: {
@@ -245,7 +250,7 @@ module.exports = {
     log: {
       level: {
         doc: 'Set the minimum log level of messages that get logged.',
-        format: ['all', 'debug', 'info', 'warn', 'error', 'fatal', 'silent'],
+        format: ['all', 'trace', 'debug', 'info', 'warn', 'error', 'fatal', 'silent'],
         default: 'warn',
         arg: 'log-level',
         env: 'ANTORA_LOG_LEVEL',

package/lib/solitary-convict.js

@@ -44,6 +44,14 @@ function registerFormats (convict) {
       }
     },
   })
+  convict.addFormat({
+    name: 'boolean-or-array-or-string',
+    validate: (val) => {
+      if (!(val == null || typeof val === 'boolean' || val.constructor === String || Array.isArray(val))) {
+        throw new Error('must be a boolean, array, string, or null')
+      }
+    },
+  })
   convict.addFormat({
     name: 'map',
     validate: (val) => {
@@ -58,15 +66,15 @@ function registerFormats (convict) {
         let v = ''
         const equalsIdx = entry.indexOf('=')
         if (~equalsIdx) {
-          if (!(k = entry.slice(0, equalsIdx))) continue
-          v = entry.slice(equalsIdx + 1)
+          if (!(k = entry.substring(0, equalsIdx))) continue
+          v = entry.substring(equalsIdx + 1)
         }
         let parsed = v
         if (v) {
           const match = v.match(YAML_PREFIX_RX)
           if (match) {
             try {
-              parsed = yaml.load(match[1] === 'auto' ? v.slice(7) : v, { schema: yaml.CORE_SCHEMA })
+              parsed = yaml.load(match[1] === 'auto' ? v.substring(7) : v, { schema: yaml.CORE_SCHEMA })
             } catch {}
           }
         }
@@ -97,15 +105,15 @@ function registerFormats (convict) {
         let v = ''
         const equalsIdx = entry.indexOf('=')
         if (~equalsIdx) {
-          if (!(k = entry.slice(0, equalsIdx))) continue
-          v = entry.slice(equalsIdx + 1)
+          if (!(k = entry.substring(0, equalsIdx))) continue
+          v = entry.substring(equalsIdx + 1)
         }
         let parsed = v
         if (v) {
           const match = v.match(YAML_PREFIX_RX)
           if (match) {
             try {
-              parsed = yaml.load(match[1] === 'auto' ? v.slice(7) : v, { schema: yaml.CORE_SCHEMA })
+              parsed = yaml.load(match[1] === 'auto' ? v.substring(7) : v, { schema: yaml.CORE_SCHEMA })
               if (parsed && !~PRIMITIVE_TYPES.indexOf(parsed.constructor)) parsed = v
             } catch {}
           }
@@ -122,16 +130,30 @@ function registerFormats (convict) {
     },
     coerce: (val, config, name) => {
       const accum = config?.has(name) ? config.get(name) : []
-      for (const v of val.split(',')) {
-        if (~accum.indexOf(v)) continue
-        const match = accum.find((it) => it.constructor === Object && it.id === v)
-        if (match) {
-          if (match.enabled === false) match.enabled = true
+      const byId = {}
+      const byRequire = {}
+      let orderIdx = 0
+      const order = new Map()
+      for (const [idx, it] of accum.entries()) {
+        const ext = it.constructor === Object ? it : (accum[idx] = { require: it })
+        byRequire[ext.require] ??= ext
+        if ('id' in ext) byId[ext.id] ??= ext
+        order.set(it, orderIdx++)
+      }
+      for (let request of val.split(',')) {
+        const enable = request.charAt() === '!' ? (request = request.substring(1)) == null : true
+        let match
+        if ((match = byId[request] ?? byRequire[request])) {
+          if ((match.enabled ?? true) !== enable) match.enabled = enable
         } else {
-          accum.push(v)
+          accum.push((match = byRequire[request] = { require: request }))
+          if (!enable) match.enabled = false
         }
+        if ((match.order ?? 'auto') === 'auto') order.set(match, orderIdx++)
       }
       return accum
+        .sort((a, b) => order.get(a) - order.get(b))
+        .map((it) => (Object.keys(it).length === 1 && 'require' in it ? it.require : it))
     },
   })
   convict.addFormat({
@@ -182,7 +204,7 @@ function registerFormats (convict) {
     },
     coerce: (val) => {
       if (!val || val === '~') return null
-      return val.length > 1 && val.charAt(val.length - 1) === '/' ? val.slice(0, -1) : val
+      return val.length > 1 && val.charAt(val.length - 1) === '/' ? val.substring(0, val.length - 1) : val
     },
   })
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/playbook-builder",
-  "version": "3.2.0-alpha.9",
+  "version": "3.2.0-rc.1",
   "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)",
@@ -29,12 +29,11 @@
   "dependencies": {
     "@iarna/toml": "~2.2",
     "convict": "~6.2",
-    "js-yaml": "~4.1",
-    "json5": "~2.2",
-    "yargs-parser": "~20.2"
+    "js-yaml": "~4.2",
+    "json5": "~2.2"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "files": [
     "lib/"
@@ -48,7 +47,7 @@
     "web publishing"
   ],
   "scripts": {
-    "test": "_mocha",
+    "test": "node --test",
     "prepublishOnly": "npx -y downdoc@latest --prepublish",
     "postpublish": "npx -y downdoc@latest --postpublish"
   }