@hubspot/cli 3.0.10-beta.9 → 3.0.11

package/commands/open.js

@@ -6,17 +6,20 @@ const {
 } = require('../lib/commonOpts');
 const { trackCommandUsage } = require('../lib/usageTracking');
 const { logSiteLinks, getSiteLinksAsArray, openLink } = require('../lib/links');
-const inquirer = require('inquirer');
+const { promptUser } = require('../lib/prompts/promptUtils');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.open';
 
 const separator = ' => ';
 const createListPrompt = async accountId =>
-  inquirer.prompt([
+  promptUser([
     {
       type: 'rawlist',
       look: false,
       name: 'open',
       pageSize: 20,
-      message: 'Select a link to open',
+      message: i18n(`${i18nKey}.selectLink`),
       choices: getSiteLinksAsArray(accountId).map(
         l => `${l.shortcut}${separator}${l.url}`
       ),
@@ -25,8 +28,7 @@ const createListPrompt = async accountId =>
   ]);
 
 exports.command = 'open [shortcut]';
-exports.describe =
-  'Open a HubSpot page in your browser. Run ‘hs open list’ to see all available shortcuts.';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
   const { shortcut, list } = options;
@@ -47,13 +49,13 @@ exports.handler = async options => {
 
 exports.builder = yargs => {
   yargs.positional('[shortcut]', {
-    describe: "Shortcut of the link you'd like to open",
+    describe: i18n(`${i18nKey}.positionals.shortcut.describe`),
     type: 'string',
   });
 
   yargs.option('list', {
     alias: 'l',
-    describe: 'List all supported shortcuts',
+    describe: i18n(`${i18nKey}.options.list.describe`),
     type: 'boolean',
   });
 

package/commands/project/create.js

@@ -1,96 +1,30 @@
 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 { validateAccount } = require('../../lib/validation');
+const { loadAndValidateOptions } = require('../../lib/validation');
 const { getCwd } = require('@hubspot/cli-lib/path');
 const path = require('path');
-const { prompt } = require('inquirer');
+const {
+  createProjectPrompt,
+} = require('../../lib/prompts/createProjectPrompt');
 const { createProjectConfig } = require('../../lib/projects');
-const { PROJECT_TEMPLATES } = require('@hubspot/cli-lib/lib/constants');
+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.project.subcommands.create';
 
 exports.command = 'create';
-exports.describe = false;
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const accountId = getAccountId(options);
 
-  const { name, template, location } = await prompt([
-    {
-      name: 'name',
-      message: '[--name] Give your project a name:',
-      when: !options.name,
-      validate: input => {
-        if (!input) {
-          return 'A project name is required';
-        }
-        return true;
-      },
-    },
-    {
-      name: 'location',
-      message: '[--location] Where should the project be created?',
-      when: !options.location,
-      default: answers => {
-        return path.resolve(getCwd(), answers.name || options.name);
-      },
-      validate: input => {
-        if (!input) {
-          return 'A project location is required';
-        }
-        return true;
-      },
-    },
-    {
-      name: 'template',
-      message: () => {
-        return options.template &&
-          !PROJECT_TEMPLATES.find(t => t.name === options.template)
-          ? `[--template] Could not find template ${options.template}. Please choose an available template.`
-          : '[--template] Start from a template?';
-      },
-      when:
-        !options.template ||
-        !PROJECT_TEMPLATES.find(t => t.name === options.template),
-      type: 'list',
-      choices: [
-        {
-          name: 'No template',
-          value: 'none',
-        },
-        ...PROJECT_TEMPLATES.map(template => {
-          return {
-            name: template.label,
-            value: template.name,
-          };
-        }),
-      ],
-    },
-  ]);
+  const { name, template, location } = await createProjectPrompt(options);
 
   trackCommandUsage('project-create', { projectName: name }, accountId);
 
@@ -104,20 +38,20 @@ exports.handler = async options => {
 exports.builder = yargs => {
   yargs.options({
     name: {
-      describe: 'Project name (cannot be changed)',
+      describe: i18n(`${i18nKey}.options.name.describe`),
       type: 'string',
     },
     location: {
-      describe: 'Directory where project should be created',
+      describe: i18n(`${i18nKey}.options.location.describe`),
       type: 'string',
     },
     template: {
-      describe: 'Which template?',
+      describe: i18n(`${i18nKey}.options.template.describe`),
       type: 'string',
     },
   });
 
-  yargs.example([['$0 project create', 'Create a project']]);
+  yargs.example([['$0 project create', i18n(`${i18nKey}.examples.default`)]]);
 
   addConfigOptions(yargs, true);
   addAccountOptions(yargs, true);

package/commands/project/deploy.js

@@ -1,47 +1,32 @@
 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,
 } = require('@hubspot/cli-lib/errorHandlers');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { deployProject, fetchProject } = require('@hubspot/cli-lib/api/dfs');
-const { validateAccount } = require('../../lib/validation');
+const { loadAndValidateOptions } = require('../../lib/validation');
 const {
   getProjectConfig,
   pollDeployStatus,
   validateProjectConfig,
 } = require('../../lib/projects');
+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.project.subcommands.deploy';
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 
 exports.command = 'deploy [path]';
-exports.describe = false;
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const { path: projectPath, buildId } = options;
   const accountId = getAccountId(options);
@@ -52,14 +37,21 @@ exports.handler = async options => {
 
   validateProjectConfig(projectConfig, projectDir);
 
-  logger.debug(`Deploying project at path: ${projectPath}`);
+  logger.debug(
+    i18n(`${i18nKey}.debug.deploying`, {
+      path: projectPath,
+    })
+  );
+
+  let exitCode = EXIT_CODES.SUCCESS;
 
   const getBuildId = async () => {
     const { latestBuild } = await fetchProject(accountId, projectConfig.name);
     if (latestBuild && latestBuild.buildId) {
       return latestBuild.buildId;
     }
-    logger.error('No latest build ID was found.');
+    logger.error(i18n(`${i18nKey}.errors.noBuildId`));
+    exitCode = EXIT_CODES.ERROR;
     return;
   };
 
@@ -73,7 +65,12 @@ exports.handler = async options => {
     );
 
     if (deployResp.error) {
-      logger.error(`Deploy error: ${deployResp.error.message}`);
+      logger.error(
+        i18n(`${i18nKey}.errors.deploy`, {
+          details: deployResp.error.message,
+        })
+      );
+      exitCode = EXIT_CODES.ERROR;
       return;
     }
 
@@ -89,27 +86,26 @@ exports.handler = async options => {
     } else {
       logApiErrorInstance(e, new ApiErrorContext({ accountId, projectPath }));
     }
+    exitCode = 1;
   }
+  process.exit(exitCode);
 };
 
 exports.builder = yargs => {
   yargs.positional('path', {
-    describe: 'Path to a project folder',
+    describe: i18n(`${i18nKey}.positionals.path.describe`),
     type: 'string',
   });
 
   yargs.options({
     buildId: {
-      describe: 'Project build ID to be deployed',
+      describe: i18n(`${i18nKey}.options.buildId.describe`),
       type: 'number',
     },
   });
 
   yargs.example([
-    [
-      '$0 project deploy myProjectFolder',
-      'Deploy a project within the myProjectFolder folder',
-    ],
+    ['$0 project deploy myProjectFolder', i18n(`${i18nKey}.examples.default`)],
   ]);
 
   addConfigOptions(yargs, true);

package/commands/project/listBuilds.js

@@ -3,17 +3,10 @@ const path = require('path');
 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,
@@ -28,33 +21,21 @@ const {
   getTableHeader,
 } = require('@hubspot/cli-lib/lib/table');
 const { getCwd } = require('@hubspot/cli-lib/path');
-const { validateAccount } = require('../../lib/validation');
-const { link } = require('../../lib/links');
+const { uiLink } = require('../../lib/ui');
+const { loadAndValidateOptions } = require('../../lib/validation');
 const {
   getProjectConfig,
   getProjectDetailUrl,
   validateProjectConfig,
 } = require('../../lib/projects');
 const moment = require('moment');
-const { prompt } = require('inquirer');
-
-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 { promptUser } = require('../../lib/prompts/promptUtils');
 
 exports.command = 'list-builds [path]';
 exports.describe = false;
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const { path: projectPath, limit } = options;
   const accountId = getAccountId(options);
@@ -82,7 +63,7 @@ exports.handler = async options => {
     } else {
       logger.log(
         `Showing the ${results.length} most recent builds for ${project.name}. ` +
-          link(
+          uiLink(
             'View all builds in project details.',
             getProjectDetailUrl(project.name, accountId)
           )
@@ -130,7 +111,7 @@ exports.handler = async options => {
       );
     }
     if (paging && paging.next) {
-      await prompt({
+      await promptUser({
         name: 'more',
         message: 'Press <enter> to load more, or ctrl+c to exit',
       });

package/commands/project/logs.js

@@ -3,48 +3,49 @@ const { getCwd } = require('@hubspot/cli-lib/path');
 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 { outputLogs } = require('@hubspot/cli-lib/lib/logs');
 const {
   getProjectAppFunctionLogs,
   getLatestProjectAppFunctionLog,
 } = require('@hubspot/cli-lib/api/functions');
+const {
+  getFunctionLogs,
+  getLatestFunctionLog,
+} = require('@hubspot/cli-lib/api/results');
 const { getProjectConfig } = require('../../lib/projects');
-const { validateAccount } = require('../../lib/validation');
+const { loadAndValidateOptions } = require('../../lib/validation');
 const { tailLogs } = require('../../lib/serverlessLogs');
+const { uiAccountDescription } = require('../../lib/ui');
+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.project.subcommands.logs';
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 
 const handleLogsError = (e, accountId, projectName, appPath, functionName) => {
   if (e.statusCode === 404) {
     logger.error(
-      `No logs were found for the function name '${functionName}' in the app path '${appPath}' within the project '${projectName}' in account ${accountId}.`
+      appPath
+        ? i18n(`${i18nKey}.errors.noAppFunctionLogs`, {
+            accountId,
+            appPath,
+            functionName,
+            projectName,
+          })
+        : i18n(`${i18nKey}.errors.noEndpointLogs`, {
+            accountId,
+            functionName,
+            projectName,
+          })
     );
   }
 };
 
-const appFunctionLog = async (accountId, options) => {
+const functionLog = async (accountId, options) => {
   const {
     latest,
     follow,
@@ -56,28 +57,43 @@ const appFunctionLog = async (accountId, options) => {
 
   let logsResp;
 
+  const tailCall = async after => {
+    try {
+      return appPath
+        ? getProjectAppFunctionLogs(
+            accountId,
+            functionName,
+            projectName,
+            appPath,
+            {
+              after,
+            }
+          )
+        : getFunctionLogs(accountId, functionName, { after });
+    } catch (e) {
+      handleLogsError(e, accountId, projectName, appPath, functionName);
+    }
+  };
+  const fetchLatest = async () => {
+    return appPath
+      ? getLatestProjectAppFunctionLog(
+          accountId,
+          functionName,
+          projectName,
+          appPath
+        )
+      : getLatestFunctionLog(accountId, functionName);
+  };
+
   if (follow) {
     const spinnies = new Spinnies();
 
     spinnies.add('tailLogs', {
-      text: `Waiting for log entries for '${functionName}' on account '${accountId}'.\n`,
+      text: i18n(`${i18nKey}.loading`, {
+        functionName,
+        accountId: uiAccountDescription(accountId),
+      }),
     });
-    const tailCall = after =>
-      getProjectAppFunctionLogs(accountId, functionName, projectName, appPath, {
-        after,
-      });
-    const fetchLatest = () => {
-      try {
-        return getLatestProjectAppFunctionLog(
-          accountId,
-          functionName,
-          projectName,
-          appPath
-        );
-      } catch (e) {
-        handleLogsError(e, accountId, projectName, appPath, functionName);
-      }
-    };
 
     await tailLogs({
       accountId,
@@ -88,24 +104,13 @@ const appFunctionLog = async (accountId, options) => {
     });
   } else if (latest) {
     try {
-      logsResp = await getLatestProjectAppFunctionLog(
-        accountId,
-        functionName,
-        projectName,
-        appPath
-      );
+      logsResp = await fetchLatest();
     } catch (e) {
       handleLogsError(e, accountId, projectName, appPath, functionName);
     }
   } else {
     try {
-      logsResp = await getProjectAppFunctionLogs(
-        accountId,
-        functionName,
-        projectName,
-        appPath,
-        {}
-      );
+      logsResp = await tailCall();
     } catch (e) {
       handleLogsError(e, accountId, projectName, appPath, functionName);
     }
@@ -116,74 +121,69 @@ const appFunctionLog = async (accountId, options) => {
   }
 };
 
-exports.command = 'logs [functionName]';
-exports.describe = 'get logs for a function within a project';
+exports.command = 'logs';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
-  const { latest, functionName, appPath } = options;
+  const { latest, functionName } = options;
   let projectName = options.projectName;
 
   if (!functionName) {
-    logger.error('You must pass a function name to retrieve logs for.');
-    process.exit(1);
+    logger.error(i18n(`${i18nKey}.errors.functionNameRequired`));
+    process.exit(EXIT_CODES.ERROR);
   } else if (!projectName) {
-    const projectConfig = await getProjectConfig(getCwd());
-    if (projectConfig.name) {
+    const { projectConfig } = await getProjectConfig(getCwd());
+    if (projectConfig && projectConfig.name) {
       projectName = projectConfig.name;
     } else {
-      logger.error(
-        'You must specify a project name using the --projectName argument.'
-      );
-      process.exit(1);
+      logger.error(i18n(`${i18nKey}.errors.projectNameRequired`));
+      process.exit(EXIT_CODES.ERROR);
     }
-  } else if (!appPath) {
-    logger.error('You must specify an app path using the --appPath argument.');
-    process.exit(1);
   }
 
   const accountId = getAccountId(options);
 
   trackCommandUsage('project-logs', { latest }, accountId);
 
-  appFunctionLog(accountId, { ...options, projectName });
+  functionLog(accountId, { ...options, projectName });
 };
 
 exports.builder = yargs => {
-  yargs.positional('functionName', {
-    describe: 'Serverless app function name',
-    type: 'string',
-    demandOption: true,
-  });
   yargs
     .options({
-      appPath: {
-        describe: 'path to the app',
+      functionName: {
+        alias: 'function',
+        describe: i18n(`${i18nKey}.positionals.functionName.describe`),
         type: 'string',
         demandOption: true,
       },
+      appPath: {
+        describe: i18n(`${i18nKey}.options.appPath.describe`),
+        type: 'string',
+      },
       projectName: {
-        describe: 'name of the project',
+        describe: i18n(`${i18nKey}.options.projectName.describe`),
         type: 'string',
       },
       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',
       },
     })
@@ -191,8 +191,8 @@ exports.builder = yargs => {
 
   yargs.example([
     [
-      '$0 project logs my-function --appName="app" --projectName="my-project"',
-      'Get 5 most recent logs for function named "my-function" within the app named "app" within the project named "my-project"',
+      '$0 project logs --function=my-function --appPath="app" --projectName="my-project"',
+      i18n(`${i18nKey}.examples.default`),
     ],
   ]);