@hubspot/cli 3.0.10-beta.6 → 3.0.10

package/README.md

@@ -1,6 +1,6 @@
 # @hubspot/cli
 
-Provides an `hs` command for interacting with the HubSpot. [Learn more about building on HubSpot](https://developers.hubspot.com).
+Provides an `hs` command for interacting with HubSpot. [Learn more about building on HubSpot](https://developers.hubspot.com).
 
 ## Getting started
 
@@ -160,3 +160,9 @@ portals:
     authType: apikey
     apiKey: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 ```
+### Exit Codes
+
+The CLI will exit with one of the following exit codes:
+- `0`: A successful run
+- `1`: There was a config problem or an internal error
+- `2`: There are warnings or validation issues

package/bin/cli.js

@@ -10,7 +10,6 @@ const { setLogLevel, getCommandName } = require('../lib/commonOpts');
 const { trackHelpUsage } = require('../lib/usageTracking');
 const pkg = require('../package.json');
 
-const appCommand = require('../commands/app');
 const removeCommand = require('../commands/remove');
 const initCommand = require('../commands/init');
 const logsCommand = require('../commands/logs');
@@ -33,6 +32,7 @@ const themeCommand = require('../commands/theme');
 const configCommand = require('../commands/config');
 const accountsCommand = require('../commands/accounts');
 const sandboxesCommand = require('../commands/sandbox');
+const { EXIT_CODES } = require('../lib/enums/exitCodes');
 
 const notifier = updateNotifier({ pkg: { ...pkg, name: '@hubspot/cli' } });
 
@@ -63,9 +63,9 @@ const argv = yargs
 
     if (msg === null) {
       yargs.showHelp();
-      process.exit(0);
+      process.exit(EXIT_CODES.SUCCESS);
     } else {
-      process.exit(1);
+      process.exit(EXIT_CODES.ERROR);
     }
   })
   .option('debug', {
@@ -74,7 +74,6 @@ const argv = yargs
     describe: 'set log level to debug',
     type: 'boolean',
   })
-  .command(appCommand)
   .command(authCommand)
   .command(initCommand)
   .command(logsCommand)

package/commands/accounts/list.js

@@ -1,10 +1,5 @@
 const { logger } = require('@hubspot/cli-lib/logger');
 const { getConfig, getConfigPath } = require('@hubspot/cli-lib/lib/config');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const {
   getTableContents,
   getTableHeader,
@@ -14,29 +9,18 @@ const {
   addConfigOptions,
   addAccountOptions,
   getAccountId,
-  setLogLevel,
 } = require('../../lib/commonOpts');
 const { trackCommandUsage } = require('../../lib/usageTracking');
-const { logDebugInfo } = require('../../lib/debugInfo');
-const { validateAccount } = require('../../lib/validation');
-
-const loadAndValidateOptions = async options => {
-  setLogLevel(options);
-  logDebugInfo(options);
-  const { config: configPath } = options;
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
+const { loadAndValidateOptions } = require('../../lib/validation');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
-};
+const i18nKey = 'cli.commands.accounts.subcommands.list';
 
 exports.command = 'list';
-exports.describe = 'List names of accounts defined in config';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const accountId = getAccountId(options);
 
@@ -47,11 +31,19 @@ exports.handler = async options => {
   const portalData = config.portals.map(portal => {
     return [portal.name, portal.portalId, portal.authType];
   });
-  portalData.unshift(getTableHeader(['Name', 'Account ID', 'Auth Type']));
-
-  logger.log(`Config path: ${configPath}`);
-  logger.log('Default account: ', config.defaultPortal);
-  logger.log('Accounts:');
+  portalData.unshift(
+    getTableHeader([
+      i18n(`${i18nKey}.labels.name`),
+      i18n(`${i18nKey}.labels.accountId`),
+      i18n(`${i18nKey}.labels.authType`),
+    ])
+  );
+
+  logger.log(i18n(`${i18nKey}.configPath`, { configPath }));
+  logger.log(
+    i18n(`${i18nKey}.defaultAccount`, { account: config.defaultPortal })
+  );
+  logger.log(i18n(`${i18nKey}.accounts`));
   logger.log(getTableContents(portalData, { border: { bodyLeft: '  ' } }));
 };
 

package/commands/accounts/rename.js

@@ -1,35 +1,19 @@
 const { logger } = require('@hubspot/cli-lib/logger');
 const { renameAccount } = require('@hubspot/cli-lib/lib/config');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 
 const {
   addConfigOptions,
   addAccountOptions,
   getAccountId,
-  setLogLevel,
 } = require('../../lib/commonOpts');
 const { trackCommandUsage } = require('../../lib/usageTracking');
-const { logDebugInfo } = require('../../lib/debugInfo');
-const { validateAccount } = require('../../lib/validation');
-
-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 { loadAndValidateOptions } = require('../../lib/validation');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.accounts.subcommands.rename';
 
 exports.command = 'rename <accountName> <newName>';
-exports.describe = 'Rename account in config';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
   loadAndValidateOptions(options);
@@ -41,7 +25,12 @@ exports.handler = async options => {
 
   await renameAccount(accountName, newName);
 
-  return logger.log(`Account ${accountName} renamed to ${newName}`);
+  return logger.log(
+    i18n(`${i18nKey}.success.renamed`, {
+      name: accountName,
+      newName,
+    })
+  );
 };
 
 exports.builder = yargs => {
@@ -49,11 +38,11 @@ exports.builder = yargs => {
   addAccountOptions(yargs, true);
 
   yargs.positional('accountName', {
-    describe: 'Name of account to be renamed.',
+    describe: i18n(`${i18nKey}.positionals.accountName.describe`),
     type: 'string',
   });
   yargs.positional('newName', {
-    describe: 'New name for account.',
+    describe: i18n(`${i18nKey}.positionals.newName.describe`),
     type: 'string',
   });
 

package/commands/accounts.js

@@ -1,9 +1,12 @@
 const { addConfigOptions, addAccountOptions } = require('../lib/commonOpts');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
 const list = require('./accounts/list');
 const rename = require('./accounts/rename');
 
+const i18nKey = 'cli.commands.accounts';
+
 exports.command = 'accounts';
-exports.describe = 'Commands for working with accounts';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.builder = yargs => {
   addConfigOptions(yargs, true);

package/commands/auth.js

@@ -7,6 +7,7 @@ const {
   ENVIRONMENTS,
   DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME,
 } = require('@hubspot/cli-lib/lib/constants');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
 const {
   updateConfigWithPersonalAccessKey,
 } = require('@hubspot/cli-lib/personalAccessKey');
@@ -17,13 +18,13 @@ const {
   getConfigPath,
 } = require('@hubspot/cli-lib/lib/config');
 const { commaSeparatedValues } = require('@hubspot/cli-lib/lib/text');
+const { promptUser } = require('../lib/prompts/promptUtils');
 const {
-  promptUser,
   personalAccessKeyPrompt,
   OAUTH_FLOW,
   API_KEY_FLOW,
   ACCOUNT_NAME,
-} = require('../lib/prompts');
+} = require('../lib/prompts/personalAccessKeyPrompt');
 const {
   addConfigOptions,
   setLogLevel,
@@ -32,6 +33,9 @@ const {
 const { logDebugInfo } = require('../lib/debugInfo');
 const { trackCommandUsage } = require('../lib/usageTracking');
 const { authenticateWithOauth } = require('../lib/oauth');
+const { EXIT_CODES } = require('../lib/enums/exitCodes');
+
+const i18nKey = 'cli.commands.auth';
 
 const ALLOWED_AUTH_METHODS = [
   OAUTH_AUTH_METHOD.value,
@@ -52,7 +56,9 @@ const promptForAccountNameIfNotSet = async updatedConfig => {
         validName = promptAnswer.name;
       } else {
         logger.log(
-          `Account name "${promptAnswer.name}" already exists, please enter a different name.`
+          i18n(`${i18nKey}.errors.accountNameExists`, {
+            name: promptAnswer.name,
+          })
         );
       }
     }
@@ -61,7 +67,9 @@ const promptForAccountNameIfNotSet = async updatedConfig => {
 };
 
 exports.command = 'auth [type]';
-exports.describe = `Configure authentication for a HubSpot account. Supported authentication protocols are ${SUPPORTED_AUTHENTICATION_PROTOCOLS_TEXT}.`;
+exports.describe = i18n(`${i18nKey}.describe`, {
+  supportedProtocols: SUPPORTED_AUTHENTICATION_PROTOCOLS_TEXT,
+});
 
 exports.handler = async options => {
   const { type, config: configPath, qa } = options;
@@ -71,15 +79,13 @@ exports.handler = async options => {
   logDebugInfo(options);
 
   if (!getConfigPath()) {
-    logger.error(
-      'No config file was found. To create a new config file, use the "hs init" command.'
-    );
-    process.exit(1);
+    logger.error(i18n(`${i18nKey}.errors.noConfigFileFound`));
+    process.exit(EXIT_CODES.ERROR);
   }
 
   const env = qa ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD;
   loadConfig(configPath);
-  checkAndWarnGitInclusion();
+  checkAndWarnGitInclusion(getConfigPath());
 
   trackCommandUsage('auth');
 
@@ -100,7 +106,10 @@ exports.handler = async options => {
       writeConfig();
 
       logger.success(
-        `${DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME} updated with ${API_KEY_AUTH_METHOD.name}.`
+        i18n(`${i18nKey}.success.configFileUpdated`, {
+          configFilename: DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME,
+          authMethod: API_KEY_AUTH_METHOD.name,
+        })
       );
 
       break;
@@ -116,7 +125,7 @@ exports.handler = async options => {
       updatedConfig = await updateConfigWithPersonalAccessKey(configData);
 
       if (!updatedConfig) {
-        process.exit();
+        process.exit(EXIT_CODES.SUCCESS);
       }
 
       validName = await promptForAccountNameIfNotSet(updatedConfig);
@@ -130,21 +139,27 @@ exports.handler = async options => {
       writeConfig();
 
       logger.success(
-        `${DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME} updated with ${PERSONAL_ACCESS_KEY_AUTH_METHOD.name}.`
+        i18n(`${i18nKey}.success.configFileUpdated`, {
+          configFilename: DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME,
+          authMethod: PERSONAL_ACCESS_KEY_AUTH_METHOD.name,
+        })
       );
       break;
     default:
       logger.error(
-        `Unsupported auth type: ${type}. The only supported authentication protocols are ${SUPPORTED_AUTHENTICATION_PROTOCOLS_TEXT}.`
+        i18n(`${i18nKey}.errors.unsupportedAuthType`, {
+          supportedProtocols: SUPPORTED_AUTHENTICATION_PROTOCOLS_TEXT,
+          type,
+        })
       );
       break;
   }
-  process.exit();
+  process.exit(EXIT_CODES.SUCCESS);
 };
 
 exports.builder = yargs => {
   yargs.positional('type', {
-    describe: 'Authentication mechanism',
+    describe: i18n(`${i18nKey}.positionals.type.describe`),
     type: 'string',
     choices: [
       `${PERSONAL_ACCESS_KEY_AUTH_METHOD.value}`,
@@ -152,7 +167,9 @@ exports.builder = yargs => {
       `${API_KEY_AUTH_METHOD.value}`,
     ],
     default: PERSONAL_ACCESS_KEY_AUTH_METHOD.value,
-    defaultDescription: `"${PERSONAL_ACCESS_KEY_AUTH_METHOD.value}": \nAn access token tied to a specific user account. This is the recommended way of authenticating with local development tools.`,
+    defaultDescription: i18n(`${i18nKey}.positionals.type.defaultDescription`, {
+      authMethod: PERSONAL_ACCESS_KEY_AUTH_METHOD.value,
+    }),
   });
 
   addConfigOptions(yargs, true);

package/commands/config/set/allowUsageTracking.js

@@ -1,43 +1,32 @@
 const { logger } = require('@hubspot/cli-lib/logger');
 const { updateAllowUsageTracking } = require('@hubspot/cli-lib/lib/config');
-const inquirer = require('inquirer');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 
-const { getAccountId, setLogLevel } = require('../../../lib/commonOpts');
+const { getAccountId } = require('../../../lib/commonOpts');
 const { trackCommandUsage } = require('../../../lib/usageTracking');
-const { logDebugInfo } = require('../../../lib/debugInfo');
-const { validateAccount } = require('../../../lib/validation');
+const { promptUser } = require('../../../lib/prompts/promptUtils');
+const { loadAndValidateOptions } = require('../../../lib/validation');
+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.config.subcommands.set.subcommands.allowUsageTracking';
 
 const enableOrDisableUsageTracking = async () => {
-  const { isEnabled } = await inquirer.prompt([
+  const { isEnabled } = await promptUser([
     {
       type: 'list',
       look: false,
       name: 'isEnabled',
       pageSize: 20,
-      message: 'Choose to enable or disable usage tracking',
+      message: i18n(`${i18nKey}.promptMessage`),
       choices: [
         {
-          name: 'Enabled',
+          name: i18n(`${i18nKey}.labels.enabled`),
           value: true,
         },
-        { name: 'Disabled', value: false },
+        {
+          name: i18n(`${i18nKey}.labels.disabled`),
+          value: false,
+        },
       ],
       default: true,
     },
@@ -47,10 +36,10 @@ const enableOrDisableUsageTracking = async () => {
 };
 
 exports.command = 'allow-usage-tracking';
-exports.describe = 'Enable or disable usage tracking';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const accountId = getAccountId(options);
 
@@ -59,17 +48,12 @@ exports.handler = async options => {
   const isEnabled = await enableOrDisableUsageTracking();
   updateAllowUsageTracking(isEnabled);
 
-  return logger.log(
-    `Usage tracking is now ${isEnabled ? 'enabled' : 'disabled'}.`
-  );
+  return logger.log(i18n(`${i18nKey}.${isEnabled ? 'enabled' : 'disabled'}`));
 };
 
 exports.builder = yargs => {
   yargs.example([
-    [
-      '$0 config set allow-usage-tracking',
-      'Select to enable or disable usage tracking from a list',
-    ],
+    ['$0 config set allow-usage-tracking', i18n(`${i18nKey}.examples.default`)],
   ]);
 
   return yargs;

package/commands/config/set/defaultAccount.js

@@ -4,38 +4,24 @@ const {
   getConfigPath,
   updateDefaultAccount,
 } = require('@hubspot/cli-lib/lib/config');
-const inquirer = require('inquirer');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
+const { loadAndValidateOptions } = require('../../../lib/validation');
 
-const { getAccountId, setLogLevel } = require('../../../lib/commonOpts');
+const { getAccountId } = require('../../../lib/commonOpts');
 const { trackCommandUsage } = require('../../../lib/usageTracking');
-const { logDebugInfo } = require('../../../lib/debugInfo');
-const { validateAccount } = require('../../../lib/validation');
-
-const loadAndValidateOptions = async options => {
-  setLogLevel(options);
-  logDebugInfo(options);
-  const { config: configPath } = options;
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
+const { promptUser } = require('../../../lib/prompts/promptUtils');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
-};
+const i18nKey =
+  'cli.commands.config.subcommands.set.subcommands.defaultAccount';
 
 const selectAccountFromConfig = async config => {
-  const { default: selectedDefault } = await inquirer.prompt([
+  const { default: selectedDefault } = await promptUser([
     {
       type: 'list',
       look: false,
       name: 'default',
       pageSize: 20,
-      message: 'Select an account to use as the default',
+      message: i18n(`${i18nKey}.promptMessage`),
       choices: config.portals.map(p => p.name || p.portalId),
       default: config.defaultPortal,
     },
@@ -45,10 +31,10 @@ const selectAccountFromConfig = async config => {
 };
 
 exports.command = 'default-account [newDefault]';
-exports.describe = 'Change default account used in config';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const accountId = getAccountId(options);
   const config = getConfig();
@@ -68,35 +54,39 @@ exports.handler = async options => {
   ) {
     newDefault = specifiedNewDefault;
   } else {
-    logger.info(
-      `The account ${specifiedNewDefault} was not found in ${configPath}.`
+    logger.error(
+      i18n(`${i18nKey}.errors.accountNotFound`, {
+        specifiedAccount: specifiedNewDefault,
+        configPath,
+      })
     );
     newDefault = await selectAccountFromConfig(config);
   }
 
   updateDefaultAccount(newDefault);
 
-  return logger.log(`Default account updated to: ${newDefault}`);
+  return logger.success(
+    i18n(`${i18nKey}.success.defaultAccountUpdated`, {
+      accountName: newDefault,
+    })
+  );
 };
 
 exports.builder = yargs => {
   yargs.positional('newDefault', {
-    describe: 'Account name or id to use as the default',
+    describe: i18n(`${i18nKey}.positionals.newDefault.describe`),
     type: 'string',
   });
 
   yargs.example([
-    [
-      '$0 config set default-account',
-      'Select account to use as the default from a list',
-    ],
+    ['$0 config set default-account', i18n(`${i18nKey}.examples.default`)],
     [
       '$0 config set default-account MyAccount',
-      'Set the default account to the account in the config with name equal to "MyAccount"',
+      i18n(`${i18nKey}.examples.nameBased`),
     ],
     [
       '$0 config set default-account 1234567',
-      'Set the default account to the account in the config with accountId equal to "1234567"',
+      i18n(`${i18nKey}.examples.idBased`),
     ],
   ]);
 

package/commands/config/set/defaultMode.js

@@ -1,41 +1,26 @@
 const { logger } = require('@hubspot/cli-lib/logger');
 const { updateDefaultMode } = require('@hubspot/cli-lib/lib/config');
-const inquirer = require('inquirer');
-const {
-  Mode,
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
+const { Mode } = require('@hubspot/cli-lib');
 const { commaSeparatedValues } = require('@hubspot/cli-lib/lib/text');
 
-const { getAccountId, setLogLevel } = require('../../../lib/commonOpts');
+const { getAccountId } = require('../../../lib/commonOpts');
 const { trackCommandUsage } = require('../../../lib/usageTracking');
-const { logDebugInfo } = require('../../../lib/debugInfo');
-const { validateAccount } = require('../../../lib/validation');
+const { promptUser } = require('../../../lib/prompts/promptUtils');
+const { loadAndValidateOptions } = require('../../../lib/validation');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
-const ALL_MODES = Object.values(Mode);
-
-const loadAndValidateOptions = async options => {
-  setLogLevel(options);
-  logDebugInfo(options);
-  const { config: configPath } = options;
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
+const i18nKey = 'cli.commands.config.subcommands.set.subcommands.defaultMode';
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
-};
+const ALL_MODES = Object.values(Mode);
 
 const selectMode = async () => {
-  const { mode } = await inquirer.prompt([
+  const { mode } = await promptUser([
     {
       type: 'list',
       look: false,
       name: 'mode',
       pageSize: 20,
-      message: 'Select a mode to use as the default',
+      message: i18n(`${i18nKey}.promptMessage`),
       choices: ALL_MODES,
       default: Mode.publish,
     },
@@ -45,10 +30,10 @@ const selectMode = async () => {
 };
 
 exports.command = 'default-mode [newDefault]';
-exports.describe = 'Change default mode used in config';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const accountId = getAccountId(options);
   const { newMode: specifiedNewDefault } = options;
@@ -64,38 +49,34 @@ exports.handler = async options => {
   ) {
     newDefault = specifiedNewDefault;
   } else {
-    logger.info(
-      `The mode ${specifiedNewDefault} is invalid. Valid values are ${commaSeparatedValues(
-        ALL_MODES
-      )}.`
+    logger.error(
+      i18n(`${i18nKey}.errors.invalidMode`, {
+        mode: specifiedNewDefault,
+        validModes: commaSeparatedValues(ALL_MODES),
+      })
     );
     newDefault = await selectMode();
   }
 
   updateDefaultMode(newDefault);
 
-  return logger.log(`Default mode updated to: ${newDefault}`);
+  return logger.success(
+    i18n(`${i18nKey}.success.modeUpdated`, {
+      mode: newDefault,
+    })
+  );
 };
 
 exports.builder = yargs => {
   yargs.positional('newMode', {
-    describe: 'Mode to use as the default',
+    describe: i18n(`${i18nKey}.positionals.newMode.describe`),
     type: 'string',
   });
 
   yargs.example([
-    [
-      '$0 config set default-mode',
-      'Select mode to use as the default from a list',
-    ],
-    [
-      '$0 config set default-mode publish',
-      'Set the default mode in the config to "publish"',
-    ],
-    [
-      '$0 config set default-mode draft',
-      'Set the default mode in the config to "draft"',
-    ],
+    ['$0 config set default-mode', i18n(`${i18nKey}.examples.default`)],
+    ['$0 config set default-mode publish', i18n(`${i18nKey}.examples.publish`)],
+    ['$0 config set default-mode draft', i18n(`${i18nKey}.examples.draft`)],
   ]);
 
   return yargs;