@hubspot/cli 3.0.9 → 3.0.10-beta.11

package/commands/customObject/schema/delete.js

@@ -1,51 +1,51 @@
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 
-const { validateAccount } = require('../../../lib/validation');
+const { loadAndValidateOptions } = require('../../../lib/validation');
 const { trackCommandUsage } = require('../../../lib/usageTracking');
-const { setLogLevel, getAccountId } = require('../../../lib/commonOpts');
-const { logDebugInfo } = require('../../../lib/debugInfo');
+const { getAccountId } = require('../../../lib/commonOpts');
 const { deleteSchema } = require('@hubspot/cli-lib/api/schema');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey =
+  'cli.commands.customObject.subcommands.schema.subcommands.delete';
 
 exports.command = 'delete <name>';
-exports.describe = 'Delete a custom object schema';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
   let { name } = options;
 
-  setLogLevel(options);
-  logDebugInfo(options);
-  loadConfig(options.config);
-  checkAndWarnGitInclusion();
+  await loadAndValidateOptions(options);
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
   const accountId = getAccountId(options);
 
   trackCommandUsage('custom-object-schema-delete', null, accountId);
 
   try {
     await deleteSchema(accountId, name);
-    logger.success(`Successfully initiated deletion of ${name}`);
+    logger.success(
+      i18n(`${i18nKey}.success.delete`, {
+        name,
+      })
+    );
   } catch (e) {
     logErrorInstance(e);
-    logger.error(`Unable to delete ${name}`);
+    logger.error(
+      i18n(`${i18nKey}.errors.delete`, {
+        name,
+      })
+    );
   }
 };
 
 exports.builder = yargs => {
   yargs.example([
-    ['$0 schema delete schemaName', 'Delete `schemaName` schema'],
+    ['$0 schema delete schemaName', i18n(`${i18nKey}.examples.default`)],
   ]);
 
   yargs.positional('name', {
-    describe: 'Name of the target schema',
+    describe: i18n(`${i18nKey}.positionals.name.describe`),
     type: 'string',
   });
 };

package/commands/customObject/schema/fetch-all.js

@@ -1,56 +1,49 @@
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 
-const { validateAccount } = require('../../../lib/validation');
+const { loadAndValidateOptions } = require('../../../lib/validation');
 const { trackCommandUsage } = require('../../../lib/usageTracking');
-const { setLogLevel, getAccountId } = require('../../../lib/commonOpts');
-const { logDebugInfo } = require('../../../lib/debugInfo');
+const { getAccountId } = require('../../../lib/commonOpts');
 const { downloadSchemas, getResolvedPath } = require('@hubspot/cli-lib/schema');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey =
+  'cli.commands.customObject.subcommands.schema.subcommands.fetchAll';
 
 exports.command = 'fetch-all [dest]';
-exports.describe = 'Fetch all custom object schemas for an account';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  setLogLevel(options);
-  logDebugInfo(options);
-  loadConfig(options.config);
-  checkAndWarnGitInclusion();
+  await loadAndValidateOptions(options);
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
   const accountId = getAccountId(options);
 
   trackCommandUsage('custom-object-schema-fetch-all', null, accountId);
 
   try {
     await downloadSchemas(accountId, options.dest);
-    logger.success(`Saved schemas to ${getResolvedPath(options.dest)}`);
+    logger.success(
+      i18n(`${i18nKey}.success.fetch`, {
+        path: getResolvedPath(options.dest),
+      })
+    );
   } catch (e) {
     logErrorInstance(e);
-    logger.error('Unable to fetch schemas');
+    logger.error(i18n(`${i18nKey}.errors.fetch`));
   }
 };
 
 exports.builder = yargs => {
   yargs.example([
-    [
-      '$0 custom-object schema fetch-all',
-      'Fetch all schemas for an account and put them in the current working directory',
-    ],
+    ['$0 custom-object schema fetch-all', i18n(`${i18nKey}.examples.default`)],
     [
       '$0 custom-object schema fetch-all my/folder',
-      'Fetch all schemas for an account and put them in a directory named my/folder',
+      i18n(`${i18nKey}.examples.specifyPath`),
     ],
   ]);
 
   yargs.positional('dest', {
-    describe: 'Local folder where schemas will be written',
+    describe: i18n(`${i18nKey}.positionals.dest.describe`),
     type: 'string',
   });
 };

