@hubspot/cli 3.0.9 → 3.0.10-beta.11

package/commands/mv.js

@@ -1,9 +1,4 @@
 const { moveFile } = require('@hubspot/cli-lib/api/fileMapper');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const {
   logApiErrorInstance,
@@ -14,25 +9,14 @@ const {
   addConfigOptions,
   addAccountOptions,
   addUseEnvironmentOptions,
-  setLogLevel,
   getAccountId,
 } = require('../lib/commonOpts');
-const { logDebugInfo } = require('../lib/debugInfo');
-const { validateAccount } = require('../lib/validation');
 const { trackCommandUsage } = require('../lib/usageTracking');
 const { isPathFolder } = require('../lib/filesystem');
+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.mv';
 
 const getCorrectedDestPath = (srcPath, destPath) => {
   if (!isPathFolder(srcPath)) {
@@ -44,11 +28,10 @@ const getCorrectedDestPath = (srcPath, destPath) => {
 };
 
 exports.command = 'mv <srcPath> <destPath>';
-exports.describe =
-  'Move a remote file or folder in HubSpot. This feature is currently in beta and the CLI contract is subject to change';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const { srcPath, destPath } = options;
   const accountId = getAccountId(options);
@@ -58,14 +41,27 @@ exports.handler = async options => {
   try {
     await moveFile(accountId, srcPath, getCorrectedDestPath(srcPath, destPath));
     logger.success(
-      `Moved "${srcPath}" to "${destPath}" in account ${accountId}`
+      i18n(`${i18nKey}.move`, {
+        accountId,
+        destPath,
+        srcPath,
+      })
     );
   } catch (error) {
     logger.error(
-      `Moving "${srcPath}" to "${destPath}" in account ${accountId} failed`
+      i18n(`${i18nKey}.errors.moveFailed`, {
+        accountId,
+        destPath,
+        srcPath,
+      })
     );
     if (error.statusCode === 409) {
-      logger.error(`The folder "${srcPath}" already exists in "${destPath}".`);
+      logger.error(
+        i18n(`${i18nKey}.errors.sourcePathExists`, {
+          destPath,
+          srcPath,
+        })
+      );
     } else {
       logApiErrorInstance(
         error,

package/commands/open.js

@@ -7,6 +7,9 @@ const {
 const { trackCommandUsage } = require('../lib/usageTracking');
 const { logSiteLinks, getSiteLinksAsArray, openLink } = require('../lib/links');
 const inquirer = require('inquirer');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.open';
 
 const separator = ' => ';
 const createListPrompt = async accountId =>
@@ -16,7 +19,7 @@ const createListPrompt = async accountId =>
       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

@@ -0,0 +1,111 @@
+const {
+  addAccountOptions,
+  addConfigOptions,
+  getAccountId,
+  addUseEnvironmentOptions,
+} = require('../../lib/commonOpts');
+const { trackCommandUsage } = require('../../lib/usageTracking');
+const { loadAndValidateOptions } = require('../../lib/validation');
+const { getCwd } = require('@hubspot/cli-lib/path');
+const path = require('path');
+const { prompt } = require('inquirer');
+const { createProjectConfig } = require('../../lib/projects');
+const { PROJECT_TEMPLATES } = require('@hubspot/cli-lib/lib/constants');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.project.subcommands.create';
+
+exports.command = 'create';
+exports.describe = false;
+
+exports.handler = async 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,
+          };
+        }),
+      ],
+    },
+  ]);
+
+  trackCommandUsage('project-create', { projectName: name }, accountId);
+
+  await createProjectConfig(
+    path.resolve(getCwd(), options.location || location),
+    options.name || name,
+    options.template || template
+  );
+};
+
+exports.builder = yargs => {
+  yargs.options({
+    name: {
+      describe: i18n(`${i18nKey}.options.name.describe`),
+      type: 'string',
+    },
+    location: {
+      describe: i18n(`${i18nKey}.options.location.describe`),
+      type: 'string',
+    },
+    template: {
+      describe: i18n(`${i18nKey}.options.template.describe`),
+      type: 'string',
+    },
+  });
+
+  yargs.example([['$0 project create', i18n(`${i18nKey}.examples.default`)]]);
+
+  addConfigOptions(yargs, true);
+  addAccountOptions(yargs, true);
+  addUseEnvironmentOptions(yargs, true);
+
+  return yargs;
+};

package/commands/project/deploy.js

@@ -1,65 +1,57 @@
-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,
 } = require('@hubspot/cli-lib/errorHandlers');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { deployProject, fetchProject } = require('@hubspot/cli-lib/api/dfs');
