@hubspot/cli 3.0.12-beta.0 → 3.0.12-beta.1

package/commands/create/api-sample.js

@@ -10,7 +10,7 @@ const fs = require('fs-extra');
 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 { cloneGitHubRepo } = require('@hubspot/cli-lib/github');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
 const i18nKey = 'cli.commands.create.subcommands.apiSample';
@@ -60,7 +60,7 @@ module.exports = {
         sampleLanguage,
       })
     );
-    const created = await createProject(
+    const created = await cloneGitHubRepo(
       filePath,
       assetType,
       sampleType,

package/commands/create/app.js

@@ -1,8 +1,8 @@
-const { createProject } = require('@hubspot/cli-lib/projects');
+const { cloneGitHubRepo } = require('@hubspot/cli-lib/github');
 
 module.exports = {
   hidden: true,
   dest: ({ name, assetType }) => name || assetType,
   execute: async ({ options, dest, assetType }) =>
-    createProject(dest, assetType, 'crm-card-weather-app', '', options),
+    cloneGitHubRepo(dest, assetType, 'crm-card-weather-app', '', options),
 };

package/commands/create/react-app.js

@@ -1,7 +1,7 @@
-const { createProject } = require('@hubspot/cli-lib/projects');
+const { cloneGitHubRepo } = require('@hubspot/cli-lib/github');
 
 module.exports = {
   dest: ({ name, assetType }) => name || assetType,
   execute: async ({ options, dest, assetType }) =>
-    createProject(dest, assetType, 'cms-react-boilerplate', '', options),
+    cloneGitHubRepo(dest, assetType, 'cms-react-boilerplate', '', options),
 };

package/commands/create/vue-app.js

@@ -1,7 +1,7 @@
-const { createProject } = require('@hubspot/cli-lib/projects');
+const { cloneGitHubRepo } = require('@hubspot/cli-lib/github');
 
 module.exports = {
   dest: ({ name, assetType }) => name || assetType,
   execute: async ({ options, dest, assetType }) =>
-    createProject(dest, assetType, 'cms-vue-boilerplate', '', options),
+    cloneGitHubRepo(dest, assetType, 'cms-vue-boilerplate', '', options),
 };

package/commands/create/webpack-serverless.js

@@ -1,9 +1,9 @@
-const { createProject } = require('@hubspot/cli-lib/projects');
+const { cloneGitHubRepo } = require('@hubspot/cli-lib/github');
 
 module.exports = {
   dest: ({ name, assetType }) => name || assetType,
   execute: async ({ options, dest, assetType }) =>
-    createProject(
+    cloneGitHubRepo(
       dest,
       assetType,
       'cms-webpack-serverless-boilerplate',

package/commands/create/website-theme.js

@@ -1,4 +1,4 @@
-const { createProject } = require('@hubspot/cli-lib/projects');
+const { cloneGitHubRepo } = require('@hubspot/cli-lib/github');
 const { GITHUB_RELEASE_TYPES } = require('@hubspot/cli-lib/lib/constants');
 const { getIsInProject } = require('../../lib/projects');
 
@@ -14,6 +14,6 @@ module.exports = {
       // releaseType has to be 'REPOSITORY' to download a specific branch
       options.releaseType = GITHUB_RELEASE_TYPES.REPOSITORY;
     }
-    createProject(dest, assetType, 'cms-theme-boilerplate', 'src', options);
+    cloneGitHubRepo(dest, assetType, 'cms-theme-boilerplate', 'src', options);
   },
 };

package/commands/project/create.js

@@ -11,7 +11,10 @@ const path = require('path');
 const {
   createProjectPrompt,
 } = require('../../lib/prompts/createProjectPrompt');
-const { createProjectConfig } = require('../../lib/projects');
+const {
+  createProjectConfig,
+  showProjectWelcomeMessage,
+} = require('../../lib/projects');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
 const i18nKey = 'cli.commands.project.subcommands.create';
@@ -33,6 +36,8 @@ exports.handler = async options => {
     options.name || name,
     options.template || template
   );
+
+  showProjectWelcomeMessage();
 };
 
 exports.builder = yargs => {

package/commands/project/download.js

@@ -0,0 +1,127 @@
+const path = require('path');
+
+const {
+  getAccountId,
+  addUseEnvironmentOptions,
+} = require('../../lib/commonOpts');
+const { trackCommandUsage } = require('../../lib/usageTracking');
+const { getCwd } = require('@hubspot/cli-lib/path');
+const {
+  logApiErrorInstance,
+  ApiErrorContext,
+} = require('@hubspot/cli-lib/errorHandlers');
+const { logger } = require('@hubspot/cli-lib/logger');
+const { extractZipArchive } = require('@hubspot/cli-lib/archive');
+const {
+  downloadProject,
+  fetchProjectBuilds,
+} = require('@hubspot/cli-lib/api/dfs');
+const {
+  createProjectConfig,
+  ensureProjectExists,
+} = require('../../lib/projects');
+const { loadAndValidateOptions } = require('../../lib/validation');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.project.subcommands.download';
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
+
+exports.command = 'download <name> [dest]';
+exports.describe = i18n(`${i18nKey}.describe`);
+
+exports.handler = async options => {
+  await loadAndValidateOptions(options);
+
+  const { name: projectName, dest, buildNumber } = options;
+  const accountId = getAccountId(options);
+
+  trackCommandUsage('project-download', { projectName }, accountId);
+
+  await ensureProjectExists(accountId, projectName, { allowCreate: false });
+
+  const absoluteDestPath = dest ? path.resolve(getCwd(), dest) : getCwd();
+
+  const projectConfigCreated = await createProjectConfig(
+    absoluteDestPath,
+    projectName,
+    'none'
+  );
+
+  if (!projectConfigCreated) {
+    logger.log(i18n(`${i18nKey}.logs.downloadCancelled`));
+    process.exit(EXIT_CODES.SUCCESS);
+  }
+
+  let success = false;
+  let buildNumberToDownload = buildNumber;
+
+  if (!buildNumberToDownload) {
+    let projectBuildsResult;
+
+    try {
+      projectBuildsResult = await fetchProjectBuilds(accountId, projectName);
+    } catch (e) {
+      logApiErrorInstance(e, new ApiErrorContext({ accountId }));
+      process.exit(EXIT_CODES.ERROR);
+    }
+
+    const { results: projectBuilds } = projectBuildsResult;
+
+    if (projectBuilds && projectBuilds.length) {
+      const latestBuild = projectBuilds[0];
+      buildNumberToDownload = latestBuild.buildId;
+    }
+  }
+
+  const zippedProject = await downloadProject(
+    accountId,
+    projectName,
+    buildNumberToDownload
+  );
+
+  success = await extractZipArchive(
+    zippedProject,
+    projectName,
+    path.resolve(absoluteDestPath, 'src'),
+    {
+      includesRootDir: false,
+    }
+  );
+
+  if (!success) {
+    logger.log(i18n(`${i18nKey}.errors.downloadFailed`));
+    process.exit(EXIT_CODES.ERROR);
+  }
+
+  logger.log(
+    i18n(`${i18nKey}.logs.downloadSucceeded`, {
+      buildId: buildNumberToDownload,
+      projectName,
+    })
+  );
+  process.exit(EXIT_CODES.SUCCESS);
+};
+
+exports.builder = yargs => {
+  addUseEnvironmentOptions(yargs, true);
+
+  yargs.positional('name', {
+    describe: i18n(`${i18nKey}.positionals.name.describe`),
+    type: 'string',
+  });
+  yargs.positional('dest', {
+    describe: i18n(`${i18nKey}.positionals.dest.describe`),
+    type: 'string',
+  });
+  yargs.option('buildNumber', {
+    describe: i18n(`${i18nKey}.options.buildNumber.describe`),
+    type: 'number',
+  });
+  yargs.example([
+    [
+      '$0 project download myProject myProjectFolder',
+      i18n(`${i18nKey}.examples.default`),
+    ],
+  ]);
+  return yargs;
+};

package/commands/project/upload.js

@@ -37,7 +37,7 @@ exports.handler = async options => {
 
   validateProjectConfig(projectConfig, projectDir);
 
-  await ensureProjectExists(accountId, projectConfig.name, forceCreate);
+  await ensureProjectExists(accountId, projectConfig.name, { forceCreate });
 
   const startPolling = async (tempFile, buildId) => {
     let exitCode = EXIT_CODES.SUCCESS;

package/commands/project.js

@@ -5,6 +5,7 @@ const upload = require('./project/upload');
 const listBuilds = require('./project/listBuilds');
 const logs = require('./project/logs');
 const watch = require('./project/watch');
+const download = require('./project/download');
 
 exports.command = 'project';
 exports.describe = false; //'Commands for working with projects';
@@ -20,6 +21,7 @@ exports.builder = yargs => {
   yargs.command(watch).demandCommand(0, '');
   yargs.command(listBuilds).demandCommand(0, '');
   yargs.command(logs).demandCommand(1, '');
+  yargs.command(download).demandCommand(0, '');
 
   return yargs;
 };

package/lib/projects.js

@@ -7,15 +7,14 @@ const findup = require('findup-sync');
 const Spinnies = require('spinnies');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { getEnv } = require('@hubspot/cli-lib/lib/config');
-const {
-  createProject: createProjectTemplate,
-} = require('@hubspot/cli-lib/projects');
+const { cloneGitHubRepo } = require('@hubspot/cli-lib/github');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
 const {
   ENVIRONMENTS,
   POLLING_DELAY,
   PROJECT_TEMPLATES,
-  PROJECT_TEXT,
+  PROJECT_BUILD_TEXT,
+  PROJECT_DEPLOY_TEXT,
   PROJECT_CONFIG_FILE,
 } = require('@hubspot/cli-lib/lib/constants');
 const {
@@ -36,33 +35,6 @@ const { EXIT_CODES } = require('./enums/exitCodes');
 const { uiLine, uiAccountDescription } = require('../lib/ui');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
-const PROJECT_STRINGS = {
-  BUILD: {
-    INITIALIZE: (name, numOfComponents) =>
-      `Building ${chalk.bold(name)}\n\nFound ${numOfComponents} component${
-        numOfComponents !== 1 ? 's' : ''
-      } in this project ...\n`,
-    SUCCESS: name => `Built ${chalk.bold(name)}`,
-    FAIL: name => `Failed to build ${chalk.bold(name)}`,
-    SUBTASK_FAIL: (taskId, name) =>
-      `Build #${taskId} failed because there was a problem\nbuilding ${chalk.bold(
-        name
-      )}`,
-  },
-  DEPLOY: {
-    INITIALIZE: (name, numOfComponents) =>
-      `Deploying ${chalk.bold(name)}\n\nFound ${numOfComponents} component${
-        numOfComponents !== 1 ? 's' : ''
-      } in this project ...\n`,
-    SUCCESS: name => `Deployed ${chalk.bold(name)}`,
-    FAIL: name => `Failed to deploy ${chalk.bold(name)}`,
-    SUBTASK_FAIL: (taskId, name) =>
-      `Deploy for build #${taskId} failed because there was a\nproblem deploying ${chalk.bold(
-        name
-      )}`,
-  },
-};
-
 const writeProjectConfig = (configPath, config) => {
   try {
     fs.ensureFileSync(configPath);
@@ -131,14 +103,16 @@ const createProjectConfig = async (projectPath, projectName, template) => {
     ]);
 
     if (!shouldContinue) {
-      return;
+      return false;
     }
   }
 
   const projectConfigPath = path.join(projectPath, PROJECT_CONFIG_FILE);
 
   logger.log(
-    `Creating project in ${projectPath ? projectPath : 'the current folder'}`
+    `Creating project config in ${
+      projectPath ? projectPath : 'the current folder'
+    }`
   );
 
   if (template === 'none') {
@@ -149,7 +123,7 @@ const createProjectConfig = async (projectPath, projectName, template) => {
       srcDir: 'src',
     });
   } else {
-    await createProjectTemplate(
+    await cloneGitHubRepo(
       projectPath,
       'project',
       PROJECT_TEMPLATES.find(t => t.name === template).repo,
@@ -162,7 +136,7 @@ const createProjectConfig = async (projectPath, projectName, template) => {
     });
   }
 
-  return projectConfig;
+  return true;
 };
 
 const validateProjectConfig = (projectConfig, projectDir) => {
@@ -188,14 +162,18 @@ const validateProjectConfig = (projectConfig, projectDir) => {
   }
 };
 
-const ensureProjectExists = async (accountId, projectName, forceCreate) => {
+const ensureProjectExists = async (
+  accountId,
+  projectName,
+  { forceCreate, allowCreate } = { forceCreate: false, allowCreate: true }
+) => {
   try {
     await fetchProject(accountId, projectName);
   } catch (err) {
     if (err.statusCode === 404) {
       let shouldCreateProject = forceCreate;
 
-      if (!shouldCreateProject) {
+      if (allowCreate && !shouldCreateProject) {
         const promptResult = await promptUser([
           {
             name: 'shouldCreateProject',
@@ -338,12 +316,12 @@ const handleProjectUpload = async (
   archive.finalize();
 };
 
-const showWelcomeMessage = () => {
+const showProjectWelcomeMessage = () => {
   logger.log('');
   logger.log(chalk.bold('Welcome to HubSpot Developer Projects!'));
-  logger.log(
-    '\n-------------------------------------------------------------\n'
-  );
+  logger.log('\n');
+  uiLine();
+  logger.log('\n');
   logger.log(chalk.bold("What's next?\n"));
   logger.log('🎨 Add components to your project with `hs create`.\n');
   logger.log(
@@ -355,35 +333,22 @@ const showWelcomeMessage = () => {
   logger.log(
     `🔗 Use \`hs project --help\` to learn more about available commands.\n`
   );
-  logger.log('-------------------------------------------------------------');
+  uiLine();
 };
 
-const makeGetTaskStatus = taskType => {
-  let statusFn, statusText, statusStrings;
-  switch (taskType) {
-    case 'build':
-      statusFn = getBuildStatus;
-      statusText = PROJECT_TEXT.BUILD;
-      statusStrings = PROJECT_STRINGS.BUILD;
-      break;
-    case 'deploy':
-      statusFn = getDeployStatus;
-      statusText = PROJECT_TEXT.DEPLOY;
-      statusStrings = PROJECT_STRINGS.DEPLOY;
-      break;
-    default:
-      logger.error(`Cannot get status for task type ${taskType}`);
-  }
+const makePollTaskStatusFunc = ({ statusFn, statusText, statusStrings }) => {
+  const isTaskComplete = task => {
+    if (
+      !task[statusText.SUBTASK_KEY].length ||
+      task.status === statusText.STATES.FAILURE
+    ) {
+      return true;
+    } else if (task.status === statusText.STATES.SUCCESS) {
+      return task.isAutoDeployEnabled ? !!task.deployStatusTaskLocator : true;
+    }
+  };
 
   return async (accountId, taskName, taskId, buildId) => {
-    const isTaskComplete = task => {
-      if (task.status === statusText.STATES.FAILURE) {
-        return true;
-      } else if (task.status === statusText.STATES.SUCCESS) {
-        return task.isAutoDeployEnabled ? !!task.deployStatusTaskLocator : true;
-      }
-    };
-
     const spinnies = new Spinnies({
       succeedColor: 'white',
       failColor: 'white',
@@ -402,9 +367,12 @@ const makeGetTaskStatus = taskType => {
     });
 
     for (let subTask of initialTaskStatus[statusText.SUBTASK_KEY]) {
-      spinnies.add(subTask[statusText.SUBTASK_NAME_KEY], {
-        text: `${chalk.bold(subTask[statusText.SUBTASK_NAME_KEY])} #${buildId ||
-          taskId} ${statusText.STATUS_TEXT[statusText.STATES.ENQUEUED]}\n`,
+      const subTaskName = subTask[statusText.SUBTASK_NAME_KEY];
+
+      spinnies.add(subTaskName, {
+        text: `${chalk.bold(subTaskName)} #${buildId || taskId} ${
+          statusText.STATUS_TEXT[statusText.STATES.ENQUEUED]
+        }\n`,
       });
     }
 
@@ -418,29 +386,25 @@ const makeGetTaskStatus = taskType => {
 
         if (spinnies.hasActiveSpinners()) {
           subTaskStatus.forEach(subTask => {
-            if (!spinnies.pick(subTask[statusText.SUBTASK_NAME_KEY])) {
+            const subTaskName = subTask[statusText.SUBTASK_NAME_KEY];
+
+            if (!spinnies.pick(subTaskName)) {
               return;
             }
 
-            const updatedText = `${chalk.bold(
-              subTask[statusText.SUBTASK_NAME_KEY]
-            )} #${taskId} ${statusText.STATUS_TEXT[subTask.status]}\n`;
+            const updatedText = `${chalk.bold(subTaskName)} #${taskId} ${
+              statusText.STATUS_TEXT[subTask.status]
+            }\n`;
 
             switch (subTask.status) {
               case statusText.STATES.SUCCESS:
-                spinnies.succeed(subTask[statusText.SUBTASK_NAME_KEY], {
-                  text: updatedText,
-                });
+                spinnies.succeed(subTaskName, { text: updatedText });
                 break;
               case statusText.STATES.FAILURE:
-                spinnies.fail(subTask[statusText.SUBTASK_NAME_KEY], {
-                  text: updatedText,
-                });
+                spinnies.fail(subTaskName, { text: updatedText });
                 break;
               default:
-                spinnies.update(subTask[statusText.SUBTASK_NAME_KEY], {
-                  text: updatedText,
-                });
+                spinnies.update(subTaskName, { text: updatedText });
                 break;
             }
           });
@@ -494,6 +458,40 @@ const makeGetTaskStatus = taskType => {
   };
 };
 
+const pollBuildStatus = makePollTaskStatusFunc({
+  statusFn: getBuildStatus,
+  statusText: PROJECT_BUILD_TEXT,
+  statusStrings: {
+    INITIALIZE: (name, numOfComponents) =>
+      `Building ${chalk.bold(name)}\n\nFound ${numOfComponents} component${
+        numOfComponents !== 1 ? 's' : ''
+      } in this project ...\n`,
+    SUCCESS: name => `Built ${chalk.bold(name)}`,
+    FAIL: name => `Failed to build ${chalk.bold(name)}`,
+    SUBTASK_FAIL: (taskId, name) =>
+      `Build #${taskId} failed because there was a problem\nbuilding ${chalk.bold(
+        name
+      )}`,
+  },
+});
+
+const pollDeployStatus = makePollTaskStatusFunc({
+  statusFn: getDeployStatus,
+  statusText: PROJECT_DEPLOY_TEXT,
+  statusStrings: {
+    INITIALIZE: (name, numOfComponents) =>
+      `Deploying ${chalk.bold(name)}\n\nFound ${numOfComponents} component${
+        numOfComponents !== 1 ? 's' : ''
+      } in this project ...\n`,
+    SUCCESS: name => `Deployed ${chalk.bold(name)}`,
+    FAIL: name => `Failed to deploy ${chalk.bold(name)}`,
+    SUBTASK_FAIL: (taskId, name) =>
+      `Deploy for build #${taskId} failed because there was a\nproblem deploying ${chalk.bold(
+        name
+      )}`,
+  },
+});
+
 module.exports = {
   writeProjectConfig,
   getProjectConfig,
@@ -501,9 +499,9 @@ module.exports = {
   handleProjectUpload,
   createProjectConfig,
   validateProjectConfig,
-  showWelcomeMessage,
+  showProjectWelcomeMessage,
   getProjectDetailUrl,
-  pollBuildStatus: makeGetTaskStatus('build'),
-  pollDeployStatus: makeGetTaskStatus('deploy'),
+  pollBuildStatus,
+  pollDeployStatus,
   ensureProjectExists,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/cli",
-  "version": "3.0.12-beta.0",
+  "version": "3.0.12-beta.1",
   "description": "CLI for working with HubSpot",
   "license": "Apache-2.0",
   "repository": {
@@ -8,8 +8,8 @@
     "url": "https://github.com/HubSpot/hubspot-cms-tools"
   },
   "dependencies": {
-    "@hubspot/cli-lib": "^3.0.12-beta.0",
-    "@hubspot/serverless-dev-runtime": "^3.0.12-beta.0",
+    "@hubspot/cli-lib": "^3.0.12-beta.1",
+    "@hubspot/serverless-dev-runtime": "^3.0.12-beta.1",
     "archiver": "^5.3.0",
     "chalk": "^4.1.2",
     "express": "^4.17.1",
@@ -39,5 +39,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "cb056da116cf2f64b7e2f7df69f44e5a19d03527"
+  "gitHead": "01b4b086b16f92ec7a0c5022ed0beb4de6a16ae7"
 }