@hubspot/cli 3.0.9 → 3.0.10-beta.11

package/commands/hubdb/delete.js

@@ -1,46 +1,45 @@
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 const { deleteTable } = require('@hubspot/cli-lib/api/hubdb');
-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.hubdb.subcommands.delete';
 
 exports.command = 'delete <tableId>';
-exports.describe = 'delete a HubDB table';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  const { config: configPath, tableId } = options;
+  const { tableId } = 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('hubdb-delete', {}, accountId);
 
   try {
     await deleteTable(accountId, tableId);
-    logger.log(`The table ${tableId} was deleted from ${accountId}`);
+    logger.success(
+      i18n(`${i18nKey}.success.delete`, {
+        accountId,
+        tableId,
+      })
+    );
   } catch (e) {
-    logger.error(`Deleting the table ${tableId} failed`);
+    logger.error(
+      i18n(`${i18nKey}.errors.delete`, {
+        tableId,
+      })
+    );
     logErrorInstance(e);
   }
 };
@@ -51,7 +50,7 @@ exports.builder = yargs => {
   addUseEnvironmentOptions(yargs, true);
 
   yargs.positional('tableId', {
-    describe: 'HubDB Table ID',
+    describe: i18n(`${i18nKey}.positionals.tableId.describe`),
     type: 'string',
   });
 };

package/commands/hubdb/fetch.js

@@ -1,38 +1,28 @@
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 const { downloadHubDbTable } = require('@hubspot/cli-lib/hubdb');
 
-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.hubdb.subcommands.fetch';
 
 exports.command = 'fetch <tableId> [dest]';
