@antora/cli 3.2.0-alpha.9 → 3.2.0-rc.2

package/lib/cli.js

@@ -17,7 +17,7 @@ function exitWithError (err, opts, msg = undefined) {
     err instanceof Error ? err.message : Object.assign((err = new Error(String(err))), { stack: undefined }).message
   )
   const name = errMessage.startsWith('asciidoctor: FAILED: ')
-    ? (errMessage = errMessage.slice(21)) && 'asciidoctor'
+    ? (errMessage = errMessage.substring(21)) && 'asciidoctor'
     : cli.name()
   if (!msg) msg = errMessage
   const { configureLogger, getLogger } = requireLogger()
@@ -30,19 +30,19 @@ function exitWithError (err, opts, msg = undefined) {
   } else {
     getLogger(name).fatal({ hint: 'Add the --stacktrace option to see the cause of the error.' }, msg)
   }
-  return exit()
+  return exit(1)
 }
 
-function exit () {
+function exit (failureExitCode = 2) {
   return requireLogger()
     .finalizeLogger()
-    .then((failOnExit) => process.exitCode || (process.exitCode = failOnExit ? 1 : 0))
+    .then((failOnExit) => process.exitCode || (process.exitCode = failOnExit ? failureExitCode : 0))
 }
 
 function lastDitchExit (err, msg) {
   if (msg !== err.message) console.error(msg)
   console.error(err)
-  process.exitCode = process.exitCode || 1
+  process.exitCode ||= 3
 }
 
 function getTTYColumns () {
@@ -67,7 +67,6 @@ function requireLogger (fromPath = undefined, moduleName = '@antora/logger') {
 cli
   .allowExcessArguments(false)
   .configureOutput({ getOutHelpWidth: getTTYColumns, getErrHelpWidth: getTTYColumns, outputError })
-  .storeOptionsAsProperties()
   .name('antora')
   .version(
     {
@@ -97,14 +96,16 @@ cli
     const name = cli.name()
     return cli
       .createHelp()
-      .wrap(
+      .boxWrap(
         ` \nRun '${name} <command> --help' to see options and examples for a command (e.g., ${name} generate --help).`,
         getTTYColumns(),
         0
       )
   })
   .option('-r, --require <library>', 'Require library (aka node module) or script path before executing command.')
-  .on('option:require', (requireRequest) => (cli.requireRequests = cli.requireRequests || []).push(requireRequest))
+  .on('option:require', (requireRequest) => {
+    cli.setOptionValueWithSource('requires', (cli.getOptionValue('requires') || []).concat(requireRequest), 'cli')
+  })
   .option('--stacktrace', 'Print the stacktrace to the console if the application fails.')
 
 cli
@@ -113,12 +114,13 @@ cli
   .optionsFromConvict(convict(buildPlaybook.defaultSchema), { exclude: 'playbook' })
   .trackOptions()
   .action(async (playbookFile, _options, command) => {
-    const errorOpts = { stacktrace: cli.stacktrace, silent: command.silent }
+    const errorOpts = { stacktrace: cli.getOptionValue('stacktrace'), silent: command.getOptionValue('silent') }
     const playbookDir = ospath.resolve(playbookFile, '..')
     const userRequireContext = { dot: playbookDir, paths: [playbookDir, __dirname] }
-    if (cli.requireRequests) {
+    const requires = cli.getOptionValue('requires') || []
+    if (requires.length) {
       try {
-        cli.requireRequests.forEach((requireRequest) => userRequire(requireRequest, userRequireContext))
+        requires.forEach((requireRequest) => userRequire(requireRequest, userRequireContext))
       } catch (err) {
         return exitWithError(err, errorOpts)
       }
@@ -148,7 +150,10 @@ cli
       if (generator && generator.charAt() !== '.') msg += ` Try installing the '${generator}' package.`
       return exitWithError(err, errorOpts, msg)
     }
-    return generateSite().then(exit, (err) => exitWithError(err, errorOpts))
+    return generateSite().then(
+      () => exit(),
+      (err) => exitWithError(err, errorOpts)
+    )
   })
   .options.sort((a, b) => a.long.localeCompare(b.long))
 

package/lib/commander/options-from-convict.js

@@ -34,7 +34,7 @@ function collectOptions (props, context = undefined) {
         const value = () => choices
         Object.defineProperties((option.choices = choices), { map: { value }, slice: { value } })
       } else if (format !== 'boolean') {
-        option.form += ` <${arg.substr(arg.lastIndexOf('-') + 1, arg.length)}>`
+        option.form += ` <${arg.substring(arg.lastIndexOf('-') + 1)}>`
       }
       if (default_ === null) {
         //option.mandatory = true

package/lib/commander/track-options.js

@@ -5,9 +5,8 @@ const { Command } = require('commander')
 Command.prototype.trackOptions = function () {
   const optionArgs = (this.optionArgs = [])
   for (const eventName of this.eventNames().filter((name) => name.startsWith('option:'))) {
-    // biome-ignore lint/complexity/useArrowFunction: needed to access arguments
     this.on(eventName, function () {
-      optionArgs.push(`--${eventName.slice(7)}`)
+      optionArgs.push(`--${eventName.substring(7)}`)
       if (arguments.length) optionArgs.push(arguments[0])
     })
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/cli",
-  "version": "3.2.0-alpha.9",
+  "version": "3.2.0-rc.2",
   "description": "The command line interface for Antora.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -29,20 +29,19 @@
     "antora": "bin/antora"
   },
   "dependencies": {
-    "@antora/logger": "3.2.0-alpha.9",
-    "@antora/playbook-builder": "3.2.0-alpha.9",
+    "@antora/logger": "3.2.0-rc.2",
+    "@antora/playbook-builder": "3.2.0-rc.2",
     "@antora/user-require-helper": "~3.0",
-    "commander": "~12.1"
+    "commander": "~14.0"
   },
   "devDependencies": {
-    "@antora/site-generator": "3.2.0-alpha.9",
-    "@antora/site-publisher": "3.2.0-alpha.9",
+    "@antora/site-generator": "3.2.0-rc.2",
+    "@antora/site-publisher": "3.2.0-rc.2",
     "@asciidoctor/core": "~2.2",
-    "convict": "~6.2",
-    "kapok-js": "~0.10"
+    "convict": "~6.2"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "files": [
     "bin/",
@@ -57,7 +56,7 @@
     "web publishing"
   ],
   "scripts": {
-    "test": "_mocha",
+    "test": "node --test",
     "prepublishOnly": "npx -y downdoc@latest --prepublish",
     "postpublish": "npx -y downdoc@latest --postpublish"
   }