package/commands/customObject/schema/fetch.js

@@ -1,10 +1,5 @@
 const path = require('path');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-  isConfigFlagEnabled,
-} = require('@hubspot/cli-lib');
+const { isConfigFlagEnabled } = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 const { ConfigFlags } = require('@hubspot/cli-lib/lib/constants');
@@ -12,25 +7,22 @@ const { downloadSchema, getResolvedPath } = require('@hubspot/cli-lib/schema');
 const { fetchSchema } = require('@hubspot/cli-lib/api/fileTransport');
 const { getCwd } = require('@hubspot/cli-lib/path');
 
-const { validateAccount } = require('../../../lib/validation');
+const { loadAndValidateOptions } = require('../../../lib/validation');
 const { trackCommandUsage } = require('../../../lib/usageTracking');
-const { setLogLevel, getAccountId } = require('../../../lib/commonOpts');
-const { logDebugInfo } = require('../../../lib/debugInfo');
+const { getAccountId } = require('../../../lib/commonOpts');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey =
+  'cli.commands.customObject.subcommands.schema.subcommands.fetch';
 
 exports.command = 'fetch <name> [dest]';
-exports.describe = 'Fetch a custom object schema';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
   let { name, dest } = options;
 
-  setLogLevel(options);
-  logDebugInfo(options);
-  loadConfig(options.config);
-  checkAndWarnGitInclusion();
+  await loadAndValidateOptions(options);
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
   const accountId = getAccountId(options);
 
   trackCommandUsage('custom-object-schema-fetch', null, accountId);
@@ -39,14 +31,27 @@ exports.handler = async options => {
     if (isConfigFlagEnabled(ConfigFlags.USE_CUSTOM_OBJECT_HUBFILE)) {
       const fullpath = path.resolve(getCwd(), dest);
       await fetchSchema(accountId, name, fullpath);
-      logger.success(`The schema "${name}" has been saved to "${fullpath}"`);
+      logger.success(
+        i18n(`${i18nKey}.success.save`, {
+          name,
+          path: fullpath,
+        })
+      );
     } else {
       await downloadSchema(accountId, name, dest);
-      logger.success(`Saved schema to ${getResolvedPath(dest, name)}`);
+      logger.success(
+        i18n(`${i18nKey}.success.savedToPath`, {
+          path: getResolvedPath(dest, name),
+        })
+      );
     }
   } catch (e) {
     logErrorInstance(e);
-    logger.error(`Unable to fetch ${name}`);
+    logger.error(
+      i18n(`${i18nKey}.errors.fetch`, {
+        name,
+      })
+    );
   }
 };
 
@@ -54,21 +59,21 @@ exports.builder = yargs => {
   yargs.example([
     [
       '$0 custom-object schema fetch schemaName',
-      'Fetch `schemaId` schema and put it in the current working directory',
+      i18n(`${i18nKey}.examples.default`),
     ],
     [
       '$0 custom-object schema fetch schemaName my/folder',
-      'Fetch `schemaId` schema and put it in a directory named my/folder',
+      i18n(`${i18nKey}.examples.specifyPath`),
     ],
   ]);
 
   yargs.positional('name', {
-    describe: 'Name of the target schema',
+    describe: i18n(`${i18nKey}.positionals.name.describe`),
     type: 'string',
   });
 
   yargs.positional('dest', {
-    describe: 'Local folder where schema will be written',
+    describe: i18n(`${i18nKey}.positionals.dest.describe`),
     type: 'string',
   });
 };