-exports.describe = 'fetch a HubDB table';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  const { config: configPath, tableId, dest } = options;
+  const { tableId, dest } = 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('hubdb-fetch', {}, accountId);
@@ -40,7 +30,12 @@ exports.handler = async options => {
   try {
     const { filePath } = await downloadHubDbTable(accountId, tableId, dest);
 
-    logger.log(`Downloaded HubDB table ${tableId} to ${filePath}`);
+    logger.success(
+      i18n(`${i18nKey}.success.fetch`, {
+        path: filePath,
+        tableId,
+      })
+    );
   } catch (e) {
     logErrorInstance(e);
   }
@@ -52,12 +47,12 @@ exports.builder = yargs => {
   addUseEnvironmentOptions(yargs, true);
 
   yargs.positional('tableId', {
-    describe: 'HubDB Table ID',
+    describe: i18n(`${i18nKey}.positionals.tableId.describe`),
     type: 'string',
   });
 
   yargs.positional('dest', {
-    describe: 'Local destination folder to fetch table to',
+    describe: i18n(`${i18nKey}.positionals.dest.describe`),
     type: 'string',
   });
 };

package/commands/hubdb.js

@@ -3,9 +3,12 @@ const createCommand = require('./hubdb/create');
 const fetchCommand = require('./hubdb/fetch');
 const deleteCommand = require('./hubdb/delete');
 const clearCommand = require('./hubdb/clear');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.hubdb';
 
 exports.command = 'hubdb';
-exports.describe = 'Manage HubDB tables';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.builder = yargs => {
   addConfigOptions(yargs, true);

package/commands/init.js

@@ -18,6 +18,7 @@ const {
   API_KEY_AUTH_METHOD,
   ENVIRONMENTS,
 } = require('@hubspot/cli-lib/lib/constants');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
 const { logger } = require('@hubspot/cli-lib/logger');
 const {
   updateConfigWithPersonalAccessKey,
@@ -34,6 +35,9 @@ const {
 } = require('../lib/prompts');
 const { logDebugInfo } = require('../lib/debugInfo');
 const { authenticateWithOauth } = require('../lib/oauth');
+const { EXIT_CODES } = require('../lib/enums/exitCodes');
+
+const i18nKey = 'cli.commands.init';
 
 const TRACKING_STATUS = {
   STARTED: 'started',
@@ -82,7 +86,9 @@ const CONFIG_CREATION_FLOWS = {
 };
 
 exports.command = 'init';
-exports.describe = `initialize ${DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME} for a HubSpot account`;
+exports.describe = i18n(`${i18nKey}.describe`, {
+  configName: DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME,
+});
 
 exports.handler = async options => {
   const { auth: authType = PERSONAL_ACCESS_KEY_AUTH_METHOD.value, c } = options;
@@ -95,11 +101,13 @@ exports.handler = async options => {
   const env = options.qa ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD;
 
   if (fs.existsSync(configPath)) {
-    logger.error(`The config file '${configPath}' already exists.`);
-    logger.info(
-      'To update an existing config file, use the "hs auth" command.'
+    logger.error(
+      i18n(`${i18nKey}.errors.configFileExists`, {
+        configPath,
+      })
     );
-    process.exit(1);
+    logger.info(i18n(`${i18nKey}.info.updateConfig`));
+    process.exit(EXIT_CODES.ERROR);
   }
 
   trackAuthAction('init', authType, TRACKING_STATUS.STARTED);
@@ -111,12 +119,15 @@ exports.handler = async options => {
     const configPath = getConfigPath();
 
     logger.success(
-      `The config file "${configPath}" was created using "${authType}" for account ${name ||
-        accountId}.`
+      i18n(`${i18nKey}.success.configFileCreated`, {
+        configPath,
+        authType,
+        account: name || accountId,
+      })
     );
 
     trackAuthAction('init', authType, TRACKING_STATUS.COMPLETE, accountId);
-    process.exit();
+    process.exit(EXIT_CODES.SUCCESS);
   } catch (err) {
     logErrorInstance(err);
     trackAuthAction('init', authType, TRACKING_STATUS.ERROR);
@@ -125,8 +136,7 @@ exports.handler = async options => {
 
 exports.builder = yargs => {
   yargs.option('auth', {
-    describe:
-      'specify auth method to use ["personalaccesskey", "oauth2", "apikey"]',
+    describe: i18n(`${i18nKey}.options.auth.describe`),
     type: 'string',
     choices: [
       `${PERSONAL_ACCESS_KEY_AUTH_METHOD.value}`,
@@ -134,7 +144,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}.options.auth.defaultDescription`, {
+      defaultType: PERSONAL_ACCESS_KEY_AUTH_METHOD.value,
+    }),
   });
 
   addConfigOptions(yargs, true);

package/commands/lint.js

@@ -2,36 +2,21 @@ const {
   lint,
   printHublValidationResult,
 } = require('@hubspot/cli-lib/validate');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 
 const {
   addConfigOptions,
   addAccountOptions,
-  setLogLevel,
   getAccountId,
 } = require('../lib/commonOpts');
-const { logDebugInfo } = require('../lib/debugInfo');
 const { resolveLocalPath } = require('../lib/filesystem');
-const { validateAccount } = require('../lib/validation');
 const { trackCommandUsage } = require('../lib/usageTracking');
+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);
-  checkAndWarnGitInclusion();
-
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
-};
+const i18nKey = 'cli.commands.lint';
+const { EXIT_CODES } = require('../lib/enums/exitCodes');
 
 exports.command = 'lint <path>';
 // Hiding since this command is still experimental
@@ -44,7 +29,9 @@ exports.handler = async options => {
 
   const accountId = getAccountId(options);
   const localPath = resolveLocalPath(lintPath);
-  const groupName = `Linting "${localPath}"`;
+  const groupName = i18n(`${i18nKey}.groupName`, {
+    path: localPath,
+  });
 
   trackCommandUsage('lint', {}, accountId);
 
@@ -57,17 +44,21 @@ exports.handler = async options => {
   } catch (err) {
     logger.groupEnd(groupName);
     logErrorInstance(err, { accountId });
-    process.exit(1);
+    process.exit(EXIT_CODES.ERROR);
   }
   logger.groupEnd(groupName);
-  logger.log(`${count} issues found`);
+  logger.log(
+    i18n(`${i18nKey}.issuesFound`, {
+      count,
+    })
+  );
 };
 
 exports.builder = yargs => {
   addConfigOptions(yargs, true);
   addAccountOptions(yargs, true);
   yargs.positional('path', {
-    describe: 'Local folder to lint',
+    describe: i18n(`${i18nKey}.positionals.path.describe`),
     type: 'string',
   });
   return yargs;

package/commands/list.js

@@ -2,19 +2,12 @@ const chalk = require('chalk');
 const {
   addAccountOptions,
   addConfigOptions,
-  setLogLevel,
   getAccountId,
   addUseEnvironmentOptions,
 } = require('../lib/commonOpts');
 const { trackCommandUsage } = require('../lib/usageTracking');
-const { logDebugInfo } = require('../lib/debugInfo');
-const { validateAccount } = require('../lib/validation');
 const { isPathFolder } = require('../lib/filesystem');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
+
 const { logger } = require('@hubspot/cli-lib/logger');
 const {
   logApiErrorInstance,
@@ -27,24 +20,17 @@ const {
   HUBSPOT_FOLDER,
   MARKETPLACE_FOLDER,
 } = require('@hubspot/cli-lib/lib/constants');
+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.list';
+const { EXIT_CODES } = require('../lib/enums/exitCodes');
 
 exports.command = 'list [path]';
-exports.describe = 'list remote contents of a directory';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const { path } = options;
   const directoryPath = path || '/';
@@ -53,7 +39,11 @@ exports.handler = async options => {
 
   trackCommandUsage('list', {}, accountId);
 
-  logger.debug(`Getting contents of ${directoryPath}`);
+  logger.debug(
+    i18n(`${i18nKey}.gettingPathContents`, {
+      path: directoryPath,
+    })
+  );
 
   try {
     contentsResp = await getDirectoryContentsByPath(accountId, directoryPath);
@@ -63,7 +53,7 @@ exports.handler = async options => {
       e,
       new ApiErrorContext({ accountId, directoryPath })
     );
-    process.exit();
+    process.exit(EXIT_CODES.SUCCESS);
   }
 
   if (contentsResp.children.length) {
@@ -98,13 +88,17 @@ exports.handler = async options => {
 
     logger.log(folderContentsOutput);
   } else {
-    logger.info(`No files found in ${directoryPath}`);
+    logger.info(
+      i18n(`${i18nKey}.noFilesFoundInPath`, {
+        path: directoryPath,
+      })
+    );
   }
 };
 
 exports.builder = yargs => {
   yargs.positional('path', {
-    describe: 'Remote directory to list contents',
+    describe: i18n(`${i18nKey}.positionals.path.describe`),
     type: 'string',
   });
   yargs.example([['$0 list'], ['$0 list /'], ['$0 list serverless']]);

package/commands/logs.js

@@ -1,51 +1,31 @@
-const ora = require('ora');
+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 { logger } = require('@hubspot/cli-lib/logger');
-const {
-  logServerlessFunctionApiErrorInstance,
-  ApiErrorContext,
-} = require('@hubspot/cli-lib/errorHandlers');
 const { outputLogs } = require('@hubspot/cli-lib/lib/logs');
-const {
-  getFunctionByPath,
-  getAppFunctionLogs,
-  getLatestAppFunctionLogs,
-} = require('@hubspot/cli-lib/api/functions');
 const {
   getFunctionLogs,
   getLatestFunctionLog,
 } = require('@hubspot/cli-lib/api/results');
-const { validateAccount } = require('../lib/validation');
 const { tailLogs } = require('../lib/serverlessLogs');
+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();
+const i18nKey = 'cli.commands.logs';
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
-};
-
-const handleLatestLogsError = e => {
+const handleLogsError = (e, accountId, functionPath) => {
   if (e.statusCode === 404) {
-    logger.log('No logs found.');
+    logger.error(
+      i18n(`${i18nKey}.errors.noLogsFound`, {
+        accountId,
+        functionPath,
+      })
+    );
   }
 };
 
@@ -53,100 +33,49 @@ const endpointLog = async (accountId, options) => {
   const { latest, follow, compact, endpoint: functionPath } = options;
 
   logger.debug(
-    `Getting ${
-      latest ? 'latest ' : ''
-    }logs for function with path: ${functionPath}`
-  );
-
-  const functionResp = await getFunctionByPath(accountId, functionPath).catch(
-    async e => {
-      await logServerlessFunctionApiErrorInstance(
-        accountId,
-        e,
-        new ApiErrorContext({ accountId, functionPath })
-      );
-      process.exit();
-    }
+    i18n(`${i18nKey}.gettingLogs`, {
+      latest,
+      functionPath,
+    })
   );
-  const functionId = functionResp.id;
-
-  logger.debug(`Retrieving logs for functionId: ${functionResp.id}`);
 
   let logsResp;
 
   if (follow) {
-    const spinner = ora(
-      `Waiting for log entries for '${functionPath}' on account '${accountId}'.\n`
-    );
-    const tailCall = after => getFunctionLogs(accountId, functionId, { after });
-    const fetchLatest = () => {
-      try {
-        getLatestFunctionLog(accountId, functionId);
-      } catch (e) {
-        handleLatestLogsError(e);
-      }
-    };
+    const spinnies = new Spinnies();
 
-    await tailLogs({
-      accountId,
-      compact,
-      spinner,
-      tailCall,
-      fetchLatest,
+    spinnies.add('tailLogs', {
+      text: i18n(`${i18nKey}.tailLogs`),
     });
-  } else if (latest) {
-    try {
-      logsResp = await getLatestFunctionLog(accountId, functionResp.id);
-    } catch (e) {
-      handleLatestLogsError(e);
-    }
-  } else {
-    logsResp = await getFunctionLogs(accountId, functionResp.id, options);
-  }
-
-  if (logsResp) {
-    return outputLogs(logsResp, options);
-  }
-};
-
-const appFunctionLog = async (accountId, options) => {
-  const { latest, follow, compact, functionName, appPath } = options;
-
-  let logsResp;
-
-  if (follow) {
-    const spinner = ora(
-      `Waiting for log entries for "${functionName}" on account "${accountId}".\n`
-    );
     const tailCall = after =>
-      getAppFunctionLogs(accountId, functionName, appPath, { after });
+      getFunctionLogs(accountId, functionPath, { after });
     const fetchLatest = () => {
       try {
-        getLatestAppFunctionLogs(accountId, functionName, appPath);
+        return getLatestFunctionLog(accountId, functionPath);
       } catch (e) {
-        handleLatestLogsError(e);
+        handleLogsError(e, accountId, functionPath);
       }
     };
 
     await tailLogs({
       accountId,
       compact,
-      spinner,
+      spinnies,
       tailCall,
       fetchLatest,
     });
   } else if (latest) {
     try {
-      logsResp = await getLatestAppFunctionLogs(
-        accountId,
-        functionName,
-        appPath
-      );
+      logsResp = await getLatestFunctionLog(accountId, functionPath);
     } catch (e) {
-      handleLatestLogsError(e);
+      handleLogsError(e, accountId, functionPath);
     }
   } else {
-    logsResp = await getAppFunctionLogs(accountId, functionName, appPath, {});
+    try {
+      logsResp = await getFunctionLogs(accountId, functionPath, options);
+    } catch (e) {
+      handleLogsError(e, accountId, functionPath);
+    }
   }
 
   if (logsResp) {
@@ -155,58 +84,44 @@ const appFunctionLog = async (accountId, options) => {
 };
 
 exports.command = 'logs [endpoint]';
-exports.describe = 'get logs for a function';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
-  const { latest, functionName } = options;
+  const { latest } = options;
 
   const accountId = getAccountId(options);
 
   trackCommandUsage('logs', { latest }, accountId);
 
-  if (functionName) {
-    appFunctionLog(accountId, options);
-  } else {
-    endpointLog(accountId, options);
-  }
+  endpointLog(accountId, options);
 };
 
 exports.builder = yargs => {
   yargs.positional('endpoint', {
-    describe: 'Serverless function endpoint',
+    describe: i18n(`${i18nKey}.positionals.endpoint.describe`),
     type: 'string',
   });
   yargs
     .options({
-      appPath: {
-        describe: 'path to the app',
-        type: 'string',
-        hidden: true,
-      },
-      functionName: {
-        describe: 'app function name',
-        type: 'string',
-        hidden: true,
-      },
       latest: {
         alias: 'l',
-        describe: 'retrieve most recent log only',
+        describe: i18n(`${i18nKey}.options.latest.describe`),
         type: 'boolean',
       },
       compact: {
-        describe: 'output compact logs',
+        describe: i18n(`${i18nKey}.options.compact.describe`),
         type: 'boolean',
       },
       follow: {
         alias: ['t', 'tail', 'f'],
-        describe: 'follow logs',
+        describe: i18n(`${i18nKey}.options.follow.describe`),
         type: 'boolean',
       },
       limit: {
         alias: ['limit', 'n', 'max-count'],
-        describe: 'limit the number of logs to output',
+        describe: i18n(`${i18nKey}.options.limit.describe`),
         type: 'number',
       },
     })
@@ -214,18 +129,9 @@ exports.builder = yargs => {
     .conflicts('functionName', 'endpoint');
 
   yargs.example([
-    [
-      '$0 logs my-endpoint',
-      'Get 5 most recent logs for function residing at /_hcms/api/my-endpoint',
-    ],
-    [
-      '$0 logs my-endpoint --limit=10',
-      'Get 10 most recent logs for function residing at /_hcms/api/my-endpoint',
-    ],
-    [
-      '$0 logs my-endpoint --follow',
-      'Poll for and output logs for function residing at /_hcms/api/my-endpoint immediately upon new execution',
-    ],
+    ['$0 logs my-endpoint', i18n(`${i18nKey}.examples.default`)],
+    ['$0 logs my-endpoint --limit=10', i18n(`${i18nKey}.examples.limit`)],
+    ['$0 logs my-endpoint --follow', i18n(`${i18nKey}.examples.follow`)],
   ]);
 
   addConfigOptions(yargs, true);