@canopycanopycanopy/b-ber-cli 3.0.8-nav-memo.4 → 3.0.8-next.61

package/README.md

@@ -1,57 +1,27 @@
 # `@canopycanopycanopy/b-ber-cli`
 
-The b-ber CLI tool is called `bber`. `b-ber-cli` is the entry point for all of the `bber` commands.
-
-## Install
-
-```
-$ npm i -g @canopycanopycanopy/b-ber-cli
-```
-
-### Usage
-
-Information about the CLI tool can be displayed by running:
-
-```
-$ bber
-```
-
-Information about each of the commands can be displayed by running:
-
-```
-$ bber <command> --help
-```
-
-### Commands
-
-#### `new`
-
-The `new` command initiates a new project.
-
-```
-$ bber new <name>
-```
-
-#### `generate`
-
-The `generate` command creates a new chapter.
-
-```
-$ bber generate <title> [type]
-```
-
-#### `serve`
-
-The `serve` command previews a publication's contents in a browser.
-
-```
-$ bber serve <type>
-```
-
-#### `build`
-
-The `build` command creates an EPUB, Mobi, PDF, or all file formats.
-
-```
-$ bber build [type]
+`b-ber-cli` is the command-line entry point for the b-ber build framework. It installs a `bber` binary that accepts commands to scaffold new projects, generate chapters, build output in multiple formats (EPUB, Mobi, PDF, reader, web), preview output in a browser, manage themes, generate cover images, deploy builds to S3, and validate project Markdown. Commands are parsed with yargs; each command delegates its work to `@canopycanopycanopy/b-ber-tasks`.
+
+## Commands
+
+| Command    | Syntax                                              | Description                                                   |
+| ---------- | --------------------------------------------------- | ------------------------------------------------------------- |
+| `new`      | `bber new <name>`                                   | Scaffold a new b-ber project                                  |
+| `generate` | `bber generate <title> [type]`                      | Create a new chapter (frontmatter, bodymatter, or backmatter) |
+| `build`    | `bber build [epub\|mobi\|pdf\|reader\|sample\|web]` | Build one or all output formats                               |
+| `serve`    | `bber serve [reader\|web]`                          | Preview a build in the browser                                |
+| `check`    | `bber check [project]`                              | Validate project Markdown                                     |
+| `cover`    | `bber cover`                                        | Generate a project cover image                                |
+| `theme`    | `bber theme <set\|list> [name]`                     | Set or list available themes                                  |
+| `deploy`   | `bber deploy [builds...]`                           | Upload builds to Amazon S3                                    |
+| `opf`      | `bber opf`                                          | Generate the OPF package document                             |
+
+Most commands accept a `--config <path>` flag pointing to a JSON or YAML file that extends the base project configuration.
+
+## Dev
+
+```bash
+npm test        # jest unit tests (tests in __tests__/commands/)
+npm run build   # compile src/ → dist/ with Babel
+npm start       # run via babel-node without compiling
 ```

package/dist/app.js

@@ -11,8 +11,7 @@ exports.default = bber;
 var _yargs = _interopRequireDefault(require("yargs"));
 var _State = _interopRequireDefault(require("@canopycanopycanopy/b-ber-lib/State"));
 var commands = _interopRequireWildcard(require("./commands"));
-function _getRequireWildcardCache(e) { if ("function" != typeof _WeakMap) return null; var r = new _WeakMap(), t = new _WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = _Object$defineProperty && _Object$getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? _Object$getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? _Object$defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireWildcard(e, t) { if ("function" == typeof _WeakMap) var r = new _WeakMap(), n = new _WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = _Object$defineProperty) && _Object$getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
 const LINE_LENGTH = 70;
 function bber() {
   const showCustomHelp = () => console.log(`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canopycanopycanopy/b-ber-cli",
-  "version": "3.0.8-nav-memo.4+d47a9aae",
+  "version": "3.0.8-next.61+2bbec564",
   "description": "",
   "main": "dist/index.js",
   "bin": {
@@ -22,11 +22,11 @@
   },
   "dependencies": {
     "@babel/runtime-corejs3": "^7.10.5",
-    "@canopycanopycanopy/b-ber-lib": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-logger": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-shapes-sequences": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-tasks": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-templates": "3.0.8-nav-memo.4+d47a9aae",
+    "@canopycanopycanopy/b-ber-lib": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-logger": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-shapes-sequences": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-tasks": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-templates": "3.0.8-next.61+2bbec564",
     "fs-extra": "^8.1.0",
     "lodash": "^4.17.21",
     "lodash.has": "latest",
@@ -59,5 +59,5 @@
       "url": "https://maxwellsimmer.com"
     }
   ],
-  "gitHead": "d47a9aae74dec3e3225e363b2434c7abe0fcf21b"
+  "gitHead": "2bbec5643278f53becb0d2ba1f55edfe379d5587"
 }