@hubspot/cli 3.0.10-beta.9 → 3.0.10

package/commands/project/upload.js

@@ -7,25 +7,19 @@ const Spinnies = require('spinnies');
 const {
   addAccountOptions,
   addConfigOptions,
-  setLogLevel,
   getAccountId,
   addUseEnvironmentOptions,
 } = require('../../lib/commonOpts');
 const { trackCommandUsage } = require('../../lib/usageTracking');
-const { logDebugInfo } = require('../../lib/debugInfo');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const {
   logApiErrorInstance,
   ApiErrorContext,
 } = require('@hubspot/cli-lib/errorHandlers');
+const { uiLine, uiAccountDescription } = require('../../lib/ui');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { uploadProject } = require('@hubspot/cli-lib/api/dfs');
 const { shouldIgnoreFile } = require('@hubspot/cli-lib/ignoreRules');
-const { validateAccount } = require('../../lib/validation');
+const { loadAndValidateOptions } = require('../../lib/validation');
 const {
   getProjectConfig,
   validateProjectConfig,
@@ -33,31 +27,25 @@ const {
   ensureProjectExists,
   pollDeployStatus,
 } = require('../../lib/projects');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
-const loadAndValidateOptions = async options => {
-  setLogLevel(options);
-  logDebugInfo(options);
-  const { config: configPath } = options;
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
-
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
-};
+const i18nKey = 'cli.commands.project.subcommands.upload';
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 
 exports.command = 'upload [path]';
-exports.describe = false;
+exports.describe = i18n(`${i18nKey}.describe`);
 
 const uploadProjectFiles = async (accountId, projectName, filePath) => {
   const spinnies = new Spinnies({
     succeedColor: 'white',
   });
+  const accountIdentifier = uiAccountDescription(accountId);
 
   spinnies.add('upload', {
-    text: `Uploading ${chalk.bold(projectName)} project files to ${chalk.bold(
-      accountId
-    )}`,
+    text: i18n(`${i18nKey}.loading.upload.add`, {
+      accountIdentifier,
+      projectName,
+    }),
   });
 
   let buildId;
@@ -68,19 +56,24 @@ const uploadProjectFiles = async (accountId, projectName, filePath) => {
     buildId = upload.buildId;
 
     spinnies.succeed('upload', {
-      text: `Uploaded ${chalk.bold(projectName)} project files to ${chalk.bold(
-        accountId
-      )}`,
+      text: i18n(`${i18nKey}.loading.upload.succeed`, {
+        accountIdentifier,
+        projectName,
+      }),
     });
 
     logger.debug(
-      `Project "${projectName}" uploaded and build #${buildId} created`
+      i18n(`${i18nKey}.debug.buildCreated`, {
+        buildId,
+        projectName,
+      })
     );
   } catch (err) {
     spinnies.fail('upload', {
-      text: `Failed to upload ${chalk.bold(
-        projectName
-      )} project files to ${chalk.bold(accountId)}`,
+      text: i18n(`${i18nKey}.loading.upload.fail`, {
+        accountIdentifier,
+        projectName,
+      }),
     });
 
     logApiErrorInstance(
@@ -90,14 +83,14 @@ const uploadProjectFiles = async (accountId, projectName, filePath) => {
         projectName,
       })
     );
-    process.exit(1);
+    process.exit(EXIT_CODES.ERROR);
   }
 
   return { buildId };
 };
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const { forceCreate, path: projectPath } = options;
   const accountId = getAccountId(options);
