@canopycanopycanopy/b-ber-cli 1.2.13-react-reader.64 → 1.2.13-react-reader.68

package/dist/commands/build.js

@@ -1,5 +1,19 @@
 "use strict";
 
+var _Object$keys = require("@babel/runtime-corejs3/core-js-stable/object/keys");
+
+var _Object$getOwnPropertySymbols = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols");
+
+var _filterInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/filter");
+
+var _Object$getOwnPropertyDescriptor = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptor");
+
+var _forEachInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/for-each");
+
+var _Object$getOwnPropertyDescriptors = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptors");
+
+var _Object$defineProperties = require("@babel/runtime-corejs3/core-js-stable/object/define-properties");
+
 var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
@@ -14,6 +28,12 @@ var _reduce = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-sta
 
 var _concat = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/concat"));
 
+var _entries = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/entries"));
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/defineProperty"));
+
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/objectWithoutProperties"));
+
 var _path = _interopRequireDefault(require("path"));
 
 var _bBerTasks = require("@canopycanopycanopy/b-ber-tasks");
@@ -30,25 +50,65 @@ var _utils = require("@canopycanopycanopy/b-ber-lib/utils");
 
 var _bBerLogger = _interopRequireDefault(require("@canopycanopycanopy/b-ber-logger"));
 
