@hubspot/cli 3.0.9 → 3.0.10-beta.11

package/commands/config/set/defaultMode.js

@@ -1,32 +1,17 @@
 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 { 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([
@@ -35,7 +20,7 @@ const selectMode = async () => {
       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;

package/commands/config/set/httpTimeout.js

@@ -1,33 +1,18 @@
 const { logger } = require('@hubspot/cli-lib/logger');
 const { updateHttpTimeout } = require('@hubspot/cli-lib/lib/config');
-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 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.config.subcommands.set.subcommands.httpTimeout';
 
 exports.command = 'http-timeout [timeout]';
-exports.describe = 'Change http timeout used in config';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const accountId = getAccountId(options);
   const { timeout } = options;
@@ -36,21 +21,18 @@ exports.handler = async options => {
 
   updateHttpTimeout(timeout);
 
-  return logger.log(`The http timeout has been set to: ${timeout}`);
+  return logger.success(i18n(`${i18nKey}.success.timeoutUpdated`, { timeout }));
 };
 
 exports.builder = yargs => {
   yargs.positional('timeout', {
-    describe: 'Set http timeout value (in ms) in the config',
+    describe: i18n(`${i18nKey}.positionals.timeout.describe`),
     type: 'string',
     default: 30000,
   });
 
   yargs.example([
-    [
-      '$0 config set http-timeout 30000',
-      'Set the http timeout value in the config to 30000ms',
-    ],
+    ['$0 config set http-timeout 30000', i18n(`${i18nKey}.examples.default`)],
   ]);
 
   return yargs;

package/commands/config/set.js

@@ -3,9 +3,12 @@ const defaultAccount = require('./set/defaultAccount');
 const defaultMode = require('./set/defaultMode');
 const httpTimeout = require('./set/httpTimeout');
 const allowUsageTracking = require('./set/allowUsageTracking');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.config.subcommands.set';
 
 exports.command = 'set';
-exports.describe = 'Commands for working with the config file';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.builder = yargs => {
   addConfigOptions(yargs, true);

package/commands/config.js

@@ -1,8 +1,11 @@
 const { addConfigOptions, addAccountOptions } = require('../lib/commonOpts');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
 const set = require('./config/set');
 
+const i18nKey = 'cli.commands.config';
+
 exports.command = 'config';
-exports.describe = 'Commands for working with the config file';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.builder = yargs => {
   addConfigOptions(yargs, true);

package/commands/create/api-sample.js

@@ -7,15 +7,16 @@ const ora = require('ora');
 const { fetchJsonFromRepository } = require('@hubspot/cli-lib/github');
 const { GITHUB_RELEASE_TYPES } = require('@hubspot/cli-lib/lib/constants');
 const { createProject } = require('@hubspot/cli-lib/projects');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.create.subcommands.apiSample';
 
 module.exports = {
   hidden: true,
   dest: ({ dest }) => dest,
   validate: ({ name }) => {
     if (!name) {
-      logger.error(
-        "The 'name' argument is required when creating an API Sample."
-      );
+      logger.error(i18n(`${i18nKey}.errors.nameRequired`));
       return false;
     }
 
@@ -31,7 +32,7 @@ module.exports = {
         return;
       }
     }
-    const downloadSpinner = ora('Loading available API samples');
+    const downloadSpinner = ora(i18n(`${i18nKey}.loading.apiSamples`));
     downloadSpinner.start();
     const samplesConfig = await fetchJsonFromRepository(
       'sample-apps-list',
@@ -39,22 +40,21 @@ module.exports = {
     );
     downloadSpinner.stop();
     if (!samplesConfig) {
-      logger.error(
-        `Currently there are no samples available, please, try again later.`
-      );
+      logger.error(i18n(`${i18nKey}.errors.noSamples`));
       return;
     }
     const { sampleType, sampleLanguage } = await createApiSamplePrompt(
       samplesConfig
     );
     if (!sampleType || !sampleLanguage) {
-      logger.error(
-        `Currently there are no samples available, please, try again later.`
-      );
+      logger.error(i18n(`${i18nKey}.errors.noSamples`));
       return;
     }
     logger.info(
-      `You've chosen ${sampleType} sample written on ${sampleLanguage} language`
+      i18n(`${i18nKey}.info.sampleChosen`, {
+        sampleType,
+        sampleLanguage,
+      })
     );
     const created = await createProject(
       filePath,
@@ -71,7 +71,9 @@ module.exports = {
         fs.copySync(`${filePath}/.env.template`, `${filePath}/.env`);
       }
       logger.success(
-        `Please, follow ${filePath}/README.md to find out how to run the sample`
+        i18n(`${i18nKey}.success.sampleCreated`, {
+          filePath,
+        })
       );
     }
   },

package/commands/create/module.js

@@ -2,6 +2,9 @@ const path = require('path');
 const { createModulePrompt } = require('../../lib/createModulePrompt');
 const fs = require('fs-extra');
 const { logger } = require('@hubspot/cli-lib/logger');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.create.subcommands.module';
 
 const createModule = (moduleDefinition, name, dest) => {
   const writeModuleMeta = ({ contentTypes, moduleLabel, global }, dest) => {
@@ -44,12 +47,24 @@ const createModule = (moduleDefinition, name, dest) => {
   const folderName = name.endsWith('.module') ? name : `${name}.module`;
   const destPath = path.join(dest, folderName);
   if (fs.existsSync(destPath)) {
-    logger.error(`The ${destPath} path already exists`);
+    logger.error(
+      i18n(`${i18nKey}.errors.pathExists`, {
+        path: destPath,
+      })
+    );
     return;
   }
-  logger.log(`Creating ${destPath}`);
+  logger.log(
+    i18n(`${i18nKey}.creatingPath`, {
+      path: destPath,
+    })
+  );
   fs.mkdirp(destPath);
-  logger.log(`Creating module at ${destPath}`);
+  logger.log(
+    i18n(`${i18nKey}.creatingModule`, {
+      path: destPath,
+    })
+  );
   fs.copySync(assetPath, destPath, { filter: moduleFileFilter });
 };
 
@@ -57,9 +72,7 @@ module.exports = {
   dest: ({ dest }) => dest,
   validate: ({ name }) => {
     if (!name) {
-      logger.error(
-        "The 'name' argument is required when creating a Custom Module."
-      );
+      logger.error(i18n(`${i18nKey}.errors.nameRequired`));
       return false;
     }
 

package/commands/create/project.js

@@ -5,6 +5,9 @@ const {
 } = require('@hubspot/cli-lib/projects');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { createProjectPrompt } = require('../../lib/prompts/projects');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.create.subcommands.project';
 
 module.exports = {
   hidden: true,
@@ -20,6 +23,10 @@ module.exports = {
     });
     createProjectTemplateFiles(dest, template);
 
-    logger.success(`Project created in ${dest}`);
+    logger.success(
+      i18n(`${i18nKey}.success.projectCreated`, {
+        path: dest,
+      })
+    );
   },
 };

package/commands/create/template.js

@@ -2,6 +2,9 @@ const { createTemplatePrompt } = require('../../lib/createTemplatePrompt');
 const { logger } = require('@hubspot/cli-lib/logger');
 const path = require('path');
 const fs = require('fs-extra');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.create.subcommands.template';
 
 const ASSET_PATHS = {
   'page-template': path.resolve(__dirname, '../../defaults/page-template.html'),
@@ -33,12 +36,24 @@ const createTemplate = (name, dest, type = 'page-template') => {
   const filename = name.endsWith('.html') ? name : `${name}.html`;
   const filePath = path.join(dest, filename);
   if (fs.existsSync(filePath)) {
-    logger.error(`The ${filePath} path already exists`);
+    logger.error(
+      i18n(`${i18nKey}.errors.pathExists`, {
+        path: filePath,
+      })
+    );
     return;
   }
-  logger.debug(`Making ${dest} if needed`);
+  logger.debug(
+    i18n(`${i18nKey}.debug.creatingPath`, {
+      path: dest,
+    })
+  );
   fs.mkdirp(dest);
-  logger.log(`Creating file at ${filePath}`);
+  logger.log(
+    i18n(`${i18nKey}.log.creatingFile`, {
+      path: filePath,
+    })
+  );
   fs.copySync(assetPath, filePath);
 };
 
@@ -46,7 +61,7 @@ module.exports = {
   dest: ({ dest }) => dest,
   validate: ({ name }) => {
     if (!name) {
-      logger.error("The 'name' argument is required when creating a Template.");
+      logger.error(i18n(`${i18nKey}.errors.nameRequired`));
       return false;
     }
 

package/commands/create.js

@@ -31,13 +31,18 @@ const { logDebugInfo } = require('../lib/debugInfo');
 const { resolveLocalPath } = require('../lib/filesystem');
 const { trackCommandUsage } = require('../lib/usageTracking');
 const assets = require('./create/index');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.create';
 
 const SUPPORTED_ASSET_TYPES = Object.keys(assets)
   .filter(t => !assets[t].hidden)
   .join(', ');
 
 exports.command = 'create <type> [name] [dest]';
-exports.describe = `Create HubSpot sample apps and CMS assets. Supported assets are ${SUPPORTED_ASSET_TYPES}.`;
+exports.describe = i18n(`${i18nKey}.describe`, {
+  supportedAssetTypes: SUPPORTED_ASSET_TYPES,
+});
 
 exports.handler = async options => {
   let { type: assetType, name, dest } = options;
@@ -48,14 +53,21 @@ exports.handler = async options => {
 
   if (assetType === 'global-partial') {
     logger.error(
-      `The CLI command for asset type ${assetType} has been deprecated in an effort to make it easier to know what asset types can be created. Run the "hs create template" command instead. Then when prompted select "global partial".`
+      i18n(`${i18nKey}.errors.deprecatedAssetType`, {
+        assetType,
+        newCommand: 'hs create template',
+        type: 'global partial',
+      })
     );
     return;
   }
 
   if (!assetType || !assets[assetType]) {
     logger.error(
-      `The asset type ${assetType} is not supported. Supported asset types are ${SUPPORTED_ASSET_TYPES}.`
+      i18n(`${i18nKey}.errors.unsupportedAssetType`, {
+        assetType,
+        supportedAssetTypes: SUPPORTED_ASSET_TYPES,
+      })
     );
     return;
   }
@@ -67,7 +79,11 @@ exports.handler = async options => {
   try {
     await fs.ensureDir(dest);
   } catch (e) {
-    logger.error(`The "${dest}" is not a usable path to a directory`);
+    logger.error(
+      i18n(`${i18nKey}.errors.unusablePath`, {
+        path: dest,
+      })
+    );
     logFileSystemErrorInstance(e, {
       filepath: dest,
       write: true,
@@ -88,16 +104,15 @@ exports.handler = async options => {
 
 exports.builder = yargs => {
   yargs.positional('type', {
-    describe: 'Type of asset',
+    describe: i18n(`${i18nKey}.positionals.type.describe`),
     type: 'string',
   });
   yargs.positional('name', {
-    describe: 'Name of new asset',
+    describe: i18n(`${i18nKey}.positionals.name.describe`),
     type: 'string',
   });
   yargs.positional('dest', {
-    describe:
-      'Destination folder for the new asset, 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',
   });
 

package/commands/customObject/create.js

@@ -1,58 +1,56 @@
-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 {
+  isFileValidJSON,
+  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 { batchCreateObjects } = require('@hubspot/cli-lib/api/customObject');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.customObject.subcommands.create';
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 
 exports.command = 'create <name> <definition>';
-exports.describe = 'Create custom object instances';
+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-batch-create', null, accountId);
 
   const filePath = getAbsoluteFilePath(definition);
   if (!isFileValidJSON(filePath)) {
-    process.exit(1);
+    process.exit(EXIT_CODES.ERROR);
   }
 
   try {
     await batchCreateObjects(accountId, name, filePath);
-    logger.success(`Objects created`);
+    logger.success(i18n(`${i18nKey}.success.objectsCreated`));
   } catch (e) {
     logErrorInstance(e, { accountId });
-    logger.error(`Object creation from ${definition} failed`);
+    logger.error(
+      i18n(`${i18nKey}.errors.creationFailed`, {
+        definition,
+      })
+    );
   }
 };
 
 exports.builder = yargs => {
   yargs.positional('name', {
-    describe: 'Schema name to add the object instance to',
+    describe: i18n(`${i18nKey}.positionals.name.describe`),
     type: 'string',
   });
 
   yargs.positional('definition', {
-    describe:
-      'Local path to the JSON file containing an array of object definitions',
+    describe: i18n(`${i18nKey}.positionals.definition.describe`),
     type: 'string',
   });
 };

package/commands/customObject/schema/create.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 { getEnv, isConfigFlagEnabled } = require('@hubspot/cli-lib/');
 const { ENVIRONMENTS, ConfigFlags } = require('@hubspot/cli-lib/lib/constants');
-const { logDebugInfo } = require('../../../lib/debugInfo');
 const { createSchema } = require('@hubspot/cli-lib/api/schema');
 const {
   createSchema: createSchemaFromHubFile,
 } = 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.create';
+const { EXIT_CODES } = require('../../../lib/enums/exitCodes');
 
 exports.command = 'create <definition>';
-exports.describe = 'Create a custom object schema';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
   const { definition } = 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-create', 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 createSchemaFromHubFile(accountId, filePath);
-      logger.success(`Your schema has been created in account "${accountId}"`);
+      logger.success(
+        i18n(`${i18nKey}.success.schemaCreated`, {
+          accountId,
+        })
+      );
     } else {
       const res = await createSchema(accountId, filePath);
       logger.success(
-        `Schema can be viewed at ${getHubSpotWebsiteOrigin(
-          getEnv() === 'qa' ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD
-        )}/contacts/${accountId}/objects/${res.objectTypeId}`
+        i18n(`${i18nKey}.success.schemaViewable`, {
+          url: `${getHubSpotWebsiteOrigin(
+            getEnv() === 'qa' ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD
+          )}/contacts/${accountId}/objects/${res.objectTypeId}`,
+        })
       );
     }
   } catch (e) {
     logErrorInstance(e, { accountId });
-    logger.error(`Schema creation from ${definition} failed`);
+    logger.error(
+      i18n(`${i18nKey}.errors.creationFailed`, {
+        definition,
+      })
+    );
   }
 };
 
@@ -67,7 +69,7 @@ exports.builder = yargs => {
   addTestingOptions(yargs, true);
 
   yargs.positional('definition', {
-    describe: 'Local path to the JSON file containing the schema definition',
+    describe: i18n(`${i18nKey}.positionals.definition.describe`),
     type: 'string',
   });
 };