@antora/cli 3.0.0-beta.1 → 3.0.0-beta.5

package/README.md

@@ -1,6 +1,8 @@
 # Antora CLI
 
 The command line interface (CLI) for Antora.
+This package provides the `antora` command (i.e., bin script) to run Antora.
+It does not include the site generator, which must be installed separately.
 
 [Antora](https://antora.org) is a modular static site generator designed for creating documentation sites from AsciiDoc documents.
 Its site generator aggregates documents from versioned content repositories and processes them using [Asciidoctor](https://asciidoctor.org).
@@ -13,7 +15,7 @@ Once these packages are installed, you can use the `antora` command to generate
 Let's start by installing the CLI.
 
 ```sh
-npm install -g @antora/cli
+npm i -g @antora/cli
 ```
 
 This package adds the `antora` command to your PATH.
@@ -24,10 +26,10 @@ antora -v
 ```
 
 Next, install a site generator.
-The default site generator will be sufficient for most users.
+The site generator provided by Antora will be sufficient for most users.
 
 ```sh
-npm install -g @antora/site-generator-default
+npm i -g @antora/site-generator
 ```
 
 The `antora` command (specifically the implicit `generate` subcommand) will look for this package by default.
@@ -37,7 +39,7 @@ The `antora` command (specifically the implicit `generate` subcommand) will look
 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, just point the `antora` command at your playbook file:
+Once you have your content sources set up, point the `antora` command at your playbook file:
 
 ```sh
 antora antora-playbook.yml

package/lib/cli.js

@@ -1,53 +1,41 @@
-#!/usr/bin/env node
-
 'use strict'
 
 const buildPlaybook = require('@antora/playbook-builder')
 const cli = require('./commander')
 const convict = require('@antora/playbook-builder/lib/solitary-convict')
-const { configureLogger, getLogger, finalizeLogger } = require('@antora/logger')
 const ospath = require('path')
 const userRequire = require('@antora/user-require-helper')
 
 const { version: VERSION } = require('../package.json')
 
 async function run (argv = process.argv) {
-  const args = argv.slice(2)
-  return cli.parseAsync(args.length ? args : ['help'], { from: 'user' })
+  return cli.parseAsync((argv = argv.slice(2)).length ? argv : ['help'], { from: 'user' })
 }
 
 function exitWithError (err, opts, msg = undefined) {
-  if (!msg) msg = err.message || err
-  const name = msg.startsWith('asciidoctor: FAILED: ') ? (msg = msg.slice(21)) && 'asciidoctor' : cli.name()
-  const logger = getLogger(null)
-    ? getLogger(name)
-    : configureLogger({ format: 'pretty', level: opts.silent ? 'silent' : 'fatal', failureLevel: 'fatal' }).get(name)
+  const { getLogger, configureLogger } = requireLogger()
+  let errMessage = String(
+    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'
+    : cli.name()
+  if (!msg) msg = errMessage
+  if (!getLogger(null)) {
+    configureLogger({ format: 'pretty', level: opts.silent ? 'silent' : 'fatal', failureLevel: 'fatal' })
+  }
   if (opts.stacktrace) {
-    let loc, stack
-    if ((stack = err.backtrace)) {
-      err = Object.assign(new Error(msg), { stack: ['Error', ...stack.slice(1)].join('\n') })
-    } else if ((stack = err.stack)) {
-      if (err instanceof SyntaxError && stack.includes('\nSyntaxError: ')) {
-        ;[loc, stack] = stack.split(/\n+SyntaxError: [^\n]+/)
-        err = Object.assign(new SyntaxError(msg), { stack: stack.replace('\n', `SyntaxError\n    at ${loc}\n`) })
-      } else if (stack.startsWith(`${err.name}: ${msg}`)) {
-        stack = stack.replace(`${err.name}: ${msg}`, '').replace(/^\n/, '')
-        err = Object.assign(new err.constructor(msg), { stack: stack ? `${err.name}\n${stack}` : undefined })
-      }
-    } else {
-      err = Object.assign(new Error(msg), { stack: undefined })
-    }
-    if ({}.propertyIsEnumerable.call(err, 'name')) Object.defineProperty(err, 'name', { enumerable: false })
-    err.stack = `Cause: ${err.stack || '(no stacktrace)'}`
-    logger.fatal(err, msg)
+    getLogger(name).fatal(err, msg)
   } else {
-    logger.fatal(msg + '\nAdd the --stacktrace option to see the cause of the error.')
+    getLogger(name).fatal({ hint: 'Add the --stacktrace option to see the cause of the error.' }, msg)
   }
   return exit()
 }
 
 function exit () {
-  return finalizeLogger().then((failOnExit) => process.exit(failOnExit ? 1 : process.exitCode))
+  return requireLogger()
+    .finalizeLogger()
+    .then((failOnExit) => process.exit(process.exitCode || (failOnExit ? 1 : 0)))
 }
 
 function getTTYColumns () {
@@ -58,6 +46,17 @@ function outputError (str, write) {
   write(str.replace(/^error: /, cli.name() + ': '))
 }
 
+function requireLogger (fromPath = undefined, moduleName = '@antora/logger') {
+  try {
+    return (
+      requireLogger.cache ||
+      (requireLogger.cache = fromPath ? userRequire(moduleName, { paths: [fromPath] }) : require(moduleName))
+    ) // require('@antora/logger')
+  } catch {
+    return fromPath && (requireLogger.cache = require(moduleName))
+  }
+}
+
 cli
   .allowExcessArguments(false)
   .configureOutput({ getOutHelpWidth: getTTYColumns, getErrHelpWidth: getTTYColumns, outputError })
@@ -118,21 +117,23 @@ cli
       }
     }
     const args = command.optionArgs.concat('--playbook', playbookFile)
-    let playbook
+    let generator, generatorPath, playbook
     try {
       playbook = buildPlaybook(args, process.env, buildPlaybook.defaultSchema, (config) => {
         try {
-          configureLogger(config.getModel('runtime.log'), playbookDir)
+          generatorPath = userRequire.resolve((generator = config.get('antora.generator')), userRequireContext)
+        } catch {}
+        try {
+          requireLogger(generatorPath).configureLogger(config.getModel('runtime.log'), playbookDir)
         } catch {}
       })
     } catch (err) {
       return exitWithError(err, errorOpts)
     }
-    const generator = playbook.antora.generator
     let generateSite
     try {
       generateSite =
-        (generateSite = userRequire(generator, userRequireContext)).length === 1
+        (generateSite = require(generatorPath || userRequire.resolve(generator, userRequireContext))).length === 1
           ? generateSite.bind(null, playbook)
           : generateSite.bind(null, args, process.env)
     } catch (err) {
@@ -140,9 +141,7 @@ cli
       if (generator && generator.charAt() !== '.') msg += ` Try installing the '${generator}' package.`
       return exitWithError(err, errorOpts, msg)
     }
-    return generateSite()
-      .then(exit)
-      .catch((err) => exitWithError(err, errorOpts))
+    return generateSite().then(exit, (err) => exitWithError(err, errorOpts))
   })
   .options.sort((a, b) => a.long.localeCompare(b.long))
 

