@hubspot/cli 3.0.10-beta.9 → 3.0.10

package/commands/watch.js

@@ -1,12 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 
-const {
-  watch,
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
+const { watch } = require('@hubspot/cli-lib');
 const { getCwd } = require('@hubspot/cli-lib/path');
 const { logger } = require('@hubspot/cli-lib/logger');
 
@@ -15,42 +10,26 @@ const {
   addAccountOptions,
   addModeOptions,
   addUseEnvironmentOptions,
-  setLogLevel,
   getAccountId,
   getMode,
 } = require('../lib/commonOpts');
-const { logDebugInfo } = require('../lib/debugInfo');
-const { validateAccount, validateMode } = require('../lib/validation');
+const { validateMode, loadAndValidateOptions } = require('../lib/validation');
 const { trackCommandUsage } = require('../lib/usageTracking');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.watch';
+const { EXIT_CODES } = require('../lib/enums/exitCodes');
 
 exports.command = 'watch <src> <dest>';
-exports.describe =
-  'Watch a directory on your computer for changes and upload the changed files to the HubSpot CMS';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  const {
-    src,
-    dest,
-    config: configPath,
-    remove,
-    initialUpload,
-    disableInitial,
-    notify,
-  } = options;
-
-  setLogLevel(options);
-  logDebugInfo(options);
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
-
-  if (
-    !(
-      validateConfig() &&
-      (await validateAccount(options)) &&
-      validateMode(options)
-    )
-  ) {
-    process.exit(1);
+  const { src, dest, remove, initialUpload, disableInitial, notify } = options;
+
+  await loadAndValidateOptions(options);
+
+  if (!validateMode(options)) {
+    process.exit(EXIT_CODES.ERROR);
   }
 
   const accountId = getAccountId(options);
@@ -60,32 +39,34 @@ exports.handler = async options => {
   try {
     const stats = fs.statSync(absoluteSrcPath);
     if (!stats.isDirectory()) {
-      logger.log(`The "${src}" is not a path to a directory`);
+      logger.log(
+        i18n(`${i18nKey}.errors.invalidPath`, {
+          path: src,
+        })
+      );
       return;
     }
   } catch (e) {
-    logger.log(`The "${src}" is not a path to a directory`);
+    logger.log(
+      i18n(`${i18nKey}.errors.invalidPath`, {
+        path: src,
+      })
+    );
     return;
   }
 
   if (!dest) {
-    logger.log('A destination directory needs to be passed');
+    logger.log(i18n(`${i18nKey}.errors.destinationRequired`));
     return;
   }
 
   if (disableInitial) {
-    logger.info(
-      'Passing the "--disable-initial" option is no longer necessary. Running "hs watch" no longer uploads the watched directory by default.'
-    );
+    logger.info(i18n(`${i18nKey}.warnings.disableInitial`));
   } else {
-    logger.info(
-      `The "watch" command no longer uploads the watched directory when started. The directory "${src}" was not uploaded.`
-    );
+    logger.info(i18n(`${i18nKey}.warnings.notUploaded`, { path: src }));
 
     if (!initialUpload) {
-      logger.info(
-        'To upload the directory run "hs upload" beforehand or add the "--initial-upload" option when running "hs watch".'
-      );
+      logger.info(i18n(`${i18nKey}.warnings.initialUpload`));
     }
   }
 
@@ -105,35 +86,32 @@ exports.builder = yargs => {
   addUseEnvironmentOptions(yargs, true);
 
   yargs.positional('src', {
-    describe:
-      'Path to the local directory your files are in, relative to your current working directory',
+    describe: i18n(`${i18nKey}.positionals.src.describe`),
     type: 'string',
   });
   yargs.positional('dest', {
-    describe: 'Path in HubSpot Design Tools. Can be a net new path',
+    describe: i18n(`${i18nKey}.positionals.dest.describe`),
     type: 'string',
   });
   yargs.option('remove', {
     alias: 'r',
-    describe:
-      'Will cause watch to delete files in your HubSpot account that are not found locally.',
+    describe: i18n(`${i18nKey}.options.remove.describe`),
     type: 'boolean',
   });
   yargs.option('initial-upload', {
     alias: 'i',
-    describe: 'Upload directory before watching for updates',
+    describe: i18n(`${i18nKey}.options.initialUpload.describe`),
     type: 'boolean',
   });
   yargs.option('disable-initial', {
     alias: 'd',
-    describe: 'Disable the initial upload when watching a directory (default)',
+    describe: i18n(`${i18nKey}.options.disableInitial.describe`),
     type: 'boolean',
     hidden: true,
   });
   yargs.option('notify', {
     alias: 'n',
-    describe:
-      'Log to specified file when a watch task is triggered and after workers have gone idle. Ex. --notify path/to/file',
+    describe: i18n(`${i18nKey}.options.notify.describe`),
     type: 'string',
     requiresArg: true,
   });

package/lib/commonOpts.js

@@ -6,48 +6,51 @@ const {
   DEFAULT_MODE,
   Mode,
 } = require('@hubspot/cli-lib');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.lib.commonOpts';
 const { LOG_LEVEL } = Logger;
 
 const addAccountOptions = program =>
   program.option('portal', {
     alias: ['p', 'account', 'a'],
-    describe: 'HubSpot portal id or name from config',
+    describe: i18n(`${i18nKey}.options.portal.describe`),
     type: 'string',
   });
 
 const addConfigOptions = yargs =>
   yargs.option('config', {
     alias: 'c',
-    describe: 'path to a config file',
+    describe: i18n(`${i18nKey}.options.config.describe`),
     type: 'string',
   });
 
 const addOverwriteOptions = yargs =>
   yargs.option('overwrite', {
     alias: 'o',
-    describe: 'overwrite existing files',
+    describe: i18n(`${i18nKey}.options.overwrite.describe`),
     type: 'boolean',
     default: false,
   });
 
 const addModeOptions = (yargs, { read, write }) => {
   const modes = `<${Object.values(Mode).join(' | ')}>`;
-  const help = read
-    ? `read from ${modes}`
-    : write
-    ? `write to ${modes}`
-    : `${modes}`;
 
   return yargs.option('mode', {
     alias: 'm',
-    describe: help,
+    describe: i18n(
+      `${i18nKey}.options.modes.describe.${
+        read ? 'read' : write ? 'write' : 'default'
+      }`,
+      { modes }
+    ),
     type: 'string',
   });
 };
 
 const addTestingOptions = yargs =>
   yargs.option('qa', {
-    describe: 'run command in qa mode',
+    describe: i18n(`${i18nKey}.options.qa.describe`),
     type: 'boolean',
     default: false,
     hidden: true,
@@ -55,7 +58,7 @@ const addTestingOptions = yargs =>
 
 const addUseEnvironmentOptions = yargs =>
   yargs.option('use-env', {
-    describe: 'use environment variable config',
+    describe: i18n(`${i18nKey}.options.useEnv.describe`),
     type: 'boolean',
     default: false,
   });

package/lib/enums/exitCodes.js

@@ -0,0 +1,14 @@
+/*
+ * 0: Successful run
+ * 1: Config problem or internal error
+ * 2: Warnings or validation issues
+ */
+const EXIT_CODES = {
+  SUCCESS: 0,
+  ERROR: 1,
+  WARNING: 2,
+};
+
+module.exports = {
+  EXIT_CODES,
+};

package/lib/links.js

@@ -1,4 +1,3 @@
-const supportsHyperlinks = require('supports-hyperlinks');
 const { getEnv } = require('@hubspot/cli-lib/lib/config');
 const { ENVIRONMENTS } = require('@hubspot/cli-lib/lib/constants');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
@@ -121,18 +120,9 @@ const openLink = (accountId, shortcut) => {
   logger.success(`We opened ${match.url} in your browser`);
 };
 
-const link = (linkText, url, options = {}) => {
-  if (supportsHyperlinks.stdout) {
-    return ['\u001B]8;;', url, '\u0007', linkText, '\u001B]8;;\u0007'].join('');
-  } else {
-    return options.fallback ? `${linkText}: ${url}` : linkText;
-  }
-};
-
 module.exports = {
   getSiteLinks,
   getSiteLinksAsArray,
   logSiteLinks,
   openLink,
-  link,
 };

package/lib/projects.js

@@ -3,7 +3,6 @@ const path = require('path');
 
 const chalk = require('chalk');
 const findup = require('findup-sync');
-const { prompt } = require('inquirer');
 const Spinnies = require('spinnies');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { getEnv } = require('@hubspot/cli-lib/lib/config');
@@ -11,7 +10,6 @@ const {
   createProject: createProjectTemplate,
 } = require('@hubspot/cli-lib/projects');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
-
 const {
   ENVIRONMENTS,
   POLLING_DELAY,
@@ -30,6 +28,9 @@ const {
   ApiErrorContext,
 } = require('@hubspot/cli-lib/errorHandlers');
 const { getCwd } = require('@hubspot/cli-lib/path');
+const { promptUser } = require('./prompts/promptUtils');
+const { EXIT_CODES } = require('./enums/exitCodes');
+const { uiLine, uiAccountDescription } = require('../lib/ui');
 
 const PROJECT_STRINGS = {
   BUILD: {
@@ -39,6 +40,10 @@ const PROJECT_STRINGS = {
       } in this project ...\n`,
     SUCCESS: name => `Built ${chalk.bold(name)}`,
     FAIL: name => `Failed to build ${chalk.bold(name)}`,
+    SUBTASK_FAIL: (taskId, name) =>
+      `Build #${taskId} failed because there was a problem\nbuilding ${chalk.bold(
+        name
+      )}`,
   },
   DEPLOY: {
     INITIALIZE: (name, numOfComponents) =>
@@ -47,6 +52,10 @@ const PROJECT_STRINGS = {
       } in this project ...\n`,
     SUCCESS: name => `Deployed ${chalk.bold(name)}`,
     FAIL: name => `Failed to deploy ${chalk.bold(name)}`,
+    SUBTASK_FAIL: (taskId, name) =>
+      `Deploy for build #${taskId} failed because there was a\nproblem deploying ${chalk.bold(
+        name
+      )}`,
   },
 };
 
@@ -60,7 +69,12 @@ const writeProjectConfig = (configPath, config) => {
   }
 };
 
-const getProjectConfig = async _dir => {
+const getIsInProject = async _dir => {
+  const configPath = await getProjectConfigPath(_dir);
+  return !!configPath;
+};
+
+const getProjectConfigPath = async _dir => {
   const projectDir = _dir ? path.resolve(getCwd(), _dir) : getCwd();
 
   const configPath = findup(PROJECT_CONFIG_FILE, {
@@ -68,6 +82,11 @@ const getProjectConfig = async _dir => {
     nocase: true,
   });
 
+  return configPath;
+};
+
+const getProjectConfig = async _dir => {
+  const configPath = await getProjectConfigPath(_dir);
   if (!configPath) {
     return { projectConfig: null, projectDir: null };
   }
@@ -94,7 +113,7 @@ const createProjectConfig = async (projectPath, projectName, template) => {
         : `Found an existing project definition in ${projectDir}.`
     );
 
-    const { shouldContinue } = await prompt([
+    const { shouldContinue } = await promptUser([
       {
         name: 'shouldContinue',
         message: () => {
@@ -147,21 +166,21 @@ const validateProjectConfig = (projectConfig, projectDir) => {
     logger.error(
       `Project config not found. Try running 'hs project create' first.`
     );
-    process.exit(1);
+    process.exit(EXIT_CODES.ERROR);
   }
 
   if (!projectConfig.name || !projectConfig.srcDir) {
     logger.error(
       'Project config is missing required fields. Try running `hs project create`.'
     );
-    process.exit(1);
+    process.exit(EXIT_CODES.ERROR);
   }
 
   if (!fs.existsSync(path.resolve(projectDir, projectConfig.srcDir))) {
     logger.error(
       `Project source directory '${projectConfig.srcDir}' could not be found in ${projectDir}.`
     );
-    process.exit(1);
+    process.exit(EXIT_CODES.ERROR);
   }
 };
 
@@ -173,10 +192,12 @@ const ensureProjectExists = async (accountId, projectName, forceCreate) => {
       let shouldCreateProject = forceCreate;
 
       if (!shouldCreateProject) {
-        const promptResult = await prompt([
+        const promptResult = await promptUser([
           {
             name: 'shouldCreateProject',
-            message: `The project ${projectName} does not exist in ${accountId}. Would you like to create it?`,
+            message: `The project ${projectName} does not exist in ${uiAccountDescription(
+              accountId
+            )}. Would you like to create it?`,
             type: 'confirm',
           },
         ]);
@@ -260,6 +281,7 @@ const makeGetTaskStatus = taskType => {
     const spinnies = new Spinnies({
       succeedColor: 'white',
       failColor: 'white',
+      failPrefix: chalk.bold('!'),
     });
 
     spinnies.add('overallTaskStatus', { text: 'Beginning' });
@@ -330,6 +352,31 @@ const makeGetTaskStatus = taskType => {
               spinnies.fail('overallTaskStatus', {
                 text: statusStrings.FAIL(taskName),
               });
+
+              const failedSubtask = subTaskStatus.filter(
+                subtask => subtask.status === 'FAILURE'
+              );
+
+              uiLine();
+              logger.log(
+                `${statusStrings.SUBTASK_FAIL(
+                  buildId || taskId,
+                  failedSubtask.length === 1
+                    ? failedSubtask[0][statusText.SUBTASK_NAME_KEY]
+                    : failedSubtask.length + ' components'
+                )}\n`
+              );
+              logger.log('See below for a summary of errors.');
+              uiLine();
+
+              failedSubtask.forEach(subTask => {
+                logger.log(
+                  `\n--- ${chalk.bold(subTask[statusText.SUBTASK_NAME_KEY])} ${
+                    statusText.STATUS_TEXT[subTask.status]
+                  } with the following error ---`
+                );
+                logger.error(subTask.errorMessage);
+              });
             }
 
             clearInterval(pollInterval);
@@ -344,6 +391,7 @@ const makeGetTaskStatus = taskType => {
 module.exports = {
   writeProjectConfig,
   getProjectConfig,
+  getIsInProject,
   createProjectConfig,
   validateProjectConfig,
   showWelcomeMessage,

package/lib/{createApiSamplePrompt.js → prompts/createApiSamplePrompt.js}

@@ -1,9 +1,12 @@
-const inquirer = require('inquirer');
+const { promptUser } = require('./promptUtils');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.lib.prompts.createApiSamplePrompt';
 
 const getSampleTypesPrompt = choices => ({
   type: 'rawlist',
   name: 'sampleType',
-  message: 'Please, select API sample app',
+  message: i18n(`${i18nKey}.selectApiSampleApp`),
   choices: choices.map(choice => ({
     name: `${choice.name} - ${choice.description}`,
     value: choice.id,
@@ -13,7 +16,7 @@ const getSampleTypesPrompt = choices => ({
       if (input.length > 0) {
         resolve(true);
       }
-      reject('Please select API sample app');
+      reject(i18n(`${i18nKey}.errors.apiSampleAppRequired`));
     });
   },
 });
@@ -21,7 +24,7 @@ const getSampleTypesPrompt = choices => ({
 const getLanguagesPrompt = choices => ({
   type: 'rawlist',
   name: 'sampleLanguage',
-  message: "Please, select sample app's language",
+  message: i18n(`${i18nKey}.selectLanguage`),
   choices: choices.map(choice => ({
     name: choice,
     value: choice,
@@ -31,7 +34,7 @@ const getLanguagesPrompt = choices => ({
       if (input.length > 0) {
         resolve(true);
       }
-      reject("Please select API sample app's language");
+      reject(i18n(`${i18nKey}.errors.languageRequired`));
     });
   },
 });
@@ -39,16 +42,12 @@ const getLanguagesPrompt = choices => ({
 const createApiSamplePrompt = async samplesConfig => {
   try {
     const { samples } = samplesConfig;
-    const sampleTypeAnswer = await inquirer.prompt(
-      getSampleTypesPrompt(samples)
-    );
+    const sampleTypeAnswer = await promptUser(getSampleTypesPrompt(samples));
     const chosenSample = samples.find(
       sample => sample.id === sampleTypeAnswer.sampleType
     );
     const { languages } = chosenSample;
-    const languagesAnswer = await inquirer.prompt(
-      getLanguagesPrompt(languages)
-    );
+    const languagesAnswer = await promptUser(getLanguagesPrompt(languages));
     return {
       ...sampleTypeAnswer,
       ...languagesAnswer,

package/lib/{createFunctionPrompt.js → prompts/createFunctionPrompt.js}

@@ -1,66 +1,72 @@
-const inquirer = require('inquirer');
+const { promptUser } = require('./promptUtils');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
-const { STRING_WITH_NO_SPACES_REGEX } = require('./regex');
+const { STRING_WITH_NO_SPACES_REGEX } = require('../regex');
+
+const i18nKey = 'cli.lib.prompts.createFunctionPrompt';
 
 const FUNCTIONS_FOLDER_PROMPT = {
   name: 'functionsFolder',
-  message: 'Name of the folder where your function will be created',
+  message: i18n(`${i18nKey}.enterFolder`),
   validate(val) {
     if (typeof val !== 'string') {
-      return 'You entered an invalid name. Please try again.';
+      return i18n(`${i18nKey}.errors.invalid`);
     } else if (!val.length) {
-      return 'The name may not be blank. Please try again.';
+      return i18n(`${i18nKey}.errors.blank`);
     } else if (!STRING_WITH_NO_SPACES_REGEX.test(val)) {
-      return 'The name may not contain spaces. Please try again.';
+      return i18n(`${i18nKey}.errors.space`);
     }
     return true;
   },
 };
-const ENDPOINT_PATH_PROMPT = {
-  name: 'endpointPath',
-  message: 'Path portion of the URL created for the function',
+
+const FUNCTION_FILENAME_PROMPT = {
+  name: 'filename',
+  message: i18n(`${i18nKey}.enterFilename`),
   validate(val) {
     if (typeof val !== 'string') {
-      return 'You entered an invalid name. Please try again.';
+      return i18n(`${i18nKey}.errors.invalid`);
     } else if (!val.length) {
-      return 'The name may not be blank. Please try again.';
+      return i18n(`${i18nKey}.errors.blank`);
     } else if (!STRING_WITH_NO_SPACES_REGEX.test(val)) {
-      return 'The name may not contain spaces. Please try again.';
+      return i18n(`${i18nKey}.errors.space`);
     }
     return true;
   },
 };
+
 const ENDPOINT_METHOD_PROMPT = {
   type: 'list',
   name: 'endpointMethod',
-  message: 'Select the HTTP method for the endpoint',
+  message: i18n(`${i18nKey}.selectEndpointMethod`),
   default: 'GET',
   choices: ['DELETE', 'GET', 'PATCH', 'POST', 'PUT'],
 };
-const FUNCTION_FILENAME_PROMPT = {
-  name: 'filename',
-  message: 'Name of the JavaScript file for your function',
+
+const ENDPOINT_PATH_PROMPT = {
+  name: 'endpointPath',
+  message: i18n(`${i18nKey}.enterEndpointPath`),
   validate(val) {
     if (typeof val !== 'string') {
-      return 'You entered an invalid name. Please try again.';
+      return i18n(`${i18nKey}.errors.invalid`);
     } else if (!val.length) {
-      return 'The name may not be blank. Please try again.';
+      return i18n(`${i18nKey}.errors.blank`);
     } else if (!STRING_WITH_NO_SPACES_REGEX.test(val)) {
-      return 'The name may not contain spaces. Please try again.';
+      return i18n(`${i18nKey}.errors.space`);
     }
     return true;
   },
 };
 
 function createFunctionPrompt() {
-  const prompt = inquirer.createPromptModule();
-  return prompt([
+  return promptUser([
     FUNCTIONS_FOLDER_PROMPT,
     FUNCTION_FILENAME_PROMPT,
     ENDPOINT_METHOD_PROMPT,
     ENDPOINT_PATH_PROMPT,
   ]);
 }
+
 module.exports = {
   createFunctionPrompt,
 };

package/lib/{createModulePrompt.js → prompts/createModulePrompt.js}

@@ -1,13 +1,16 @@
-const inquirer = require('inquirer');
+const { promptUser } = require('./promptUtils');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.lib.prompts.createModulePrompt';
 
 const MODULE_LABEL_PROMPT = {
   name: 'moduleLabel',
-  message: 'What should the module label be?',
+  message: i18n(`${i18nKey}.enterLabel`),
   validate(val) {
     if (typeof val !== 'string') {
-      return 'You entered an invalid name. Please try again.';
+      return i18n(`${i18nKey}.errors.invalidLabel`);
     } else if (!val.length) {
-      return 'The name may not be blank. Please try again.';
+      return i18n(`${i18nKey}.errors.labelRequired`);
     }
     return true;
   },
@@ -15,7 +18,7 @@ const MODULE_LABEL_PROMPT = {
 const CONTENT_TYPES_PROMPT = {
   type: 'checkbox',
   name: 'contentTypes',
-  message: 'What types of content will this module be used in?',
+  message: i18n(`${i18nKey}.selectContentType`),
   default: ['PAGE'],
   choices: [
     { name: 'Page', value: 'PAGE' },
@@ -28,7 +31,7 @@ const CONTENT_TYPES_PROMPT = {
       if (input.length > 0) {
         resolve(true);
       }
-      reject('Please select at least one content type for this module.');
+      reject(i18n(`${i18nKey}.errors.contentTypeRequired`));
     });
   },
 };
@@ -36,14 +39,14 @@ const CONTENT_TYPES_PROMPT = {
 const GLOBAL_PROMPT = {
   type: 'confirm',
   name: 'global',
-  message: 'Is this a global module?',
+  message: i18n(`${i18nKey}.confirmGlobal`),
   default: false,
 };
 
 function createModulePrompt() {
-  const prompt = inquirer.createPromptModule();
-  return prompt([MODULE_LABEL_PROMPT, CONTENT_TYPES_PROMPT, GLOBAL_PROMPT]);
+  return promptUser([MODULE_LABEL_PROMPT, CONTENT_TYPES_PROMPT, GLOBAL_PROMPT]);
 }
+
 module.exports = {
   createModulePrompt,
 };