@antora/cli 3.0.0-beta.3 → 3.0.0-rc.1

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

@@ -51,9 +51,10 @@ function requireLogger (fromPath = undefined, moduleName = '@antora/logger') {
     return (
       requireLogger.cache ||
       (requireLogger.cache = fromPath ? userRequire(moduleName, { paths: [fromPath] }) : require(moduleName))
-    )
-  } catch {}
-  return fromPath && (requireLogger.cache = require(moduleName))
+    ) // require('@antora/logger')
+  } catch {
+    return fromPath && (requireLogger.cache = require(moduleName))
+  }
 }
 
 cli
@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/cli",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-rc.1",
   "description": "The command line interface for Antora.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -17,14 +17,18 @@
   "bin": {
     "antora": "bin/antora"
   },
+  "scripts": {
+    "test": "_mocha"
+  },
   "dependencies": {
-    "@antora/logger": "3.0.0-beta.3",
-    "@antora/playbook-builder": "3.0.0-beta.3",
+    "@antora/logger": "3.0.0-rc.1",
+    "@antora/playbook-builder": "3.0.0-rc.1",
     "@antora/user-require-helper": "~2.0",
     "commander": "~8.3"
   },
   "devDependencies": {
-    "@antora/site-publisher": "3.0.0-beta.3",
+    "@antora/site-publisher": "3.0.0-rc.1",
+    "@asciidoctor/core": "~2.2",
     "convict": "~6.2",
     "kapok-js": "~0.10"
   },
@@ -43,5 +47,5 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "45da95a2e2dea538379d2d9f42013d2208fb86c3"
+  "gitHead": "044371a33e2c0fed9724d30945bbb549d64845d5"
 }