package/commands/customObject/schema/list.js

@@ -1,29 +1,20 @@
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 
-const { validateAccount } = require('../../../lib/validation');
+const { loadAndValidateOptions } = require('../../../lib/validation');
 const { trackCommandUsage } = require('../../../lib/usageTracking');
-const { setLogLevel, getAccountId } = require('../../../lib/commonOpts');
-const { logDebugInfo } = require('../../../lib/debugInfo');
+const { getAccountId } = require('../../../lib/commonOpts');
 const { listSchemas } = require('@hubspot/cli-lib/schema');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.customObject.subcommands.schema.subcommands.list';
 
 exports.command = 'list';
-exports.describe = 'List schemas available on your account';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  setLogLevel(options);
-  logDebugInfo(options);
-  loadConfig(options.config);
-  checkAndWarnGitInclusion();
+  await loadAndValidateOptions(options);
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
   const accountId = getAccountId(options);
 
   trackCommandUsage('custom-object-schema-list', null, accountId);
@@ -32,6 +23,6 @@ exports.handler = async options => {
     await listSchemas(accountId);
   } catch (e) {
     logErrorInstance(e);
-    logger.error(`Unable to list schemas`);
+    logger.error(i18n(`${i18nKey}.errors.list`));
   }
 };

package/commands/customObject/schema/update.js

@@ -1,65 +1,67 @@
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 const { getAbsoluteFilePath } = require('@hubspot/cli-lib/path');
-const { validateAccount, isFileValidJSON } = require('../../../lib/validation');
-const { trackCommandUsage } = require('../../../lib/usageTracking');
 const {
-  addTestingOptions,
-  setLogLevel,
-  getAccountId,
-} = require('../../../lib/commonOpts');
+  isFileValidJSON,
+  loadAndValidateOptions,
+} = require('../../../lib/validation');
+const { trackCommandUsage } = require('../../../lib/usageTracking');
+const { addTestingOptions, getAccountId } = require('../../../lib/commonOpts');
 const { ENVIRONMENTS, ConfigFlags } = require('@hubspot/cli-lib/lib/constants');
 const { getEnv, isConfigFlagEnabled } = require('@hubspot/cli-lib');
-const { logDebugInfo } = require('../../../lib/debugInfo');
 const { updateSchema } = require('@hubspot/cli-lib/api/schema');
 const {
   updateSchema: updateSchemaFromHubFile,
 } = require('@hubspot/cli-lib/api/fileTransport');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey =
+  'cli.commands.customObject.subcommands.schema.subcommands.update';
+const { EXIT_CODES } = require('../../../lib/enums/exitCodes');
 
 exports.command = 'update <name> <definition>';
-exports.describe = 'Update an existing custom object schema';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
   const { definition, name } = options;
-  setLogLevel(options);
-  logDebugInfo(options);
-  const { config: configPath } = options;
-  loadConfig(configPath);
-  checkAndWarnGitInclusion();
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
+  await loadAndValidateOptions(options);
+
   const accountId = getAccountId(options);
 
   trackCommandUsage('custom-object-schema-update', null, accountId);
 
   const filePath = getAbsoluteFilePath(definition);
   if (!isFileValidJSON(filePath)) {
-    process.exit(1);
+    process.exit(EXIT_CODES.ERROR);
   }
 
   try {
     if (isConfigFlagEnabled(ConfigFlags.USE_CUSTOM_OBJECT_HUBFILE)) {
       await updateSchemaFromHubFile(accountId, filePath);
-      logger.success(`Your schema has been updated in account "${accountId}"`);
+      logger.success(
+        i18n(`${i18nKey}.success.update`, {
+          accountId,
+        })
+      );
     } else {
       const res = await updateSchema(accountId, name, filePath);
       logger.success(
-        `Schema can be viewed at ${getHubSpotWebsiteOrigin(
-          getEnv() === 'qa' ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD
-        )}/contacts/${accountId}/objects/${res.objectTypeId}`
+        i18n(`${i18nKey}.success.viewAtUrl`, {
+          url: `${getHubSpotWebsiteOrigin(
+            getEnv() === 'qa' ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD
+          )}/contacts/${accountId}/objects/${res.objectTypeId}`,
+        })
       );
     }
   } catch (e) {
     logErrorInstance(e, { accountId });
-    logger.error(`Schema update from ${definition} failed`);
+    logger.error(
+      i18n(`${i18nKey}.errors.update`, {
+        definition,
+      })
+    );
   }
 };
 