-const { getCwd } = require('@hubspot/cli-lib/path');
-const { validateAccount } = require('../../lib/validation');
+const { loadAndValidateOptions } = require('../../lib/validation');
 const {
-  getOrCreateProjectConfig,
+  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.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const { path: projectPath, buildId } = options;
   const accountId = getAccountId(options);
 
   trackCommandUsage('project-deploy', { projectPath }, accountId);
 
-  const cwd = projectPath ? path.resolve(getCwd(), projectPath) : getCwd();
-  const projectConfig = await getOrCreateProjectConfig(cwd);
+  const { projectConfig, projectDir } = await getProjectConfig(projectPath);
+
+  validateProjectConfig(projectConfig, projectDir);
+
+  logger.debug(
+    i18n(`${i18nKey}.debug.deploying`, {
+      path: projectPath,
+    })
+  );
 
-  logger.debug(`Deploying project at 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

@@ -0,0 +1,160 @@
+const path = require('path');
+
+const {
+  addAccountOptions,
+  addConfigOptions,
+  getAccountId,
+  addUseEnvironmentOptions,
+} = require('../../lib/commonOpts');
+const { trackCommandUsage } = require('../../lib/usageTracking');
+const {
+  logApiErrorInstance,
+  ApiErrorContext,
+} = require('@hubspot/cli-lib/errorHandlers');
+const { logger } = require('@hubspot/cli-lib/logger');
+const {
+  fetchProject,
+  fetchProjectBuilds,
+} = require('@hubspot/cli-lib/api/dfs');
+const {
+  getTableContents,
+  getTableHeader,
+} = require('@hubspot/cli-lib/lib/table');
+const { getCwd } = require('@hubspot/cli-lib/path');
+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');
+
+exports.command = 'list-builds [path]';
+exports.describe = false;
+
+exports.handler = async options => {
+  await loadAndValidateOptions(options);
+
+  const { path: projectPath, limit } = options;
+  const accountId = getAccountId(options);
+
+  trackCommandUsage('project-list-builds', { projectPath }, accountId);
+
+  const cwd = projectPath ? path.resolve(getCwd(), projectPath) : getCwd();
+  const { projectConfig, projectDir } = await getProjectConfig(cwd);
+
+  validateProjectConfig(projectConfig, projectDir);
+
+  logger.debug(`Fetching builds for project at path: ${projectPath}`);
+
+  const fetchAndDisplayBuilds = async (project, options) => {
+    const { results, paging } = await fetchProjectBuilds(
+      accountId,
+      project.name,
+      options
+    );
+    const currentDeploy = project.deployedBuildId;
+    if (options && options.after) {
+      logger.log(
+        `Showing the next ${results.length} builds for ${project.name}`
+      );
+    } else {
+      logger.log(
+        `Showing the ${results.length} most recent builds for ${project.name}. ` +
+          uiLink(
+            'View all builds in project details.',
+            getProjectDetailUrl(project.name, accountId)
+          )
+      );
+    }
+
+    if (results.length === 0) {
+      logger.log('No builds found.');
+    } else {
+      const builds = results.map(build => {
+        const isCurrentlyDeployed = build.buildId === currentDeploy;
+
+        return [
+          isCurrentlyDeployed
+            ? `#${build.buildId} [deployed]`
+            : `#${build.buildId}`,
+          build.status,
+          moment(build.finishedAt).format('MM/DD/YY, hh:mm:ssa'),
+          Math.round(
+            moment
+              .duration(moment(build.finishedAt).diff(moment(build.enqueuedAt)))
+              .asSeconds()
+          ) + 's',
+          build.subbuildStatuses
+            .filter(subbuild => subbuild.status === 'FAILURE')
+            .map(subbuild => `${subbuild.buildName} failed`)
+            .join(', '),
+        ];
+      });
+      builds.unshift(
+        getTableHeader([
+          'Build ID',
+          'Status',
+          'Completed',
+          'Duration',
+          'Details',
+        ])
+      );
+      logger.log(
+        getTableContents(builds, {
+          columnDefault: {
+            paddingLeft: 3,
+          },
+        })
+      );
+    }
+    if (paging && paging.next) {
+      await prompt({
+        name: 'more',
+        message: 'Press <enter> to load more, or ctrl+c to exit',
+      });
+      await fetchAndDisplayBuilds(project, { limit, after: paging.next.after });
+    }
+  };
+
+  try {
+    const project = await fetchProject(accountId, projectConfig.name);
+
+    await fetchAndDisplayBuilds(project, { limit });
+  } catch (e) {
+    if (e.statusCode === 404) {
+      logger.error(`Project ${projectConfig.name} not found. `);
+    } else {
+      logApiErrorInstance(e, new ApiErrorContext({ accountId }));
+    }
+  }
+};
+
+exports.builder = yargs => {
+  yargs.positional('path', {
+    describe: 'Path to a project folder',
+    type: 'string',
+  });
+
+  yargs.options({
+    limit: {
+      describe: 'Max number of builds to load',
+      type: 'string',
+    },
+  });
+
+  yargs.example([
+    [
+      '$0 project list-builds myProjectFolder',
+      'Fetch a list of builds for a project within the myProjectFolder folder',
+    ],
+  ]);
+
+  addConfigOptions(yargs, true);
+  addAccountOptions(yargs, true);
+  addUseEnvironmentOptions(yargs, true);
+
+  return yargs;
+};