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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +24 -54
  2. package/dist/app.js +1 -2
  3. package/package.json +7 -7
package/README.md CHANGED
@@ -1,57 +1,27 @@
1
1
  # `@canopycanopycanopy/b-ber-cli`
2
2
 
3
- The b-ber CLI tool is called `bber`. `b-ber-cli` is the entry point for all of the `bber` commands.
4
-
5
- ## Install
6
-
7
- ```
8
- $ npm i -g @canopycanopycanopy/b-ber-cli
9
- ```
10
-
11
- ### Usage
12
-
13
- Information about the CLI tool can be displayed by running:
14
-
15
- ```
16
- $ bber
17
- ```
18
-
19
- Information about each of the commands can be displayed by running:
20
-
21
- ```
22
- $ bber <command> --help
23
- ```
24
-
25
- ### Commands
26
-
27
- #### `new`
28
-
29
- The `new` command initiates a new project.
30
-
31
- ```
32
- $ bber new <name>
33
- ```
34
-
35
- #### `generate`
36
-
37
- The `generate` command creates a new chapter.
38
-
39
- ```
40
- $ bber generate <title> [type]
41
- ```
42
-
43
- #### `serve`
44
-
45
- The `serve` command previews a publication's contents in a browser.
46
-
47
- ```
48
- $ bber serve <type>
49
- ```
50
-
51
- #### `build`
52
-
53
- The `build` command creates an EPUB, Mobi, PDF, or all file formats.
54
-
55
- ```
56
- $ bber build [type]
3
+ `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`.
4
+
5
+ ## Commands
6
+
7
+ | Command | Syntax | Description |
8
+ | ---------- | --------------------------------------------------- | ------------------------------------------------------------- |
9
+ | `new` | `bber new <name>` | Scaffold a new b-ber project |
10
+ | `generate` | `bber generate <title> [type]` | Create a new chapter (frontmatter, bodymatter, or backmatter) |
11
+ | `build` | `bber build [epub\|mobi\|pdf\|reader\|sample\|web]` | Build one or all output formats |
12
+ | `serve` | `bber serve [reader\|web]` | Preview a build in the browser |
13
+ | `check` | `bber check [project]` | Validate project Markdown |
14
+ | `cover` | `bber cover` | Generate a project cover image |
15
+ | `theme` | `bber theme <set\|list> [name]` | Set or list available themes |
16
+ | `deploy` | `bber deploy [builds...]` | Upload builds to Amazon S3 |
17
+ | `opf` | `bber opf` | Generate the OPF package document |
18
+
19
+ Most commands accept a `--config <path>` flag pointing to a JSON or YAML file that extends the base project configuration.
20
+
21
+ ## Dev
22
+
23
+ ```bash
24
+ npm test # jest unit tests (tests in __tests__/commands/)
25
+ npm run build # compile src/ → dist/ with Babel
26
+ npm start # run via babel-node without compiling
57
27
  ```
package/dist/app.js CHANGED
@@ -11,8 +11,7 @@ exports.default = bber;
11
11
  var _yargs = _interopRequireDefault(require("yargs"));
12
12
  var _State = _interopRequireDefault(require("@canopycanopycanopy/b-ber-lib/State"));
13
13
  var commands = _interopRequireWildcard(require("./commands"));
14
- 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); }
15
- 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 && Object.prototype.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; }
14
+ 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); }
16
15
  const LINE_LENGTH = 70;
17
16
  function bber() {
18
17
  const showCustomHelp = () => console.log(`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@canopycanopycanopy/b-ber-cli",
3
- "version": "3.0.8-nav-memo.2+63b04c68",
3
+ "version": "3.0.8-next.61+2bbec564",
4
4
  "description": "",
5
5
  "main": "dist/index.js",
6
6
  "bin": {
@@ -22,11 +22,11 @@
22
22
  },
23
23
  "dependencies": {
24
24
  "@babel/runtime-corejs3": "^7.10.5",
25
- "@canopycanopycanopy/b-ber-lib": "3.0.8-nav-memo.2+63b04c68",
26
- "@canopycanopycanopy/b-ber-logger": "3.0.8-nav-memo.2+63b04c68",
27
- "@canopycanopycanopy/b-ber-shapes-sequences": "3.0.8-nav-memo.2+63b04c68",
28
- "@canopycanopycanopy/b-ber-tasks": "3.0.8-nav-memo.2+63b04c68",
29
- "@canopycanopycanopy/b-ber-templates": "3.0.8-nav-memo.2+63b04c68",
25
+ "@canopycanopycanopy/b-ber-lib": "3.0.8-next.61+2bbec564",
26
+ "@canopycanopycanopy/b-ber-logger": "3.0.8-next.61+2bbec564",
27
+ "@canopycanopycanopy/b-ber-shapes-sequences": "3.0.8-next.61+2bbec564",
28
+ "@canopycanopycanopy/b-ber-tasks": "3.0.8-next.61+2bbec564",
29
+ "@canopycanopycanopy/b-ber-templates": "3.0.8-next.61+2bbec564",
30
30
  "fs-extra": "^8.1.0",
31
31
  "lodash": "^4.17.21",
32
32
  "lodash.has": "latest",
@@ -59,5 +59,5 @@
59
59
  "url": "https://maxwellsimmer.com"
60
60
  }
61
61
  ],
62
- "gitHead": "63b04c68746dd40114a3718c6bef65710649a688"
62
+ "gitHead": "2bbec5643278f53becb0d2ba1f55edfe379d5587"
63
63
  }