@hubspot/cli 3.0.9 → 3.0.10-beta.11

package/commands/filemanager/upload.js

@@ -1,11 +1,6 @@
 const fs = require('fs');
 const path = require('path');
 
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { uploadFolder } = require('@hubspot/cli-lib/fileManager');
 const { uploadFile } = require('@hubspot/cli-lib/api/fileManager');
 const { getCwd, convertToUnixPath } = require('@hubspot/cli-lib/path');
@@ -22,28 +17,22 @@ 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.filemanager.subcommands.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 File Manager';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  const { config: configPath, src, dest } = options;
-
-  setLogLevel(options);
-  logDebugInfo(options);
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
+  const { src, dest } = options;
 
-  if (!validateConfig() || !(await validateAccount(options))) {
-    process.exit(1);
-  }
+  await loadAndValidateOptions(options);
 
   const accountId = getAccountId(options);
   const absoluteSrcPath = path.resolve(getCwd(), src);
@@ -52,16 +41,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);
@@ -77,26 +74,36 @@ 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 (shouldIgnoreFile(absoluteSrcPath)) {
-      logger.error(`The file "${src}" is being ignored via an .hsignore rule`);
+      logger.error(
+        i18n(`${i18nKey}.errors.fileIgnored`, {
+          path: src,
+        })
+      );
       return;
     }
 
     uploadFile(accountId, absoluteSrcPath, normalizedDest)
       .then(() => {
         logger.success(
-          'Uploaded file from "%s" to "%s" in the File Manager of account %s',
-          src,
-          normalizedDest,
-          accountId
+          i18n(`${i18nKey}.success.upload`, {
+            accountId,
+            dest: normalizedDest,
+            src,
+          })
         );
       })
       .catch(error => {
-        logger.error('Uploading file "%s" to "%s" failed', src, normalizedDest);
+        logger.error(
+          i18n(`${i18nKey}.errors.upload`, {
+            dest: normalizedDest,
+            src,
+          })
+        );
         logApiUploadErrorInstance(
           error,
           new ApiErrorContext({
@@ -108,16 +115,22 @@ exports.handler = async options => {
       });
   } else {
     logger.log(
-      `Uploading files from "${src}" to "${dest}" in the File Manager of account ${accountId}`
+      i18n(`${i18nKey}.logs.uploading`, {
+        accountId,
+        dest,
+        src,
+      })
     );
     uploadFolder(accountId, absoluteSrcPath, dest)
       .then(() => {
         logger.success(
-          `Uploading files to "${dest}" in the File Manager is complete`
+          i18n(`${i18nKey}.success.uploadComplete`, {
+            dest,
+          })
         );
       })
       .catch(error => {
-        logger.error('Uploading failed');
+        logger.error(i18n(`${i18nKey}.errors.uploadingFailed`));
         logErrorInstance(error, {
           accountId,
         });
@@ -131,12 +144,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',
   });
 };

package/commands/filemanager.js

@@ -5,9 +5,12 @@ const {
 } = require('../lib/commonOpts');
 const upload = require('./filemanager/upload');
 const fetch = require('./filemanager/fetch');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.filemanager';
 
 exports.command = 'filemanager';
-exports.describe = 'Commands for working with the File Manager';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.builder = yargs => {
   addOverwriteOptions(yargs, true);

package/commands/functions/deploy.js

@@ -2,17 +2,10 @@ const ora = require('ora');
 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,
@@ -23,14 +16,11 @@ const {
   buildPackage,
   getBuildStatus,
 } = require('@hubspot/cli-lib/api/functions');
-const { validateAccount } = require('../../lib/validation');
+const { loadAndValidateOptions } = require('../../lib/validation');
 const { outputBuildLog } = require('../../lib/serverlessLogs');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
-const makeSpinner = (actionText, functionPath, accountIdentifier) => {
-  return ora(
-    `${actionText} bundle for '${functionPath}' on account '${accountIdentifier}'.\n`
-  );
-};
+const i18nKey = 'cli.commands.functions.subcommands.deploy';
 
 const pollBuildStatus = (accountId, buildId) => {
   return new Promise((resolve, reject) => {
@@ -49,23 +39,11 @@ const pollBuildStatus = (accountId, buildId) => {
   });
 };
 
-const loadAndValidateOptions = async options => {
-  setLogLevel(options);
-  logDebugInfo(options);
-  const { config: configPath } = options;
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
-
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
-};
-
 exports.command = 'deploy <path>';
 exports.describe = false;
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const { path: functionPath } = options;
   const accountId = getAccountId(options);
@@ -78,19 +56,26 @@ exports.handler = async options => {
     !splitFunctionPath.length ||
     splitFunctionPath[splitFunctionPath.length - 1] !== 'functions'
   ) {
-    logger.error(`Specified path ${functionPath} is not a .functions folder.`);
+    logger.error(
+      i18n(`${i18nKey}.errors.notFunctionsFolder`, {
+        functionPath,
+      })
+    );
     return;
   }
 
   logger.debug(
-    `Starting build and deploy for .functions folder with path: ${functionPath}`
+    i18n(`${i18nKey}.debug.startingBuildAndDeploy`, {
+      functionPath,
+    })
   );
 
   try {
-    spinner = makeSpinner(
-      'Building and deploying',
-      functionPath,
-      accountId
+    spinner = ora(
+      i18n(`${i18nKey}.loading`, {
+        accountId,
+        functionPath,
+      })
     ).start();
     const buildId = await buildPackage(accountId, functionPath);
     const successResp = await pollBuildStatus(accountId, buildId);
@@ -98,17 +83,29 @@ exports.handler = async options => {
     spinner.stop();
     await outputBuildLog(successResp.cdnUrl);
     logger.success(
-      `Built and deployed bundle from package.json for ${functionPath} on account ${accountId} in ${buildTimeSeconds}s.`
+      i18n(`${i18nKey}.success.deploy`, {
+        accountId,
+        buildTimeSeconds,
+        functionPath,
+      })
     );
   } catch (e) {
     spinner && spinner.stop && spinner.stop();
     if (e.statusCode === 404) {
-      logger.error(`Unable to find package.json for function ${functionPath}.`);
+      logger.error(
+        i18n(`${i18nKey}.errors.noPackageJson`, {
+          functionPath,
+        })
+      );
     } else if (e.statusCode === 400) {
       logger.error(e.error.message);
     } else if (e.status === 'ERROR') {
       await outputBuildLog(e.cdnUrl);
-      logger.error(`Build error: ${e.errorReason}`);
+      logger.error(
+        i18n(`${i18nKey}.errors.buildError`, {
+          details: e.errorReason,
+        })
+      );
     } else {
       logApiErrorInstance(
         accountId,
@@ -121,14 +118,14 @@ exports.handler = async options => {
 
 exports.builder = yargs => {
   yargs.positional('path', {
-    describe: 'Path to .functions folder',
+    describe: i18n(`${i18nKey}.positionals.path.describe`),
     type: 'string',
   });
 
   yargs.example([
     [
       '$0 functions deploy myFunctionFolder.functions',
-      'Build and deploy a new bundle for all functions within the myFunctionFolder.functions folder',
+      i18n(`${i18nKey}.examples.default`),
     ],
   ]);
 

package/commands/functions/list.js

@@ -5,11 +5,6 @@ const {
   ApiErrorContext,
 } = require('@hubspot/cli-lib/errorHandlers');
 const { getFunctionArrays } = require('@hubspot/cli-lib/lib/functions');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const {
   getTableContents,
   getTableHeader,
@@ -20,26 +15,16 @@ const {
   addAccountOptions,
   addUseEnvironmentOptions,
   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.functions.subcommands.list';
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 
 exports.command = 'list';
-exports.describe = 'List currently deployed functions';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
   loadAndValidateOptions(options);
@@ -49,15 +34,15 @@ exports.handler = async options => {
 
   trackCommandUsage('functions-list', { json, compact }, accountId);
 
-  logger.debug('Getting currently deployed functions');
+  logger.debug(i18n(`${i18nKey}.debug.gettingFunctions`));
 
   const routesResp = await getRoutes(accountId).catch(async e => {
     await logApiErrorInstance(accountId, e, new ApiErrorContext({ accountId }));
-    process.exit();
+    process.exit(EXIT_CODES.SUCCESS);
   });
 
   if (!routesResp.objects.length) {
-    return logger.info('No functions found.');
+    return logger.info(i18n(`${i18nKey}.info.noFunctions`));
   }
 
   if (options.json) {
@@ -78,7 +63,7 @@ exports.builder = yargs => {
 
   yargs.options({
     json: {
-      describe: 'output raw json data',
+      describe: i18n(`${i18nKey}.options.json.describe`),
       type: 'boolean',
     },
   });

package/commands/functions/server.js

@@ -1,38 +1,22 @@
 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 { start: startTestServer } = require('@hubspot/serverless-dev-runtime');
-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.functions.subcommands.server';
 
 exports.command = 'server <path>';
 exports.describe = false;
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const { path: functionPath } = options;
   const accountId = getAccountId(options);
@@ -40,7 +24,9 @@ exports.handler = async options => {
   trackCommandUsage('functions-server', { functionPath }, accountId);
 
   logger.debug(
-    `Starting local test server for .functions folder with path: ${functionPath}`
+    i18n(`${i18nKey}.debug.startingServer`, {
+      functionPath,
+    })
   );
 
   startTestServer({
@@ -51,28 +37,26 @@ exports.handler = async options => {
 
 exports.builder = yargs => {
   yargs.positional('path', {
-    describe: 'Path to local .functions folder',
+    describe: i18n(`${i18nKey}.positionals.path.describe`),
     type: 'string',
   });
   yargs.option('port', {
-    describe: 'port to run the test server on',
+    describe: i18n(`${i18nKey}.options.port.describe`),
     type: 'string',
     default: 5432,
   });
   yargs.option('contact', {
-    describe: 'pass contact data to the test function',
+    describe: i18n(`${i18nKey}.options.contact.describe`),
     type: 'boolean',
     default: true,
   });
   yargs.option('watch', {
-    describe:
-      'watch the specified .functions folder for changes and restart the server',
+    describe: i18n(`${i18nKey}.options.watch.describe`),
     type: 'boolean',
     default: true,
   });
   yargs.option('log-output', {
-    describe:
-      'output the response body from the serverless function execution (It is suggested not to use this in production environments as it can reveal any secure data returned by the function in logs)',
+    describe: i18n(`${i18nKey}.options.logOutput.describe`),
     type: 'boolean',
     default: false,
   });
@@ -80,7 +64,7 @@ exports.builder = yargs => {
   yargs.example([
     [
       '$0 functions server ./tmp/myFunctionFolder.functions',
-      'Run a local function test server.',
+      i18n(`${i18nKey}.examples.default`),
     ],
   ]);
 

package/commands/functions.js

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

package/commands/hubdb/clear.js

@@ -1,39 +1,29 @@
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 const { clearHubDbTableRows } = require('@hubspot/cli-lib/hubdb');
 const { publishTable } = 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.clear';
 
 exports.command = 'clear <tableId>';
-exports.describe = 'clear all rows in 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);
-  checkAndWarnGitInclusion();
+  await loadAndValidateOptions(options);
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
   const accountId = getAccountId(options);
 
   trackCommandUsage('hubdb-clear', {}, accountId);
@@ -41,11 +31,25 @@ exports.handler = async options => {
   try {
     const { deletedRowCount } = await clearHubDbTableRows(accountId, tableId);
     if (deletedRowCount > 0) {
-      logger.log(`Removed ${deletedRowCount} rows from HubDB table ${tableId}`);
+      logger.log(
+        i18n(`${i18nKey}.logs.removedRows`, {
+          deletedRowCount,
+          tableId,
+        })
+      );
       const { rowCount } = await publishTable(accountId, tableId);
-      logger.log(`HubDB table ${tableId} now contains ${rowCount} rows`);
+      logger.log(
+        i18n(`${i18nKey}.logs.rowCount`, {
+          rowCount,
+          tableId,
+        })
+      );
     } else {
-      logger.log(`HubDB table ${tableId} is already empty`);
+      logger.log(
+        i18n(`${i18nKey}.logs.emptyTable`, {
+          tableId,
+        })
+      );
     }
   } catch (e) {
     logErrorInstance(e);
@@ -58,7 +62,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/create.js

@@ -1,39 +1,34 @@
 const path = require('path');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
+
 const { logger } = require('@hubspot/cli-lib/logger');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 const { getCwd } = require('@hubspot/cli-lib/path');
 const { createHubDbTable } = require('@hubspot/cli-lib/hubdb');
 
-const { validateAccount, isFileValidJSON } = require('../../lib/validation');
+const {
+  isFileValidJSON,
+  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.create';
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 
 exports.command = 'create <src>';
-exports.describe = 'Create a HubDB table';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  const { config: configPath, src } = options;
+  const { src } = 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-create', {}, accountId);
@@ -41,18 +36,26 @@ exports.handler = async options => {
   try {
     const filePath = path.resolve(getCwd(), src);
     if (!isFileValidJSON(filePath)) {
-      process.exit(1);
+      process.exit(EXIT_CODES.ERROR);
     }
 
     const table = await createHubDbTable(
       accountId,
       path.resolve(getCwd(), src)
     );
-    logger.log(
-      `The table ${table.tableId} was created in ${accountId} with ${table.rowCount} rows`
+    logger.success(
+      i18n(`${i18nKey}.success.create`, {
+        accountId,
+        rowCount: table.rowCount,
+        tableId: table.tableId,
+      })
     );
   } catch (e) {
-    logger.error(`Creating the table at "${src}" failed`);
+    logger.error(
+      i18n(`${i18nKey}.errors.create`, {
+        src,
+      })
+    );
     logErrorInstance(e);
   }
 };
@@ -63,7 +66,7 @@ exports.builder = yargs => {
   addUseEnvironmentOptions(yargs, true);
 
   yargs.positional('src', {
-    describe: 'local path to file used for import',
+    describe: i18n(`${i18nKey}.positionals.src.describe`),
     type: 'string',
   });
 };