@@ -67,12 +69,12 @@ exports.builder = yargs => {
   addTestingOptions(yargs, true);
 
   yargs.positional('name', {
-    describe: 'Name of the target schema',
+    describe: i18n(`${i18nKey}.positionals.name.describe`),
     type: 'string',
   });
 
   yargs.positional('definition', {
-    describe: 'Local path to the JSON file containing the schema definition',
+    describe: i18n(`${i18nKey}.positionals.definition.describe`),
     type: 'string',
   });
 };

package/commands/customObject/schema.js

@@ -4,9 +4,12 @@ const fetchAllCommand = require('./schema/fetch-all');
 const deleteCommand = require('./schema/delete');
 const listCommand = require('./schema/list');
 const updateSchema = require('./schema/update');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.customObject.subcommands.schema';
 
 exports.command = 'schema';
-exports.describe = 'Manage custom object schemas';
+exports.describe = i18n(`${i18nKey}.describe`);
 exports.builder = yargs => {
   yargs
     .command(listCommand)

package/commands/customObject.js

@@ -1,11 +1,12 @@
 const { addConfigOptions, addAccountOptions } = require('../lib/commonOpts');
 const schemaCommand = require('./customObject/schema');
 const createCommand = require('./customObject/create');
-const chalk = require('chalk');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.customObject';
 
 exports.command = ['custom-object', 'custom', 'co'];
-exports.describe =
-  'Manage Custom Objects.  This feature is currently in beta and the CLI contract is subject to change';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.builder = yargs => {
   addConfigOptions(yargs, true);
@@ -16,26 +17,14 @@ exports.builder = yargs => {
     .command(createCommand)
     .demandCommand(1, '');
 
+  console.warn(i18n(`${i18nKey}.warning`));
+  console.warn(i18n(`${i18nKey}.betaMessage`));
   console.warn(
-    chalk.reset.yellow(
-      '***************************** WARNING WARNING WARNING ****************************'
-    )
-  );
-  console.warn(
-    chalk.reset.yellow(
-      'The Custom Object CLI is currently in beta and is subject to change.'
-    )
-  );
-  console.warn(
-    chalk.reset.yellow(
-      'See https://developers.hubspot.com/docs/api/crm/crm-custom-objects to find out more.'
-    )
-  );
-  console.warn(
-    chalk.reset.yellow(
-      '***************************** WARNING WARNING WARNING ****************************'
-    )
+    i18n(`${i18nKey}.seeMoreLink`, {
+      link: 'https://developers.hubspot.com/docs/api/crm/crm-custom-objects',
+    })
   );
+  console.warn(i18n(`${i18nKey}.warning`));
 
   return yargs;
 };

package/commands/fetch.js

@@ -1,9 +1,4 @@
 const { downloadFileOrFolder } = require('@hubspot/cli-lib/fileMapper');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 
 const {
@@ -14,39 +9,30 @@ const {
   addUseEnvironmentOptions,
   getAccountId,
   getMode,
-  setLogLevel,
 } = require('../lib/commonOpts');
 const { resolveLocalPath } = require('../lib/filesystem');
-const { validateAccount, validateMode } = require('../lib/validation');
-const { logDebugInfo } = require('../lib/debugInfo');
+const { validateMode, loadAndValidateOptions } = require('../lib/validation');
 const { trackCommandUsage } = require('../lib/usageTracking');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.fetch';
+const { EXIT_CODES } = require('../lib/enums/exitCodes');
 
 exports.command = 'fetch <src> [dest]';
-exports.describe =
-  'Fetch a file, directory or module from HubSpot and write to a path on your computer';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  const { config: configPath, src, dest } = options;
-
-  setLogLevel(options);
-  logDebugInfo(options);
+  const { src, dest } = options;
 
-  loadConfig(configPath);
-  checkAndWarnGitInclusion();
+  await loadAndValidateOptions(options);
 
-  if (
-    !(
-      validateConfig() &&
-      (await validateAccount(options)) &&
-      validateMode(options)
-    )
-  ) {
-    process.exit(1);
+  if (!validateMode(options)) {
+    process.exit(EXIT_CODES.ERROR);
   }
 
   if (typeof src !== 'string') {
-    logger.error('A source to fetch is required');
-    process.exit(1);
+    logger.error(i18n(`${i18nKey}.errors.sourceRequired`));
+    process.exit(EXIT_CODES.ERROR);
   }
 
   const accountId = getAccountId(options);
@@ -72,19 +58,18 @@ exports.builder = yargs => {
   addUseEnvironmentOptions(yargs, true);
 
   yargs.positional('src', {
-    describe: 'Path in HubSpot Design Tools',
+    describe: i18n(`${i18nKey}.positionals.src.describe`),
     type: 'string',
   });
 
   yargs.positional('dest', {
-    describe:
-      'Local directory you would like the files to be placed in, relative to your current working directory',
+    describe: i18n(`${i18nKey}.positionals.dest.describe`),
     type: 'string',
   });
 
   yargs.options({
     staging: {
-      describe: 'Retrieve staged changes for project',
+      describe: i18n(`${i18nKey}.options.staging.describe`),
       type: 'boolean',
       default: false,
       hidden: true,

package/commands/filemanager/fetch.js

@@ -1,8 +1,3 @@
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { downloadFileOrFolder } = require('@hubspot/cli-lib/fileManager');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { resolveLocalPath } = require('../../lib/filesystem');
@@ -11,32 +6,26 @@ 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.fetch';
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 
 exports.command = 'fetch <src> [dest]';
-exports.describe =
-  'Download a folder or file from the HubSpot File Manager to your computer';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  let { config: configPath, src, dest } = options;
+  let { src, dest } = options;
 
-  setLogLevel(options);
-  logDebugInfo(options);
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
-
-  if (!validateConfig() || !(await validateAccount(options))) {
-    process.exit(1);
-  }
+  await loadAndValidateOptions(options);
 
   if (typeof src !== 'string') {
-    logger.error('A source to fetch is required');
-    process.exit(1);
+    logger.error(i18n(`${i18nKey}.errors.sourceRequired`));
+    process.exit(EXIT_CODES.ERROR);
   }
 
   dest = resolveLocalPath(dest);
@@ -55,17 +44,16 @@ exports.builder = yargs => {
   addUseEnvironmentOptions(yargs, true);
 
   yargs.positional('src', {
-    describe: 'Path in HubSpot Design Tools',
+    describe: i18n(`${i18nKey}.positionals.src.describe`),
     type: 'string',
   });
   yargs.positional('dest', {
-    describe:
-      'Path to the local directory you would like the files to be placed, relative to your current working directory. If omitted, this argument will default to your current working directory',
+    describe: i18n(`${i18nKey}.positionals.dest.describe`),
     type: 'string',
   });
   yargs.option('include-archived', {
     alias: ['i'],
-    describe: 'Include files that have been marked as "archived"',
+    describe: i18n(`${i18nKey}.options.includeArchived.describe`),
     type: 'boolean',
   });
 };