@zimbra/zimlet-cli 15.1.0 → 16.0.0

package/.eslintrc.js

@@ -0,0 +1,15 @@
+module.exports = {
+	parser: '@babel/eslint-parser',
+	extends: [
+		'eslint-config-synacor'
+	],
+	globals: {
+		zimlet: true
+	},
+	rules: {
+		indent: ['error', 'tab', {
+			ignoredNodes: ['TemplateLiteral'],
+			SwitchCase: 1
+		}]
+	}
+};

package/dist/cli.js

@@ -2,17 +2,11 @@
 "use strict";
 
 require("@babel/polyfill");
-
 var _yargs = _interopRequireDefault(require("yargs"));
-
 var _create = _interopRequireDefault(require("./commands/create"));
-
 var _package = _interopRequireDefault(require("./commands/package"));
-
 var _index = _interopRequireDefault(require("./index"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const optionsForAllCommands = {
   config: {
     type: 'string',
@@ -20,7 +14,8 @@ const optionsForAllCommands = {
     default: './zimlet.config.js'
   }
 };
-_yargs.default.command(_create.default).command('watch', 'Start a development server', { ...optionsForAllCommands,
+_yargs.default.command(_create.default).command('watch', 'Start a development server', {
+  ...optionsForAllCommands,
   port: {
     type: 'number',
     description: 'Port of dev server',
@@ -34,7 +29,8 @@ _yargs.default.command(_create.default).command('watch', 'Start a development se
 }, argv => {
   argv.watch = true;
   runCli(argv);
-}).command(['build'], 'Compile a zimlet', { ...optionsForAllCommands,
+}).command(['build'], 'Compile a zimlet', {
+  ...optionsForAllCommands,
   dest: {
     type: 'string',
     defaultDescription: './build',
@@ -49,10 +45,13 @@ _yargs.default.command(_create.default).command('watch', 'Start a development se
   argv.production = true;
   runCli(argv);
 }).command(_package.default).demandCommand(1, 'A command must be specified').usage('Zimlet client tool for developing and building Zimlets.\n\nType "zimlet [commmand] --help" for command specific usage information').help().argv;
-
 function runCli(argv) {
   (0, _index.default)(argv, (err, result) => {
-    if (err) process.stderr.write(err);else if (result) process.stdout.write(result);
+    if (err) {
+      process.stderr.write(err);
+    } else if (result) {
+      process.stdout.write(result);
+    }
     setTimeout(() => {
       process.exit(err ? 1 : 0);
     }, 10);

package/dist/commands/create.js

@@ -4,48 +4,33 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _ora = _interopRequireDefault(require("ora"));
-
 var _gittar = _interopRequireDefault(require("gittar"));
-
 var _chalk = require("chalk");
-
 var _fs = _interopRequireDefault(require("fs"));
-
 var _inquirer = require("inquirer");
-
 var _path = require("path");
-
 var _validateNpmPackageName = _interopRequireDefault(require("validate-npm-package-name"));
-
 var _util = require("../util");
-
 var _setup = require("./../lib/setup");
-
 var _asyncCommand = _interopRequireDefault(require("../lib/async-command"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 // This command borrows heavily from preact-cli's create command
 // https://github.com/developit/preact-cli
-const ORG = 'zimbra'; //repo we want as an alias for 'default'?
+const ORG = 'zimbra';
 
+//repo we want as an alias for 'default'?
 const DEFAULT_REPO = 'zimbra/zm-x-zimlet-template-default';
 const RGX = /\.(woff2?|ttf|eot|jpe?g|ico|png|gif|mp4|mov|ogg|webm)(\?.*)?$/i;
-
 const isMedia = str => RGX.test(str);
-
 const capitalize = str => str.charAt(0).toUpperCase() + str.substring(1);
-
 const templateDesc = 'Remote template to clone (user/repo#tag)',
-      destDesc = 'Directory to create the zimlet',
-      nameDesc = 'The zimlet\'s name',
-      forceDesc = 'Force `dest` directory to created if it already exists; will overwrite!',
-      installDesc = 'Install dependencies',
-      yarnDesc = 'Install with `yarn` instead of `npm`',
-      gitDesc = 'Initialize a `git` repository';
-
+  destDesc = 'Directory to create the zimlet',
+  nameDesc = 'The zimlet\'s name',
+  forceDesc = 'Force `dest` directory to created if it already exists; will overwrite!',
+  installDesc = 'Install dependencies',
+  yarnDesc = 'Install with `yarn` instead of `npm`',
+  gitDesc = 'Initialize a `git` repository';
 var _default = (0, _asyncCommand.default)({
   command: 'create [template] [dest]',
   desc: 'Create a new zimlet.',
@@ -87,34 +72,32 @@ var _default = (0, _asyncCommand.default)({
       description: destDesc
     }
   },
-
   async handler(argv) {
     let destArg = argv.dest;
     let templateArg = argv.template;
-    let nameArg = argv.name; // Prompt if incomplete data
+    let nameArg = argv.name;
 
+    // Prompt if incomplete data
     if (!destArg || !templateArg) {
       (0, _util.warn)('Insufficient command arguments! Prompting...');
       (0, _util.info)('Alternatively, run `zimlet create --help` for usage info.');
       let questions = isMissing(argv);
-      let response = await (0, _inquirer.prompt)(questions); //trim all args to prevent accidental extra whitespace in user prompted values from messing things up
-
+      let response = await (0, _inquirer.prompt)(questions);
+      //trim all args to prevent accidental extra whitespace in user prompted values from messing things up
       Object.keys(response).forEach(k => response[k] && response[k].trim && (response[k] = response[k].trim()));
       Object.assign(argv, response);
-    } //default is a special keyword that will use the predefiend default repo
-
+    }
 
+    //default is a special keyword that will use the predefiend default repo
     if (templateArg === 'default') templateArg = DEFAULT_REPO;
     let cwd = (0, _path.resolve)(argv.cwd);
     destArg = destArg || (0, _path.dirname)(cwd);
     let isYarn = argv.yarn && (0, _util.hasCommand)('yarn');
     let target = (0, _path.resolve)(cwd, destArg);
     let exists = (0, _util.isDir)(target);
-
     if (exists && !argv.force) {
       return (0, _util.error)('Refusing to overwrite current directory! Please specify a different destination or use the `--force` flag', 1);
     }
-
     if (exists && argv.force) {
       if (!(await (0, _inquirer.prompt)({
         type: 'confirm',
@@ -125,26 +108,23 @@ var _default = (0, _asyncCommand.default)({
         return (0, _util.error)('Refusing to overwrite current directory!', 1);
       }
     }
-
     let repo = templateArg;
-
     if (!repo.includes('/')) {
       repo = `${ORG}/${repo}`;
       (0, _util.info)(`Fetching ${templateArg} template from ${repo}...`);
-    } // Use `--name` value or `dest` dir's name
-
+    }
 
+    // Use `--name` value or `dest` dir's name
     nameArg = nameArg || destArg;
     let {
       errors
     } = (0, _validateNpmPackageName.default)(nameArg);
-
     if (errors) {
       errors.unshift(`Invalid package name: ${nameArg}`);
       return (0, _util.error)(errors.map(capitalize).join('\n  ~ '), 1);
-    } // Attempt to fetch the `template`
-
+    }
 
+    // Attempt to fetch the `template`
     let archive = await _gittar.default.fetch(repo).catch(err => {
       err = err || {
         message: 'An error occured while fetching template.'
@@ -154,13 +134,13 @@ var _default = (0, _asyncCommand.default)({
     let spinner = (0, _ora.default)({
       text: 'Creating project',
       color: 'magenta'
-    }).start(); // Extract files from `archive` to `target`
-    // TODO: read & respond to meta/hooks
+    }).start();
 
+    // Extract files from `archive` to `target`
+    // TODO: read & respond to meta/hooks
     let keeps = [];
     await _gittar.default.extract(archive, target, {
       strip: 2,
-
       filter(path, obj) {
         if (path.includes('/template/')) {
           obj.on('end', () => {
@@ -171,30 +151,28 @@ var _default = (0, _asyncCommand.default)({
           return true;
         }
       }
-
     });
-
     if (keeps.length) {
-      let dict = new Map(); // TODO: concat author-driven patterns
-      //globally replace instances of {{name}} with value of name arg
+      let dict = new Map();
 
+      // TODO: concat author-driven patterns
+      //globally replace instances of {{name}} with value of name arg
       ['name'].forEach(str => {
         // if value is defined
         if (nameArg !== void 0) {
           dict.set(new RegExp(`{{\\s*${str}\\s*}}`, 'g'), nameArg);
         }
-      }); // Update each file's contents
+      });
 
+      // Update each file's contents
       let buf,
-          entry,
-          enc = 'utf8';
-
+        entry,
+        enc = 'utf8';
       for (entry of keeps) {
         buf = _fs.default.readFileSync(entry, enc);
         dict.forEach((v, k) => {
           buf = buf.replace(k, v);
         });
-
         try {
           _fs.default.writeFileSync(entry, buf, enc);
         } catch (err) {
@@ -204,31 +182,28 @@ var _default = (0, _asyncCommand.default)({
     } else {
       return (0, _util.error)(`No \`template\` directory found within ${repo}!`, 1);
     }
+    spinner.succeed().start('Parsing `package.json` file');
 
-    spinner.succeed().start('Parsing `package.json` file'); // Validate user's `package.json` file
-
+    // Validate user's `package.json` file
     let pkgData,
-        pkgFile = (0, _path.resolve)(target, 'package.json');
-
+      pkgFile = (0, _path.resolve)(target, 'package.json');
     if (pkgFile) {
       try {
         pkgData = JSON.parse(_fs.default.readFileSync(pkgFile));
       } catch (err) {
         return (0, _util.error)(`Could not reach package.json file: ${err}`);
-      } // Write default "scripts" if none found
-
-
+      }
+      // Write default "scripts" if none found
       pkgData.scripts = pkgData.scripts || (await (0, _setup.addScripts)(pkgData, target, isYarn));
     } else {
       (0, _util.warn)('Could not locate `package.json` file!');
-    } // Update `package.json` key
-
+    }
 
+    // Update `package.json` key
     if (pkgData) {
       spinner.succeed().start('Updating `name` to `' + nameArg + '` within `package.json` file');
       pkgData.name = nameArg.toLowerCase().replace(/\s+/g, '_');
     }
-
     if (pkgData) {
       // Assume changes were made
       try {
@@ -237,17 +212,14 @@ var _default = (0, _asyncCommand.default)({
         return (0, _util.error)(`Unable to write back package.json file: ${err}`);
       }
     }
-
     if (argv.install) {
       spinner.succeed().start('Installing dependencies');
       await (0, _setup.install)(target, isYarn);
     }
-
     if (argv.git) {
       spinner.succeed().start('Initializing git repo');
       await (0, _setup.initGit)(target);
     }
-
     spinner.succeed().succeed('Done!\n');
     let pfx = isYarn ? 'yarn' : 'npm run';
     return (0, _util.trim)(`
@@ -264,15 +236,10 @@ var _default = (0, _asyncCommand.default)({
 			  ${(0, _chalk.green)(pfx + ' package')}
 		`) + '\n';
   }
-
 }); // Formulate Questions if `create` args are missing
-
-
 exports.default = _default;
-
 function isMissing(argv) {
   let out = [];
-
   const ask = (name, message, val) => {
     let type = typeof val === 'boolean' ? 'confirm' : 'input';
     out.push({
@@ -281,25 +248,22 @@ function isMissing(argv) {
       type,
       default: val
     });
-  }; // Required data
-
+  };
 
+  // Required data
   !argv.template && ask('template', templateDesc, 'default');
-  !argv.dest && ask('dest', destDesc); // Extra data / flags
-
+  !argv.dest && ask('dest', destDesc);
+  // Extra data / flags
   !argv.name && ask('name', nameDesc, _ref => {
     let {
       dest
     } = _ref;
     return dest;
   }); //use the current answer for 'dest' as the default
-
   !argv.force && ask('force', forceDesc, false);
   ask('install', installDesc, true); // defaults `true`, ask anyway
-
   !argv.yarn && ask('yarn', yarnDesc, false);
   !argv.git && ask('git', gitDesc, false);
   return out;
 }
-
 module.exports = exports.default;

package/dist/commands/package.js

@@ -4,19 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _fs = _interopRequireDefault(require("fs"));
-
 var _path = _interopRequireDefault(require("path"));
-
 var _admZip = _interopRequireDefault(require("adm-zip"));
-
 var _util = require("../util");
-
 var _asyncCommand = _interopRequireDefault(require("../lib/async-command"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 var _default = (0, _asyncCommand.default)({
   command: 'package',
   desc: 'Package a zimlet for deployment',
@@ -60,36 +53,30 @@ var _default = (0, _asyncCommand.default)({
       description: 'Directory for packaged artifacts'
     }
   },
-
   async handler(argv) {
     // normalize built files source directory and desination package dir
     let cwd = process.cwd();
-
     let builddir = _path.default.resolve(cwd, argv.builddir || 'build');
+    let dest = _path.default.resolve(cwd, argv.dest || 'pkg', `${argv.name}.zip`);
 
-    let dest = _path.default.resolve(cwd, argv.dest || 'pkg', `${argv.name}.zip`); // Get label and description from src/intl/en_US.json or from argument
-
-
+    // Get label and description from src/intl/en_US.json or from argument
     const {
       label,
       description
     } = getZimletLabelDescription() || argv;
-
     if (!(label && description)) {
       return (0, _util.error)('label and description string are not provided as argument');
-    } // Create the xml descriptor file for the zimlet
-
+    }
 
+    // Create the xml descriptor file for the zimlet
     let xmlFile = `${argv.name}.xml`;
     let zimletXML = `<zimlet name="${argv.name}" version="${argv.pkgVersion}" description="${description}" label="${label}" zimbraXZimletCompatibleSemVer="${argv.zimbraXVersion}">`;
     let files;
-
     try {
       files = _fs.default.readdirSync(builddir);
     } catch (err) {
       return (0, _util.error)(`Failed to read ${builddir}: ${err}`, 1);
     }
-
     files.filter(file => !file.match(/\.properties$/)).forEach(file => {
       if (file.match(/\.js$/)) {
         zimletXML += `\n\t<include>${file}</include>`;
@@ -100,35 +87,28 @@ var _default = (0, _asyncCommand.default)({
       }
     });
     zimletXML += '\n</zimlet>';
-
     try {
       _fs.default.writeFileSync(_path.default.resolve(builddir, xmlFile), zimletXML);
     } catch (err) {
       return (0, _util.error)(`Failed to write XML file: ${err}`, 1);
     }
+    createLocalizationFiles(argv.name, label, description);
 
-    createLocalizationFiles(argv.name, label, description); //Zip up the contents of the build dir along with the xml file as the final zimlet deliverable
-
+    //Zip up the contents of the build dir along with the xml file as the final zimlet deliverable
     let zipFile = new _admZip.default();
     zipFile.addLocalFolder(builddir, '');
     zipFile.writeZip(dest);
     return `Successfully packaged zimlet to: ${dest}\n`;
   }
-
 });
-
 exports.default = _default;
-
 function getZimletLabelDescription() {
   const intlDir = _path.default.resolve(process.cwd(), 'src', 'intl');
-
   try {
     const content = JSON.parse(_fs.default.readFileSync(_path.default.resolve(intlDir, 'en_US.json')));
-
     if (!(content.zimlet?.label && content.zimlet?.description)) {
       throw new Error('label or description not found');
     }
-
     return {
       label: content.zimlet.label,
       description: content.zimlet.description
@@ -141,24 +121,20 @@ function getZimletLabelDescription() {
 		} \nAs a fallback we are using strings from package.json which is deprecated.\n`);
     return null;
   }
-} // Add properties file for description and label
-// As admin console requires properties file to display label and desciption
-
+}
 
+// Add properties file for description and label
+// As admin console requires properties file to display label and desciption
 function createLocalizationFiles(zimletName, label, description) {
   const cwd = process.cwd();
-
   const intlDir = _path.default.resolve(cwd, 'src', 'intl');
-
   let intlFiles;
   createPropertyFile(zimletName, label, description);
-
   try {
     intlFiles = _fs.default.readdirSync(intlDir);
   } catch (err) {
     console.error(`Failed to read ${intlDir}: ${err}`, 1);
   }
-
   intlFiles.filter(file => file.match(/\.json$/) && !file.includes('en_US')).forEach(intl => {
     try {
       const content = JSON.parse(_fs.default.readFileSync(_path.default.resolve(intlDir, intl)));
@@ -171,33 +147,26 @@ function createLocalizationFiles(zimletName, label, description) {
     }
   });
 }
-
 function createPropertyFile(fileName, label, description) {
   const builddir = _path.default.resolve(process.cwd(), 'build');
-
   const propertiesFile = `${fileName}.properties`;
   let zimletProperties = '\n';
   zimletProperties += `label = ${label}\n`;
   zimletProperties += `description = ${description}\n`;
-
   try {
     _fs.default.writeFileSync(_path.default.resolve(builddir, propertiesFile), zimletProperties);
   } catch (err) {
     return (0, _util.error)(`Failed to write properties file: ${err}`, 1);
   }
 }
-
 function getUnicode(txt) {
   let hex = '';
   if (txt.length === 0) return;
-
   for (let i = 0; i < txt.length; i++) {
     const h = txt.codePointAt(i).toString(16);
     hex += '\\u' + h.padStart(4, 0);
     if (h.length > 4) i++;
   }
-
   return hex;
 }
-
 module.exports = exports.default;

package/dist/entry.js

@@ -14,9 +14,10 @@
         components,
         store,
         meta
-      } = context; // Add shims to the global scope to expose dependencies to Zimlets
-      // Shimmed dependencies include preact, preact-router, react-apollo
+      } = context;
 
+      // Add shims to the global scope to expose dependencies to Zimlets
+      // Shimmed dependencies include preact, preact-router, react-apollo
       global.shims = shims;
       global.zimbra = zimbra;
       global.config = config;
@@ -25,19 +26,16 @@
       global.store = store;
       global.ZIMLET_STYLES = [];
       global.meta = meta;
-
       let entry = require('zimlet-cli-entrypoint');
+      let r = entry && entry.default || entry;
 
-      let r = entry && entry.default || entry; // If export is a factory, pass it context. Otherwise it's a singleton.
-
+      // If export is a factory, pass it context. Otherwise it's a singleton.
       let instance = typeof r === 'function' ? r(context) : r;
       context.styles.set(global.ZIMLET_STYLES.join('\n'));
       return instance;
     });
   }
-
   init();
-
   if (process.env.NODE_ENV === 'development' && module.hot) {
     module.hot.accept('zimlet-cli-entrypoint', init);
   }