@@ -112,14 +105,22 @@ exports.handler = async options => {
 
   const tempFile = tmp.fileSync({ postfix: '.zip' });
 
-  logger.debug(`Compressing build files to '${tempFile.name}'`);
+  logger.debug(
+    i18n(`${i18nKey}.debug.compressing`, {
+      path: tempFile.name,
+    })
+  );
 
   const output = fs.createWriteStream(tempFile.name);
   const archive = archiver('zip');
 
   output.on('close', async function() {
-    let exitCode = 0;
-    logger.debug(`Project files compressed: ${archive.pointer()} bytes`);
+    let exitCode = EXIT_CODES.SUCCESS;
+    logger.debug(
+      i18n(`${i18nKey}.debug.compressed`, {
+        byteCount: archive.pointer(),
+      })
+    );
 
     const { buildId } = await uploadProjectFiles(
       accountId,
@@ -131,38 +132,17 @@ exports.handler = async options => {
       isAutoDeployEnabled,
       deployStatusTaskLocator,
       status,
-      subbuildStatuses,
     } = await pollBuildStatus(accountId, projectConfig.name, buildId);
 
     if (status === 'FAILURE') {
-      const failedSubbuilds = subbuildStatuses.filter(
-        subbuild => subbuild.status === 'FAILURE'
-      );
-
-      logger.log('-'.repeat(50));
-      logger.log(
-        `Build #${buildId} failed because there was a problem\nbuilding ${
-          failedSubbuilds.length === 1
-            ? failedSubbuilds[0].buildName
-            : failedSubbuilds.length + ' components'
-        }\n`
-      );
-      logger.log('See below for a summary of errors.');
-      logger.log('-'.repeat(50));
-
-      failedSubbuilds.forEach(subbuild => {
-        logger.log(
-          `\n--- ${subbuild.buildName} failed to build with the following error ---`
-        );
-        logger.error(subbuild.errorMessage);
-      });
-
-      exitCode = 1;
+      exitCode = EXIT_CODES.ERROR;
+      return;
     } else if (isAutoDeployEnabled && deployStatusTaskLocator) {
       logger.log(
-        `Build #${buildId} succeeded. ${chalk.bold(
-          'Automatically deploying'
-        )} to ${accountId}`
+        i18n(`${i18nKey}.logs.buildSucceededAutomaticallyDeploying`, {
+          accountIdentifier: uiAccountDescription(accountId),
+          buildId,
+        })
       );
       const { status } = await pollDeployStatus(
         accountId,
@@ -171,19 +151,33 @@ exports.handler = async options => {
         buildId
       );
       if (status === 'FAILURE') {
-        exitCode = 1;
+        exitCode = EXIT_CODES.ERROR;
       }
     } else {
-      logger.log('-'.repeat(50));
-      logger.log(chalk.bold(`Build #${buildId} succeeded\n`));
-      logger.log('🚀 Ready to take your project live?');
-      logger.log(`Run \`${chalk.hex('f5c26b')('hs project deploy')}\``);
-      logger.log('-'.repeat(50));
+      uiLine();
+      logger.log(
+        chalk.bold(
+          i18n(`${i18nKey}.logs.buildSucceeded`, {
+            buildId,
+          })
+        )
+      );
+      logger.log(i18n(`${i18nKey}.logs.readyToGoLive`));
+      logger.log(
+        i18n(`${i18nKey}.logs.runCommand`, {
+          command: chalk.hex('f5c26b')('hs project deploy'),
+        })
+      );
+      uiLine();
     }
 
     try {
       tempFile.removeCallback();
-      logger.debug(`Cleaned up temporary file ${tempFile.name}`);
+      logger.debug(
+        i18n(`${i18nKey}.debug.cleanedUpTempFile`, {
+          path: tempFile.name,
+        })
+      );
     } catch (e) {
       logger.error(e);
     }
@@ -208,17 +202,19 @@ exports.handler = async options => {
 
 exports.builder = yargs => {
   yargs.positional('path', {
-    describe: 'Path to a project folder',
+    describe: i18n(`${i18nKey}.positionals.path.describe`),
     type: 'string',
   });
 
   yargs.option('forceCreate', {
-    describe: 'Automatically create project if it does not exist',
+    describe: i18n(`${i18nKey}.options.forceCreate.describe`),
     type: 'boolean',
     default: false,
   });
 
-  yargs.example([['$0 project upload myProjectFolder', 'Upload a project']]);
+  yargs.example([
+    ['$0 project upload myProjectFolder', i18n(`${i18nKey}.examples.default`)],
+  ]);
 
   addConfigOptions(yargs, true);
   addAccountOptions(yargs, true);

package/commands/project/watch.js

@@ -0,0 +1,103 @@
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { createWatcher } = require('@hubspot/cli-lib/projectsWatch');
+const { cancelStagedBuild } = require('@hubspot/cli-lib/api/dfs');
+const {
+  logApiErrorInstance,
+  ApiErrorContext,
+} = require('@hubspot/cli-lib/errorHandlers');
+const { logger } = require('@hubspot/cli-lib/logger');
+const {
+  addAccountOptions,
+  addConfigOptions,
+  getAccountId,
+  addUseEnvironmentOptions,
+} = require('../../lib/commonOpts');
+const { trackCommandUsage } = require('../../lib/usageTracking');
+const {
+  getProjectConfig,
+  validateProjectConfig,
+  pollBuildStatus,
+  pollDeployStatus,
+} = require('../../lib/projects');
+const { loadAndValidateOptions } = require('../../lib/validation');
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
+
+const i18nKey = 'cli.commands.project.subcommands.watch';
+
+exports.command = 'watch [path]';
+exports.describe = i18n(`${i18nKey}.describe`);
+
+const handleBuildStatus = async (accountId, projectName, buildId) => {
+  const {
+    isAutoDeployEnabled,
+    deployStatusTaskLocator,
+  } = await pollBuildStatus(accountId, projectName, buildId);
+
+  if (isAutoDeployEnabled && deployStatusTaskLocator) {
+    await pollDeployStatus(
+      accountId,
+      projectName,
+      deployStatusTaskLocator.id,
+      buildId
+    );
+  }
+};
+
+const handleSigInt = (accountId, projectName, currentBuildId) => {
+  process.removeAllListeners('SIGINT');
+  process.on('SIGINT', async () => {
+    if (currentBuildId) {
+      try {
+        await cancelStagedBuild(accountId, projectName);
+        logger.debug(i18n(`${i18nKey}.debug.buildCancelled`));
+        process.exit(EXIT_CODES.SUCCESS);
+      } catch (err) {
+        logApiErrorInstance(
+          err,
+          new ApiErrorContext({ accountId, projectName: projectName })
+        );
+        process.exit(EXIT_CODES.ERROR);
+      }
+    } else {
+      process.exit(EXIT_CODES.SUCCESS);
+    }
+  });
+};
+
+exports.handler = async options => {
+  await loadAndValidateOptions(options);
+
+  const { path: projectPath } = options;
+  const accountId = getAccountId(options);
+
+  trackCommandUsage('project-watch', { projectPath }, accountId);
+
+  const { projectConfig, projectDir } = await getProjectConfig(projectPath);
+
+  validateProjectConfig(projectConfig, projectDir);
+
+  await createWatcher(
+    accountId,
+    projectConfig,
+    projectDir,
+    handleBuildStatus,
+    handleSigInt
+  );
+};
+
+exports.builder = yargs => {
+  yargs.positional('path', {
+    describe: i18n(`${i18nKey}.describe`),
+    type: 'string',
+  });
+
+  yargs.example([
+    ['$0 project watch myProjectFolder', i18n(`${i18nKey}.examples.default`)],
+  ]);
+
+  addConfigOptions(yargs, true);
+  addAccountOptions(yargs, true);
+  addUseEnvironmentOptions(yargs, true);
+
+  return yargs;
+};

package/commands/project.js

@@ -4,6 +4,7 @@ const create = require('./project/create');
 const upload = require('./project/upload');
 const listBuilds = require('./project/listBuilds');
 const logs = require('./project/logs');
+const watch = require('./project/watch');
 
 exports.command = 'project';
 exports.describe = false; //'Commands for working with projects';
@@ -16,6 +17,7 @@ exports.builder = yargs => {
   yargs.command(deploy).demandCommand(1, '');
   yargs.command(create).demandCommand(0, '');
   yargs.command(upload).demandCommand(0, '');
+  yargs.command(watch).demandCommand(0, '');
   yargs.command(listBuilds).demandCommand(0, '');
   yargs.command(logs).demandCommand(1, '');
 

package/commands/remove.js

@@ -1,9 +1,4 @@
 const { deleteFile } = require('@hubspot/cli-lib/api/fileMapper');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const {
   logApiErrorInstance,
@@ -14,26 +9,21 @@ const {
   addConfigOptions,
   addAccountOptions,
   addUseEnvironmentOptions,
-  setLogLevel,
   getAccountId,
 } = require('../lib/commonOpts');
-const { logDebugInfo } = require('../lib/debugInfo');
-const { validateAccount } = require('../lib/validation');
+const { loadAndValidateOptions } = require('../lib/validation');
 const { trackCommandUsage } = require('../lib/usageTracking');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.remove';
 
 exports.command = 'remove <path>';
-exports.describe = 'Delete a file or folder from HubSpot';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  setLogLevel(options);
-  logDebugInfo(options);
-  const { config: configPath, path: hsPath } = options;
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
+  const { path: hsPath } = options;
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
+  await loadAndValidateOptions(options);
 
   const accountId = getAccountId(options);
 
@@ -41,9 +31,11 @@ exports.handler = async options => {
 
   try {
     await deleteFile(accountId, hsPath);
-    logger.log(`Deleted "${hsPath}" from account ${accountId}`);
+    logger.log(i18n(`${i18nKey}.deleted`, { accountId, path: hsPath }));
   } catch (error) {
-    logger.error(`Deleting "${hsPath}" from account ${accountId} failed`);
+    logger.error(
+      i18n(`${i18nKey}.errors.deleteFailed`, { accountId, path: hsPath })
+    );
     logApiErrorInstance(
       error,
       new ApiErrorContext({
@@ -59,7 +51,7 @@ exports.builder = yargs => {
   addAccountOptions(yargs, true);
   addUseEnvironmentOptions(yargs, true);
   yargs.positional('path', {
-    describe: 'Remote hubspot path',
+    describe: i18n(`${i18nKey}.positionals.path.describe`),
     type: 'string',
   });
   return yargs;

package/commands/sandbox/create.js

@@ -9,13 +9,16 @@ const { logger } = require('@hubspot/cli-lib/logger');
 
 const { createSandbox } = require('@hubspot/cli-lib/sandboxes');
 const { loadAndValidateOptions } = require('../../lib/validation');
-const { createSandbox: prompt } = require('../../lib/prompts/sandboxes');
+const { createSandboxPrompt } = require('../../lib/prompts/sandboxesPrompt');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.sandbox.subcommands.create';
 
 exports.command = 'create [name]';
 exports.describe = false;
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const { name } = options;
   const accountId = getAccountId(options);
@@ -24,36 +27,38 @@ exports.handler = async options => {
   trackCommandUsage('sandbox-create', {}, accountId);
 
   if (!name) {
-    namePrompt = await prompt();
+    namePrompt = await createSandboxPrompt();
   }
 
   const sandboxName = name || namePrompt.name;
 
-  logger.debug(`Creating sandbox '${sandboxName}'`);
+  logger.debug(
+    i18n(`${i18nKey}.debug.creating`, {
+      name: sandboxName,
+    })
+  );
 
   return createSandbox(accountId, sandboxName).then(
     ({ name, sandboxHubId }) => {
       logger.success(
-        `Sandbox '${name}' with portalId '${sandboxHubId}' created successfully.`
-      );
-      logger.info(
-        `Run 'hs auth' to authenticate with the new sandbox account.`
+        i18n(`${i18nKey}.describe`, {
+          name,
+          sandboxHubId,
+        })
       );
+      logger.info(i18n(`${i18nKey}.info.auth`));
     }
   );
 };
 
 exports.builder = yargs => {
   yargs.positional('name', {
-    describe: 'Name to use for created sandbox',
+    describe: i18n(`${i18nKey}.positionals.name.describe`),
     type: 'string',
   });
 
   yargs.example([
-    [
-      '$0 sandbox create MySandboxAccount',
-      'Create a sandbox account named MySandboxAccount.',
-    ],
+    ['$0 sandbox create MySandboxAccount', i18n(`${i18nKey}.examples.default`)],
   ]);
 
   addConfigOptions(yargs, true);

package/commands/secrets/addSecret.js

@@ -1,8 +1,3 @@
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const {
   logServerlessFunctionApiErrorInstance,
@@ -10,33 +5,28 @@ const {
 } = require('@hubspot/cli-lib/errorHandlers');
 const { addSecret } = require('@hubspot/cli-lib/api/secrets');
 
-const { validateAccount } = require('../../lib/validation');
+const { loadAndValidateOptions } = require('../../lib/validation');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 
 const {
   addConfigOptions,
   addAccountOptions,
   addUseEnvironmentOptions,
-  setLogLevel,
   getAccountId,
 } = require('../../lib/commonOpts');
-const { logDebugInfo } = require('../../lib/debugInfo');
-const { secretValuePrompt } = require('../../lib/secretPrompt');
+const { secretValuePrompt } = require('../../lib/prompts/secretPrompt');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.secrets.subcommands.add';
 
 exports.command = 'add <name>';
-exports.describe = 'Add a HubSpot secret';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  const { config: configPath, name: secretName } = options;
+  const { name: secretName } = options;
 
-  setLogLevel(options);
-  logDebugInfo(options);
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
+  await loadAndValidateOptions(options);
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
   const accountId = getAccountId(options);
   trackCommandUsage('secrets-add', {}, accountId);
 
@@ -44,11 +34,18 @@ exports.handler = async options => {
     const { secretValue } = await secretValuePrompt();
 
     await addSecret(accountId, secretName, secretValue);
-    logger.log(
-      `The secret "${secretName}" was added to the HubSpot account: ${accountId}`
+    logger.success(
+      i18n(`${i18nKey}.success.add`, {
+        accountId,
+        secretName,
+      })
     );
   } catch (e) {
-    logger.error(`The secret "${secretName}" was not added`);
+    logger.error(
+      i18n(`${i18nKey}.errors.add`, {
+        secretName,
+      })
+    );
     await logServerlessFunctionApiErrorInstance(
       accountId,
       e,
@@ -65,7 +62,7 @@ exports.builder = yargs => {
   addAccountOptions(yargs, true);
   addUseEnvironmentOptions(yargs, true);
   yargs.positional('name', {
-    describe: 'Name of the secret',
+    describe: i18n(`${i18nKey}.positionals.name.describe`),
     type: 'string',
   });
   return yargs;

package/commands/secrets/deleteSecret.js

@@ -1,8 +1,3 @@
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const {
   logServerlessFunctionApiErrorInstance,
@@ -10,42 +5,44 @@ const {
 } = require('@hubspot/cli-lib/errorHandlers');
 const { deleteSecret } = require('@hubspot/cli-lib/api/secrets');
 
-const { validateAccount } = require('../../lib/validation');
+const { loadAndValidateOptions } = require('../../lib/validation');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 
 const {
   addConfigOptions,
   addAccountOptions,
   addUseEnvironmentOptions,
-  setLogLevel,
   getAccountId,
 } = require('../../lib/commonOpts');
-const { logDebugInfo } = require('../../lib/debugInfo');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.secrets.subcommands.delete';
 
 exports.command = 'delete <name>';
-exports.describe = 'Delete a HubSpot secret';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  const { config: configPath, name: secretName } = options;
+  const { name: secretName } = options;
 
-  setLogLevel(options);
-  logDebugInfo(options);
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
+  await loadAndValidateOptions(options);
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
   const accountId = getAccountId(options);
   trackCommandUsage('secrets-delete', {}, accountId);
 
   try {
     await deleteSecret(accountId, secretName);
-    logger.log(
-      `The secret "${secretName}" was deleted from the HubSpot account: ${accountId}`
+    logger.success(
+      i18n(`${i18nKey}.success.delete`, {
+        accountId,
+        secretName,
+      })
     );
   } catch (e) {
-    logger.error(`The secret "${secretName}" was not deleted`);
+    logger.error(
+      i18n(`${i18nKey}.errors.delete`, {
+        secretName,
+      })
+    );
     await logServerlessFunctionApiErrorInstance(
       accountId,
       e,
@@ -62,7 +59,7 @@ exports.builder = yargs => {
   addAccountOptions(yargs, true);
   addUseEnvironmentOptions(yargs, true);
   yargs.positional('name', {
-    describe: 'Name of the secret',
+    describe: i18n(`${i18nKey}.positionals.name.describe`),
     type: 'string',
   });
   return yargs;