@hubspot/cli 3.0.9 → 3.0.10-beta.11

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;

package/commands/secrets/listSecrets.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,38 @@ const {
 } = require('@hubspot/cli-lib/errorHandlers');
 const { fetchSecrets } = 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.list';
 
 exports.command = 'list';
-exports.describe = 'List all HubSpot secrets';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  setLogLevel(options);
-  logDebugInfo(options);
-  const { config: configPath } = options;
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
+  await loadAndValidateOptions(options);
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
   const accountId = getAccountId(options);
   trackCommandUsage('secrets-list', {}, accountId);
 
   try {
     const { results } = await fetchSecrets(accountId);
-    const groupLabel = `Secrets for account ${accountId}:`;
+    const groupLabel = i18n(`${i18nKey}.groupLabel`, {
+      accountId,
+    });
     logger.group(groupLabel);
     results.forEach(secret => logger.log(secret));
     logger.groupEnd(groupLabel);
   } catch (e) {
-    logger.error('The secrets could not be listed');
+    logger.error(i18n(`${i18nKey}.errors.list`));
     await logServerlessFunctionApiErrorInstance(
       accountId,
       e,

package/commands/secrets/updateSecret.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 { updateSecret } = 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 { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.secrets.subcommands.update';
 
 exports.command = 'update <name>';
-exports.describe = 'Update an existing HubSpot secret';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  const { name: secretName, config: configPath } = 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-update', {}, accountId);
 
@@ -44,11 +34,18 @@ exports.handler = async options => {
     const { secretValue } = await secretValuePrompt();
 
     await updateSecret(accountId, secretName, secretValue);
-    logger.log(
-      `The secret "${secretName}" was updated in the HubSpot account: ${accountId}`
+    logger.success(
+      i18n(`${i18nKey}.success.update`, {
+        accountId,
+        secretName,
+      })
     );
   } catch (e) {
-    logger.error(`The secret "${secretName}" was not updated`);
+    logger.error(
+      i18n(`${i18nKey}.errors.update`, {
+        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 to be updated',
+    describe: i18n(`${i18nKey}.positionals.name.describe`),
     type: 'string',
   });
   return yargs;

package/commands/secrets.js

@@ -4,9 +4,12 @@ const addSecretCommand = require('./secrets/addSecret');
 const listSecretsCommand = require('./secrets/listSecrets');
 const deleteSecretCommand = require('./secrets/deleteSecret');
 const updateSecretCommand = require('./secrets/updateSecret');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.secrets';
 
 exports.command = 'secrets';
-exports.describe = 'Manage HubSpot secrets';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.builder = yargs => {
   addConfigOptions(yargs, true);

package/commands/server.js

@@ -21,11 +21,15 @@ const {
   getAccountId,
 } = require('../lib/commonOpts');
 const { logDebugInfo } = require('../lib/debugInfo');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.server';
+const { EXIT_CODES } = require('../lib/enums/exitCodes');
 
 function configureServerCommand(program) {
   program
     .version(version)
-    .description('Run the CMS HubL server')
+    .description(i18n(`${i18nKey}.description`))
     .option('--serverConfig <serverConfig>')
     .option('--contextDir [contextDir]')
     .arguments('<src>')
@@ -37,13 +41,13 @@ function configureServerCommand(program) {
       checkAndWarnGitInclusion();
 
       if (!validateConfig()) {
-        process.exit(1);
+        process.exit(EXIT_CODES.ERROR);
       }
 
       const accountId = getAccountId(options);
 
       // TODO: add flag to bypass
-      logger.log(`Fetching account data for ${accountId} to update context`);
+      logger.log(i18n(`${i18nKey}.fetching`, { accountId }));
       await updateServerContext(accountId, path.join(getCwd(), contextDir));
 
       const cwd = getCwd();
@@ -55,8 +59,12 @@ function configureServerCommand(program) {
     hubspot/local-cms-server
   `;
 
-      logger.log('Starting HubSpot CMS HubL server');
-      logger.debug(`Running: ${cmd}`);
+      logger.log(i18n(`${i18nKey}.startingServer`));
+      logger.debug(
+        i18n(`${i18nKey}.runningServer`, {
+          cmd,
+        })
+      );
       shell.exec(cmd, { async: true });
     });
 

package/commands/{marketplaceValidate/validateTheme.js → theme/marketplace-validate.js}

@@ -1,11 +1,6 @@
 const fs = require('fs');
 const path = require('path');
 
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { getCwd } = require('@hubspot/cli-lib/path');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { walk } = require('@hubspot/cli-lib');
@@ -14,11 +9,9 @@ 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 {
   logValidatorResults,
@@ -26,20 +19,18 @@ const {
 const { applyValidators } = require('../../lib/validators/applyValidators');
 const MARKETPLACE_VALIDATORS = require('../../lib/validators');
 const { VALIDATION_RESULT } = require('../../lib/validators/constants');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.theme.subcommands.marketplaceValidate';
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 
 exports.command = 'marketplace-validate <src>';
-exports.describe = 'Validate a theme for the marketplace';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  const { src, config: configPath } = options;
-  setLogLevel(options);
-  logDebugInfo(options);
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
+  const { src } = options;
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
+  await loadAndValidateOptions(options);
 
   const accountId = getAccountId(options);
   const absoluteSrcPath = path.resolve(getCwd(), src);
@@ -47,16 +38,28 @@ exports.handler = async options => {
   try {
     stats = fs.statSync(absoluteSrcPath);
     if (!stats.isDirectory()) {
-      logger.error(`The path "${src}" is not a path to a folder`);
+      logger.error(
+        i18n(`${i18nKey}.errors.invalidPath`, {
+          path: src,
+        })
+      );
       return;
     }
   } catch (e) {
-    logger.error(`The path "${src}" is not a path to a folder`);
+    logger.error(
+      i18n(`${i18nKey}.errors.invalidPath`, {
+        path: src,
+      })
+    );
     return;
   }
 
   if (!options.json) {
-    logger.log(`Validating theme "${src}" \n`);
+    logger.log(
+      i18n(`${i18nKey}.logs.validatingTheme`, {
+        path: src,
+      })
+    );
   }
   trackCommandUsage('validate', {}, accountId);
 
@@ -75,7 +78,7 @@ exports.handler = async options => {
         .flat()
         .some(result => result.result === VALIDATION_RESULT.FATAL)
     ) {
-      process.exit(1);
+      process.exit(EXIT_CODES.WARNING);
     }
   });
 };
@@ -87,13 +90,12 @@ exports.builder = yargs => {
 
   yargs.options({
     json: {
-      describe: 'Output raw json data',
+      describe: i18n(`${i18nKey}.options.json.describe`),
       type: 'boolean',
     },
   });
   yargs.positional('src', {
-    describe:
-      'Path to the local theme, relative to your current working directory.',
+    describe: i18n(`${i18nKey}.positionals.src.describe`),
     type: 'string',
   });
   return yargs;

package/commands/theme.js

@@ -1,9 +1,11 @@
-const marketplaceValidate = require('./marketplaceValidate/validateTheme');
+const marketplaceValidate = require('./theme/marketplace-validate');
 const { addConfigOptions, addAccountOptions } = require('../lib/commonOpts');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.theme';
 
 exports.command = 'theme';
-exports.describe =
-  'Commands for working with themes, including marketplace validation with the marketplace-validate subcommand';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.builder = yargs => {
   addConfigOptions(yargs, true);

package/commands/upload.js

@@ -1,12 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 
-const {
-  loadConfig,
-  uploadFolder,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
+const { uploadFolder } = require('@hubspot/cli-lib');
 const { getFileMapperQueryValues } = require('@hubspot/cli-lib/fileMapper');
 const { upload } = require('@hubspot/cli-lib/api/fileMapper');
 const {
@@ -28,45 +23,39 @@ 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 { getThemePreviewUrl } = require('@hubspot/cli-lib/lib/files');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.upload';
+const { EXIT_CODES } = require('../lib/enums/exitCodes');
 
 exports.command = 'upload <src> <dest>';
-exports.describe =
-  'Upload a folder or file from your computer to the HubSpot CMS';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 const logThemePreview = (filePath, accountId) => {
   const previewUrl = getThemePreviewUrl(filePath, accountId);
   // Only log if we are actually in a theme
   if (previewUrl) {
-    logger.log(`
-      To preview this theme, visit:
-      ${previewUrl}
-      `);
+    logger.log(
+      i18n(`${i18nKey}.previewUrl`, {
+        previewUrl,
+      })
+    );
   }
 };
 
 exports.handler = async options => {
-  const { src, dest, config: configPath } = options;
-  setLogLevel(options);
-  logDebugInfo(options);
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
+  const { src, dest } = options;
 
-  if (
-    !(
-      validateConfig() &&
-      (await validateAccount(options)) &&
-      validateMode(options)
-    )
-  ) {
-    process.exit(1);
+  await loadAndValidateOptions(options);
+
+  if (!validateMode(options)) {
+    process.exit(EXIT_CODES.ERROR);
   }
 
   const accountId = getAccountId(options);
@@ -76,16 +65,24 @@ exports.handler = async options => {
   try {
     stats = fs.statSync(absoluteSrcPath);
     if (!stats.isFile() && !stats.isDirectory()) {
-      logger.error(`The path "${src}" is not a path to a file or folder`);
+      logger.error(
+        i18n(`${i18nKey}.errors.invalidPath`, {
+          path: src,
+        })
+      );
       return;
     }
   } catch (e) {
-    logger.error(`The path "${src}" is not a path to a file or folder`);
+    logger.error(
+      i18n(`${i18nKey}.errors.invalidPath`, {
+        path: src,
+      })
+    );
     return;
   }
 
   if (!dest) {
-    logger.error('A destination path needs to be passed');
+    logger.error(i18n(`${i18nKey}.errors.destinationRequired`));
     return;
   }
   const normalizedDest = convertToUnixPath(dest);
@@ -101,16 +98,24 @@ exports.handler = async options => {
 
   if (srcDestIssues.length) {
     srcDestIssues.forEach(({ message }) => logger.error(message));
-    process.exit(1);
+    process.exit(EXIT_CODES.ERROR);
   }
   if (stats.isFile()) {
     if (!isAllowedExtension(src)) {
-      logger.error(`The file "${src}" does not have a valid extension`);
+      logger.error(
+        i18n(`${i18nKey}.errors.invalidPath`, {
+          path: src,
+        })
+      );
       return;
     }
 
     if (shouldIgnoreFile(absoluteSrcPath)) {
-      logger.error(`The file "${src}" is being ignored via an .hsignore rule`);
+      logger.error(
+        i18n(`${i18nKey}.errors.fileIgnored`, {
+          path: src,
+        })
+      );
       return;
     }
 
@@ -122,15 +127,21 @@ exports.handler = async options => {
     )
       .then(() => {
         logger.success(
-          'Uploaded file from "%s" to "%s" in the Design Manager of account %s',
-          src,
-          normalizedDest,
-          accountId
+          i18n(`${i18nKey}.success.fileUploaded`, {
+            accountId,
+            dest: normalizedDest,
+            src,
+          })
         );
         logThemePreview(src, accountId);
       })
       .catch(error => {
-        logger.error('Uploading file "%s" to "%s" failed', src, normalizedDest);
+        logger.error(
+          i18n(`${i18nKey}.errors.uploadFailed`, {
+            dest: normalizedDest,
+            src,
+          })
+        );
         logApiUploadErrorInstance(
           error,
           new ApiErrorContext({
@@ -142,19 +153,30 @@ exports.handler = async options => {
       });
   } else {
     logger.log(
-      `Uploading files from "${src}" to "${dest}" in the Design Manager of account ${accountId}`
+      i18n(`${i18nKey}.uploading`, {
+        accountId,
+        dest,
+        src,
+      })
     );
     uploadFolder(accountId, absoluteSrcPath, dest, {
       mode,
     })
       .then(() => {
         logger.success(
-          `Uploading files to "${dest}" in the Design Manager is complete`
+          i18n(`${i18nKey}.success.uploadComplete`, {
+            dest,
+          })
         );
         logThemePreview(src, accountId);
       })
       .catch(error => {
-        logger.error('Uploading failed');
+        logger.error(
+          i18n(`${i18nKey}.errors.uploadFailed`, {
+            dest,
+            src,
+          })
+        );
         logErrorInstance(error, {
           accountId,
         });
@@ -169,12 +191,11 @@ exports.builder = yargs => {
   addUseEnvironmentOptions(yargs, true);
 
   yargs.positional('src', {
-    describe:
-      'Path to the local file, 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',
   });
   return yargs;