@antora/cli 3.2.0-alpha.1 → 3.2.0-alpha.10

package/README.md

@@ -12,7 +12,7 @@ Once these packages are installed, you can use the `antora` command to generate
 
 ## How to Install
 
-Let's start by installing the CLI.
+Let’s start by installing the CLI.
 
 ```sh
 npm i -g @antora/cli
@@ -36,7 +36,7 @@ The `antora` command (specifically the implicit `generate` subcommand) will look
 
 ## How to Use
 
-To run Antora, you'll need a playbook file and at least one content (source) repository.
+To run Antora, you’ll need a playbook file and at least one content (source) repository.
 Consult the [quickstart](https://docs.antora.org/antora/latest/install-and-run-quickstart/) to find an example.
 
 Once you have your content sources set up, point the `antora` command at your playbook file:
@@ -45,7 +45,7 @@ Once you have your content sources set up, point the `antora` command at your pl
 antora antora-playbook.yml
 ```
 
-The `antora` command will output the generated site to the *build/site* folder by default.
+The `antora` command will output the generated site to the _build/site_ folder by default.
 
 ## Copyright and License
 

package/lib/cli.js

@@ -1,9 +1,9 @@
 'use strict'
 
 const buildPlaybook = require('@antora/playbook-builder')
-const cli = require('./commander')
+const { program: cli } = require('./commander')
 const convict = require('@antora/playbook-builder/lib/solitary-convict') // drop lib segment in Antora 4
-const ospath = require('path')
+const ospath = require('node:path')
 const userRequire = require('@antora/user-require-helper')
 
 const { version: VERSION } = require('../package.json')
@@ -90,7 +90,7 @@ cli
     '-v, --version',
     'Output the version of the CLI and default site generator.'
   )
-  .description('A modular, multi-repository documentation site generator for AsciiDoc.')
+  .description('A modular, single or multi-repository documentation site generator for AsciiDoc.')
   .usage('[options] [[command] [args]]')
   .helpOption('-h, --help', 'Output usage information.')
   .addHelpText('after', () => {
@@ -112,7 +112,7 @@ cli
   .description('Generate a documentation site as specified by <playbook>.')
   .optionsFromConvict(convict(buildPlaybook.defaultSchema), { exclude: 'playbook' })
   .trackOptions()
-  .action(async (playbookFile, options, command) => {
+  .action(async (playbookFile, _options, command) => {
     const errorOpts = { stacktrace: cli.stacktrace, silent: command.silent }
     const playbookDir = ospath.resolve(playbookFile, '..')
     const userRequireContext = { dot: playbookDir, paths: [playbookDir, __dirname] }
@@ -152,7 +152,7 @@ cli
   })
   .options.sort((a, b) => a.long.localeCompare(b.long))
 
-cli.command('help [command]', { hidden: true }).action((name, options, command) => {
+cli.command('help [command]', { hidden: true }).action((name) => {
   if (name) {
     const helpCommand = cli._findCommand(name)
     if (helpCommand) {

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

@@ -6,7 +6,7 @@ Command.prototype.optionsFromConvict = function (convictConfig, opts = {}) {
   let exclude = opts.exclude
   if (exclude && !Array.isArray(exclude)) exclude = [exclude]
   getOptions(convictConfig).forEach(({ name, form, description, default: default_, choices }) => {
-    if (exclude && exclude.includes(name)) return
+    if (exclude?.includes(name)) return
     this.addOption(
       choices
         ? this.createOption(form, description).default(default_, default_).choices(choices)
@@ -39,7 +39,7 @@ function collectOptions (props, context = undefined) {
       if (default_ === null) {
         //option.mandatory = true
         option.description += ' (required)'
-      } else if (default_ && default_.constructor !== Object) {
+      } else if (default_ && typeof default_ !== 'object') {
         option.default = default_
       }
       accum.push(option)

package/lib/commander/track-options.js

@@ -5,6 +5,7 @@ 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)}`)
       if (arguments.length) optionArgs.push(arguments[0])

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/cli",
-  "version": "3.2.0-alpha.1",
+  "version": "3.2.0-alpha.10",
   "description": "The command line interface for Antora.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -9,7 +9,11 @@
     "Sarah White <sarah@opendevise.com>"
   ],
   "homepage": "https://antora.org",
-  "repository": "gitlab:antora/antora",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/antora/antora.git",
+    "directory": "packages/cli"
+  },
   "bugs": {
     "url": "https://gitlab.com/antora/antora/issues"
   },
@@ -25,19 +29,20 @@
     "antora": "bin/antora"
   },
   "dependencies": {
-    "@antora/logger": "3.2.0-alpha.1",
-    "@antora/playbook-builder": "3.2.0-alpha.1",
-    "@antora/user-require-helper": "~2.0",
-    "commander": "~9.4"
+    "@antora/logger": "3.2.0-alpha.10",
+    "@antora/playbook-builder": "3.2.0-alpha.10",
+    "@antora/user-require-helper": "~3.0",
+    "commander": "~12.1"
   },
   "devDependencies": {
-    "@antora/site-publisher": "3.2.0-alpha.1",
+    "@antora/site-generator": "3.2.0-alpha.10",
+    "@antora/site-publisher": "3.2.0-alpha.10",
     "@asciidoctor/core": "~2.2",
     "convict": "~6.2",
     "kapok-js": "~0.10"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
   "files": [
     "bin/",
@@ -53,7 +58,7 @@
   ],
   "scripts": {
     "test": "_mocha",
-    "prepublishOnly": "node $npm_config_local_prefix/npm/prepublishOnly.js",
-    "postpublish": "node $npm_config_local_prefix/npm/postpublish.js"
+    "prepublishOnly": "npx -y downdoc@latest --prepublish",
+    "postpublish": "npx -y downdoc@latest --postpublish"
   }
 }