-// note leading pipe - to ensure we can run the `all` command without arguments
+var _configOptions = require("../lib/config-options");
+
+const _excluded = ["_", "$0", "config"];
+
+function ownKeys(object, enumerableOnly) { var keys = _Object$keys(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = _filterInstanceProperty(symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var _context, _context2; var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? _forEachInstanceProperty(_context = ownKeys(Object(source), !0)).call(_context, function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(target, _Object$getOwnPropertyDescriptors(source)) : _forEachInstanceProperty(_context2 = ownKeys(Object(source))).call(_context2, function (key) { _Object$defineProperty(target, key, _Object$getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+// Leading pipe ensures that the `all` command can be run without arguments
 const command = 'build [|epub|mobi|pdf|reader|sample|web]';
 const describe = 'Build a project';
 
-const handler = argv => {
+const noop = () => {};
+
+const handler = async argv => {
   process.env.NODE_ENV = process.env.NODE_ENV || 'development';
-  const sequence = (0, _createBuildSequence.default)(argv);
-  const subSequence = (0, _reduce.default)(sequence).call(sequence, (a, c) => (0, _concat.default)(a).call(a, ..._sequences.default[c]), []);
+  const {
+    _: desiredSequences,
+    $0,
+    config
+  } = argv,
+        configOptions = (0, _objectWithoutProperties2.default)(argv, _excluded);
+  const sequence = (0, _createBuildSequence.default)(desiredSequences);
+  const subSequence = (0, _reduce.default)(sequence).call(sequence, (a, c) => (0, _concat.default)(a).call(a, ..._sequences.default[c]), []); // Set up the config object that's going to be passed into the `init` function
+
+  let projectConfig = {}; // Check if a config files has been specified
+
+  if (config) projectConfig = await (0, _configOptions.parseConfigFile)(config);
+  projectConfig = _objectSpread(_objectSpread({}, projectConfig), configOptions);
 
   _State.default.update('sequence', subSequence);
 
   _bBerLogger.default.registerSequence(_State.default, command, subSequence);
 
   const run = buildTasks => {
-    const build = buildTasks.shift();
+    const build = buildTasks.shift(); // Reset any previous changes to state and update the build type
 
     _State.default.reset();
 
-    _State.default.update('build', build);
+    _State.default.update('build', build); // Apply the config options that may have been passed in via CLI flags
+
+
+    for (const [key, val] of (0, _entries.default)(projectConfig)) {
+      if (!_State.default.has(`config.${key}`)) {
+        _bBerLogger.default.warn('Invalid configuration option [%s]', key);
+
+        continue;
+      }
+
+      if (_configOptions.blacklistedConfigOptions.has(key)) {
+        _bBerLogger.default.warn('Disallowed configuration option [%s]', key);
+
+        continue;
+      }
+
+      _bBerLogger.default.notice('Applying configuration option [%s]:[%s]', key, val);
+
+      _State.default.update(`config.${key}`, val);
+    }
 
     return (0, _bBerTasks.serialize)(_sequences.default[build]).then(() => {
       if (buildTasks.length) run(buildTasks);
@@ -63,7 +123,7 @@ const handler = argv => {
   }).then(() => run(sequence)).catch(console.error);
 };
 
-const builder = yargs => yargs.command('', 'Build all formats', () => {}, handler).command('epub', 'Build an Epub', () => {}, handler).command('mobi', 'Build a Mobi', () => {}, handler).command('pdf', 'Build a PDF', () => {}, handler).command('reader', 'Build for the b-ber-reader format', () => {}, handler).command('sample', 'Build a sample Epub', () => {}, handler).command('web', 'Build for web', () => {}, handler).command('xml', 'Build for XML', () => {}, handler).help('h').alias('h', 'help');
+const builder = yargs => (0, _configOptions.withConfigOptions)(yargs).command('', 'Build all formats', noop, handler).command('epub', 'Build an Epub', noop, handler).command('mobi', 'Build a Mobi', noop, handler).command('pdf', 'Build a PDF', noop, handler).command('reader', 'Build for the b-ber-reader format', noop, handler).command('sample', 'Build a sample Epub', noop, handler).command('web', 'Build for web', noop, handler).command('xml', 'Build for XML', noop, handler).help('h').alias('h', 'help');
 
 var _default = {
   command,

package/dist/commands/new.js

@@ -24,22 +24,22 @@ _Object$defineProperty(exports, "__esModule", {
 
 exports.default = void 0;
 
+var _entries = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/entries"));
+
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/defineProperty"));
 
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/objectWithoutProperties"));
 
-var _fsExtra = _interopRequireDefault(require("fs-extra"));
-
-var _path = _interopRequireDefault(require("path"));
+var _State = _interopRequireDefault(require("@canopycanopycanopy/b-ber-lib/State"));
 
 var _bBerTasks = require("@canopycanopycanopy/b-ber-tasks");
 
 var _utils = require("@canopycanopycanopy/b-ber-lib/utils");
 
-var _YamlAdaptor = _interopRequireDefault(require("@canopycanopycanopy/b-ber-lib/YamlAdaptor"));
-
 var _bBerLogger = _interopRequireDefault(require("@canopycanopycanopy/b-ber-logger"));
 
+var _configOptions = require("../lib/config-options");
+
 const _excluded = ["_", "$0", "name", "config"];
 
 function ownKeys(object, enumerableOnly) { var keys = _Object$keys(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = _filterInstanceProperty(symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
@@ -49,74 +49,10 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 const command = 'new <name>';
 const describe = 'Create a new project';
 
-const builder = yargs => yargs.positional('name', {
+const builder = yargs => (0, _configOptions.withConfigOptions)(yargs.positional('name', {
   describe: 'New project name',
   type: 'string'
-}).option('env', {
-  describe: 'The default build environment',
-  type: 'string' // default: 'development',
-
-}).option('theme', {
-  describe: 'Default theme name',
-  type: 'string' // default: 'b-ber-theme-serif',
-
-}).option('src', {
-  describe: 'The name of the source directory',
-  type: 'string' // default: 'src',
-
-}).option('dist', {
-  describe: 'The name of the dist directory',
-  type: 'string' // default: 'dist',
-
-}).option('cache', {
-  describe: 'Whether to enable caching',
-  type: 'boolean' // default: false,
-
-}).option('themes_directory', {
-  describe: 'Relative or absolute path to the directory for third-party themes',
-  type: 'string' // default: './themes',
-
-}).option('ignore', {
-  describe: 'Array of files or folders to ignore during the build',
-  type: 'array' // default: [],
-
-}).option('base_path', {
-  describe: 'Base path appended to the URL for the reader build',
-  type: 'string' // default: '/',
-
-}).option('remote_url', {
-  describe: 'URL at which the reader build will be made public',
-  type: 'string' // default: 'http://localhost:4000/',
-
-}).option('reader_url', {
-  describe: 'URL that hosts the assets for the reader reader build',
-  type: 'string' // default: 'http://localhost:4000/project-reader',
-
-}).option('base_url', {
-  describe: 'URL to map assets for the web build',
-  type: 'string' // default: '',
-
-}).option('bucket_url', {
-  describe: 'The S3 bucket URL where the remote project will be deployed to if hosting on S3',
-  type: 'string' // default: '',
-
-}).option('private', {
-  describe: 'If the web and reader builds should be discoverable by search engines',
-  type: 'boolean' // default: false,
-
-}).option('remote_javascripts', {
-  describe: 'Remotely hosted JavaScript files for the reader',
-  type: 'array' // default: [],
-
-}).option('remote_stylesheets', {
-  describe: 'Remotely hosted stylesheets files for the reader',
-  type: 'array' // default: [],
-
-}).option('config', {
-  describe: 'Path to a JSON or YAML configuration file that will extend the base configuration',
-  type: 'string' // default: '',
-
-}).fail((msg, err) => (0, _utils.fail)(msg, err, yargs)).help('h').alias('h', 'help').usage(`\nUsage: $0 new "My Project"\n\n${describe}`);
+})).fail((msg, err) => (0, _utils.fail)(msg, err, yargs)).help('h').alias('h', 'help').usage(`\nUsage: $0 new "My Project"\n\n${describe}`);
 
 const handler = async argv => {
   // Extract CLI options and get the config file option in case there is one
@@ -126,42 +62,32 @@ const handler = async argv => {
     name,
     config
   } = argv,
-        rest = (0, _objectWithoutProperties2.default)(argv, _excluded); // Set up the config object that's going to be passed into the `init` function
+        configOptions = (0, _objectWithoutProperties2.default)(argv, _excluded); // Set up the config object that's going to be passed into the `init` function
 
   let projectConfig = {}; // Check if a config files has been specified
 
-  if (config) {
-    const ext = _path.default.extname(config);
+  if (config) projectConfig = await (0, _configOptions.parseConfigFile)(config); // Override the values specified in the config file with values
+  // that have been explicitly provided on the CLI. Allows using the
+  // config file as a template that can be overridden, e.g.,
+  // bber new foo --config my-generic-conf.yaml --base_path /foo
 
-    const configPath = _path.default.resolve(process.cwd(), config);
+  projectConfig = _objectSpread(_objectSpread({}, projectConfig), configOptions); // Remove blacklisted and unsupported config options
 
-    if (!(await _fsExtra.default.pathExists(config))) {
-      _bBerLogger.default.error('Could not find config at %s', configPath);
-    }
+  for (const [key] of (0, _entries.default)(projectConfig)) {
+    if (!_State.default.has(`config.${key}`)) {
+      _bBerLogger.default.warn('Invalid configuration option [%s]', key);
 
-    if (/^\.(?:ya?ml|json)/i.test(ext) === false) {
-      _bBerLogger.default.error('Config file must have a .json or .yaml/.yml file extension');
+      delete projectConfig[key];
+      continue;
     }
 
-    const contents = await _fsExtra.default.readFile(config);
+    if (_configOptions.blacklistedConfigOptions.has(key)) {
+      _bBerLogger.default.warn('Disallowed configuration option [%s]', key);
 
-    if (/^\.ya?ml/i.test(ext)) {
-      projectConfig = _YamlAdaptor.default.parse(contents);
-    } else {
-      projectConfig = JSON.parse(contents);
+      delete projectConfig[key];
+      continue;
     }
-  } // Override the values specified in the config file with values
-  // that have been explicitly provided on the CLI. Allows using the
-  // config file as a template that can be overridden, e.g.,
-  // bber new foo --config my-generic-conf.yaml --base_path /foo
-
-
-  projectConfig = _objectSpread(_objectSpread({}, projectConfig), rest); // Attributes not currently configurable via the CLI:
-  // ibooks_specified_fonts
-  // autoprefixer_options
-  // base_url
-  // downloads
-  // ui_options
+  }
 
   const initializer = new _bBerTasks.init({
     name,

package/dist/lib/config-options.js

@@ -0,0 +1,118 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+exports.parseConfigFile = exports.blacklistedConfigOptions = void 0;
+exports.withConfigOptions = withConfigOptions;
+
+var _set = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/set"));
+
+var _fsExtra = _interopRequireDefault(require("fs-extra"));
+
+var _path = _interopRequireDefault(require("path"));
+
+var _YamlAdaptor = _interopRequireDefault(require("@canopycanopycanopy/b-ber-lib/YamlAdaptor"));
+
+var _bBerLogger = _interopRequireDefault(require("@canopycanopycanopy/b-ber-logger"));
+
+// Attributes not currently configurable via the CLI:
+// ibooks_specified_fonts   always set to `true`
+// autoprefixer_options     no JSON support
+// downloads                no JSON support
+// ui_options               no JSON support
+function withConfigOptions(yargs) {
+  return yargs.option('env', {
+    describe: 'The default build environment',
+    type: 'string' // default: 'development',
+
+  }).option('theme', {
+    describe: 'Default theme name',
+    type: 'string' // default: 'b-ber-theme-serif',
+
+  }).option('src', {
+    describe: 'The name of the source directory',
+    type: 'string' // default: 'src',
+
+  }).option('dist', {
+    describe: 'The name of the dist directory',
+    type: 'string' // default: 'dist',
+
+  }).option('cache', {
+    describe: 'Whether to enable caching',
+    type: 'boolean' // default: false,
+
+  }).option('themes_directory', {
+    describe: 'Relative or absolute path to the directory for third-party themes',
+    type: 'string' // default: './themes',
+
+  }).option('ignore', {
+    describe: 'Array of files or folders to ignore during the build',
+    type: 'array' // default: [],
+
+  }).option('base_path', {
+    describe: 'Base path appended to the URL for the reader build',
+    type: 'string' // default: '/',
+
+  }).option('remote_url', {
+    describe: 'URL at which the reader build will be made public',
+    type: 'string' // default: 'http://localhost:4000/',
+
+  }).option('reader_url', {
+    describe: 'URL that hosts the assets for the reader reader build',
+    type: 'string' // default: 'http://localhost:4000/project-reader',
+
+  }).option('base_url', {
+    describe: 'URL to map assets for the web build',
+    type: 'string' // default: '',
+
+  }).option('bucket_url', {
+    describe: 'The S3 bucket URL where the remote project will be deployed to if hosting on S3',
+    type: 'string' // default: '',
+
+  }).option('private', {
+    describe: 'If the web and reader builds should be discoverable by search engines',
+    type: 'boolean' // default: false,
+
+  }).option('remote_javascripts', {
+    describe: 'Remotely hosted JavaScript files for the reader',
+    type: 'array' // default: [],
+
+  }).option('remote_stylesheets', {
+    describe: 'Remotely hosted stylesheets files for the reader',
+    type: 'array' // default: [],
+
+  }).option('config', {
+    describe: 'Path to a JSON or YAML configuration file that will extend the base configuration',
+    type: 'string' // default: '',
+
+  });
+}
+
+const blacklistedConfigOptions = new _set.default(['ibooks_specified_fonts', 'autoprefixer_options', 'downloads', 'ui_options']);
+exports.blacklistedConfigOptions = blacklistedConfigOptions;
+
+const parseConfigFile = async configFile => {
+  const ext = _path.default.extname(configFile);
+
+  const configPath = _path.default.resolve(process.cwd(), configFile);
+
+  if (!(await _fsExtra.default.pathExists(configPath))) {
+    _bBerLogger.default.error(`Could not find config at [${configPath}]`);
+  }
+
+  if (/^\.(?:ya?ml|json)/i.test(ext) === false) {
+    _bBerLogger.default.error('Config file must have a .json or .yaml/.yml file extension');
+  }
+
+  const contents = await _fsExtra.default.readFile(configPath);
+  if (/^\.ya?ml/i.test(ext)) return _YamlAdaptor.default.parse(contents);
+  return JSON.parse(contents);
+};
+
+exports.parseConfigFile = parseConfigFile;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canopycanopycanopy/b-ber-cli",
-  "version": "1.2.13-react-reader.64+d46c0879",
+  "version": "1.2.13-react-reader.68+e7d3e3df",
   "description": "",
   "main": "dist/index.js",
   "bin": {
@@ -25,7 +25,7 @@
     "@canopycanopycanopy/b-ber-lib": "1.2.15",
     "@canopycanopycanopy/b-ber-logger": "1.2.12",
     "@canopycanopycanopy/b-ber-shapes-sequences": "1.2.12",
-    "@canopycanopycanopy/b-ber-tasks": "1.2.13-react-reader.64+d46c0879",
+    "@canopycanopycanopy/b-ber-tasks": "1.2.15",
     "@canopycanopycanopy/b-ber-templates": "1.2.15",
     "fs-extra": "^8.1.0",
     "lodash": "^4.17.21",
@@ -59,5 +59,5 @@
       "url": "https://maxwellsimmer.com"
     }
   ],
-  "gitHead": "d46c08797de554f0faf90c3c02300a9079fbb5e6"
+  "gitHead": "e7d3e3df3e8791944b2be202edd928217793c1d8"
 }