package/lib/index.js

@@ -0,0 +1,14 @@
+'use strict'
+
+/**
+ * The command line interface (CLI) for Antora.
+ *
+ * Provides a built-in set of commands to run Antora. The default command is
+ * generate. The generate command builds the specified playbook, configures the
+ * logger, then requires and invokes the generator function. When the generator
+ * function completes or fails, the generate command finalizes the logger and
+ * exits with the specified exit code.
+ *
+ * @namespace cli
+ */
+module.exports = require('./cli')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/cli",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.5",
   "description": "The command line interface for Antora.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -13,18 +13,19 @@
   "bugs": {
     "url": "https://gitlab.com/antora/antora/issues"
   },
-  "main": "lib/cli.js",
+  "main": "lib/index.js",
   "bin": {
     "antora": "bin/antora"
   },
   "dependencies": {
-    "@antora/logger": "3.0.0-beta.1",
-    "@antora/playbook-builder": "3.0.0-beta.1",
+    "@antora/logger": "3.0.0-beta.5",
+    "@antora/playbook-builder": "3.0.0-beta.5",
     "@antora/user-require-helper": "~2.0",
     "commander": "~8.3"
   },
   "devDependencies": {
-    "@antora/site-publisher": "3.0.0-beta.1",
+    "@antora/site-publisher": "3.0.0-beta.5",
+    "@asciidoctor/core": "~2.2",
     "convict": "~6.2",
     "kapok-js": "~0.10"
   },
@@ -43,5 +44,5 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "7c5ef1ea93dd489af533c80a936c736013c41769"
+  "gitHead": "a13d03df41654d4deb78211a5a54953ce2a35fb8"
 }