@hubspot/cli 6.2.0 → 6.2.2-experimental.0

package/commands/project/dev.js

@@ -1,247 +1,143 @@
-const {
-  addAccountOptions,
-  addConfigOptions,
-  getAccountId,
-  addUseEnvironmentOptions,
-  addTestingOptions,
-} = require('../../lib/commonOpts');
+"use strict";
+const { addAccountOptions, addConfigOptions, getAccountId, addUseEnvironmentOptions, addTestingOptions, } = require('../../lib/commonOpts');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { handleExit } = require('../../lib/process');
 const { i18n } = require('../../lib/lang');
 const { logger } = require('@hubspot/local-dev-lib/logger');
-const {
-  getConfigAccounts,
-  getAccountConfig,
-  getEnv,
-} = require('@hubspot/local-dev-lib/config');
-const {
-  getProjectConfig,
-  ensureProjectExists,
-  validateProjectConfig,
-} = require('../../lib/projects');
+const { getConfigAccounts, getAccountConfig, getEnv, } = require('@hubspot/local-dev-lib/config');
+const { getProjectConfig, ensureProjectExists, validateProjectConfig, } = require('../../lib/projects');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 const { uiBetaTag, uiCommandReference, uiLink } = require('../../lib/ui');
 const SpinniesManager = require('../../lib/ui/SpinniesManager');
 const LocalDevManager = require('../../lib/LocalDevManager');
-const {
-  isSandbox,
-  isDeveloperTestAccount,
-  isStandardAccount,
-  isAppDeveloperAccount,
-} = require('../../lib/accountTypes');
+const { isSandbox, isDeveloperTestAccount, isStandardAccount, isAppDeveloperAccount, } = require('../../lib/accountTypes');
 const { getValidEnv } = require('@hubspot/local-dev-lib/environment');
-
-const {
-  findProjectComponents,
-  getProjectComponentTypes,
-  COMPONENT_TYPES,
-} = require('../../lib/projectStructure');
-const {
-  confirmDefaultAccountIsTarget,
-  suggestRecommendedNestedAccount,
-  checkIfDefaultAccountIsSupported,
-  createSandboxForLocalDev,
-  createDeveloperTestAccountForLocalDev,
-  createNewProjectForLocalDev,
-  createInitialBuildForNewProject,
-  useExistingDevTestAccount,
-  checkIfAccountFlagIsSupported,
-  checkIfParentAccountIsAuthed,
-} = require('../../lib/localDev');
-
+const { findProjectComponents, getProjectComponentTypes, COMPONENT_TYPES, } = require('../../lib/projectStructure');
+const { confirmDefaultAccountIsTarget, suggestRecommendedNestedAccount, checkIfDefaultAccountIsSupported, createSandboxForLocalDev, createDeveloperTestAccountForLocalDev, createNewProjectForLocalDev, createInitialBuildForNewProject, useExistingDevTestAccount, checkIfAccountFlagIsSupported, checkIfParentAccountIsAuthed, } = require('../../lib/localDev');
 const i18nKey = 'commands.project.subcommands.dev';
-
 exports.command = 'dev [--account]';
 exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
-
-exports.handler = async options => {
-  await loadAndValidateOptions(options);
-  const accountId = getAccountId(options);
-  const accountConfig = getAccountConfig(accountId);
-  const env = getValidEnv(getEnv(accountId));
-
-  trackCommandUsage('project-dev', null, accountId);
-
-  const { projectConfig, projectDir } = await getProjectConfig();
-
-  uiBetaTag(i18n(`${i18nKey}.logs.betaMessage`));
-
-  logger.log(
-    uiLink(
-      i18n(`${i18nKey}.logs.learnMoreLocalDevServer`),
-      'https://developers.hubspot.com/docs/platform/project-cli-commands#start-a-local-development-server'
-    )
-  );
-
-  if (!projectConfig) {
-    logger.error(i18n(`${i18nKey}.errors.noProjectConfig`));
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  validateProjectConfig(projectConfig, projectDir);
-
-  const components = await findProjectComponents(projectDir);
-  const runnableComponents = components.filter(component => component.runnable);
-  const componentTypes = getProjectComponentTypes(runnableComponents);
-  const hasPrivateApps = !!componentTypes[COMPONENT_TYPES.privateApp];
-  const hasPublicApps = !!componentTypes[COMPONENT_TYPES.publicApp];
-
-  if (runnableComponents.length === 0) {
-    logger.error(
-      i18n(`${i18nKey}.errors.noRunnableComponents`, {
-        projectDir,
-        command: uiCommandReference('hs project add'),
-      })
-    );
-    process.exit(EXIT_CODES.SUCCESS);
-  } else if (hasPrivateApps && hasPublicApps) {
-    logger.error(i18n(`${i18nKey}.errors.invalidProjectComponents`));
-    process.exit(EXIT_CODES.SUCCESS);
-  }
-
-  const accounts = getConfigAccounts();
-
-  const defaultAccountIsRecommendedType =
-    isDeveloperTestAccount(accountConfig) ||
-    (!hasPublicApps && isSandbox(accountConfig));
-
-  // The account that the project must exist in
-  let targetProjectAccountId = options.account ? accountId : null;
-  // The account that we are locally testing against
-  let targetTestingAccountId = options.account ? accountId : null;
-
-  // Check that the default account or flag option is valid for the type of app in this project
-  if (options.account) {
-    checkIfAccountFlagIsSupported(accountConfig, hasPublicApps);
-
-    if (hasPublicApps) {
-      targetProjectAccountId = accountConfig.parentAccountId;
+exports.handler = async (options) => {
+    await loadAndValidateOptions(options);
+    const accountId = getAccountId(options);
+    const accountConfig = getAccountConfig(accountId);
+    const env = getValidEnv(getEnv(accountId));
+    trackCommandUsage('project-dev', null, accountId);
+    const { projectConfig, projectDir } = await getProjectConfig();
+    uiBetaTag(i18n(`${i18nKey}.logs.betaMessage`));
+    logger.log(uiLink(i18n(`${i18nKey}.logs.learnMoreLocalDevServer`), 'https://developers.hubspot.com/docs/platform/project-cli-commands#start-a-local-development-server'));
+    if (!projectConfig) {
+        logger.error(i18n(`${i18nKey}.errors.noProjectConfig`));
+        process.exit(EXIT_CODES.ERROR);
+    }
+    validateProjectConfig(projectConfig, projectDir);
+    const components = await findProjectComponents(projectDir);
+    const runnableComponents = components.filter(component => component.runnable);
+    const componentTypes = getProjectComponentTypes(runnableComponents);
+    const hasPrivateApps = !!componentTypes[COMPONENT_TYPES.privateApp];
+    const hasPublicApps = !!componentTypes[COMPONENT_TYPES.publicApp];
+    if (runnableComponents.length === 0) {
+        logger.error(i18n(`${i18nKey}.errors.noRunnableComponents`, {
+            projectDir,
+            command: uiCommandReference('hs project add'),
+        }));
+        process.exit(EXIT_CODES.SUCCESS);
+    }
+    else if (hasPrivateApps && hasPublicApps) {
+        logger.error(i18n(`${i18nKey}.errors.invalidProjectComponents`));
+        process.exit(EXIT_CODES.SUCCESS);
+    }
+    const accounts = getConfigAccounts();
+    const defaultAccountIsRecommendedType = isDeveloperTestAccount(accountConfig) ||
+        (!hasPublicApps && isSandbox(accountConfig));
+    // The account that the project must exist in
+    let targetProjectAccountId = options.account ? accountId : null;
+    // The account that we are locally testing against
+    let targetTestingAccountId = options.account ? accountId : null;
+    // Check that the default account or flag option is valid for the type of app in this project
+    if (options.account) {
+        checkIfAccountFlagIsSupported(accountConfig, hasPublicApps);
+        if (hasPublicApps) {
+            targetProjectAccountId = accountConfig.parentAccountId;
+        }
+    }
+    else {
+        checkIfDefaultAccountIsSupported(accountConfig, hasPublicApps);
     }
-  } else {
-    checkIfDefaultAccountIsSupported(accountConfig, hasPublicApps);
-  }
-
-  // The user is targeting an account type that we recommend developing on
-  if (!targetProjectAccountId && defaultAccountIsRecommendedType) {
-    targetTestingAccountId = accountId;
-
-    await confirmDefaultAccountIsTarget(accountConfig, hasPublicApps);
-
-    if (hasPublicApps) {
-      checkIfParentAccountIsAuthed(accountConfig);
-      targetProjectAccountId = accountConfig.parentAccountId;
-    } else {
-      targetProjectAccountId = accountId;
+    // The user is targeting an account type that we recommend developing on
+    if (!targetProjectAccountId && defaultAccountIsRecommendedType) {
+        targetTestingAccountId = accountId;
+        await confirmDefaultAccountIsTarget(accountConfig, hasPublicApps);
+        if (hasPublicApps) {
+            checkIfParentAccountIsAuthed(accountConfig);
+            targetProjectAccountId = accountConfig.parentAccountId;
+        }
+        else {
+            targetProjectAccountId = accountId;
+        }
     }
-  }
-
-  let createNewSandbox = false;
-  let createNewDeveloperTestAccount = false;
-
-  if (!targetProjectAccountId) {
-    const {
-      targetAccountId,
-      parentAccountId,
-      createNestedAccount,
-      notInConfigAccount,
-    } = await suggestRecommendedNestedAccount(
-      accounts,
-      accountConfig,
-      hasPublicApps
-    );
-
-    targetProjectAccountId = hasPublicApps ? parentAccountId : targetAccountId;
-    targetTestingAccountId = targetAccountId;
-
-    // Only used for developer test accounts that are not yet in the config
-    if (notInConfigAccount) {
-      await useExistingDevTestAccount(env, notInConfigAccount);
+    let createNewSandbox = false;
+    let createNewDeveloperTestAccount = false;
+    if (!targetProjectAccountId) {
+        const { targetAccountId, parentAccountId, createNestedAccount, notInConfigAccount, } = await suggestRecommendedNestedAccount(accounts, accountConfig, hasPublicApps);
+        targetProjectAccountId = hasPublicApps ? parentAccountId : targetAccountId;
+        targetTestingAccountId = targetAccountId;
+        // Only used for developer test accounts that are not yet in the config
+        if (notInConfigAccount) {
+            await useExistingDevTestAccount(env, notInConfigAccount);
+        }
+        createNewSandbox = isStandardAccount(accountConfig) && createNestedAccount;
+        createNewDeveloperTestAccount =
+            isAppDeveloperAccount(accountConfig) && createNestedAccount;
     }
-
-    createNewSandbox = isStandardAccount(accountConfig) && createNestedAccount;
-    createNewDeveloperTestAccount =
-      isAppDeveloperAccount(accountConfig) && createNestedAccount;
-  }
-
-  if (createNewSandbox) {
-    targetProjectAccountId = await createSandboxForLocalDev(
-      accountId,
-      accountConfig,
-      env
-    );
-    // We will be running our tests against this new sandbox account
-    targetTestingAccountId = targetProjectAccountId;
-  }
-  if (createNewDeveloperTestAccount) {
-    targetTestingAccountId = await createDeveloperTestAccountForLocalDev(
-      accountId,
-      accountConfig,
-      env
-    );
-    targetProjectAccountId = accountId;
-  }
-
-  let { projectExists, project } = await ensureProjectExists(
-    targetProjectAccountId,
-    projectConfig.name,
-    {
-      allowCreate: false,
-      noLogs: true,
-      withPolling: createNewSandbox,
+    if (createNewSandbox) {
+        targetProjectAccountId = await createSandboxForLocalDev(accountId, accountConfig, env);
+        // We will be running our tests against this new sandbox account
+        targetTestingAccountId = targetProjectAccountId;
     }
-  );
-
-  let deployedBuild;
-  let isGithubLinked;
-
-  SpinniesManager.init();
-
-  if (projectExists) {
-    deployedBuild = project.deployedBuild;
-    isGithubLinked =
-      project.sourceIntegration &&
-      project.sourceIntegration.source === 'GITHUB';
-  } else {
-    project = await createNewProjectForLocalDev(
-      projectConfig,
-      targetProjectAccountId,
-      createNewSandbox,
-      hasPublicApps
-    );
-
-    deployedBuild = await createInitialBuildForNewProject(
-      projectConfig,
-      projectDir,
-      targetProjectAccountId
-    );
-  }
-
-  const LocalDev = new LocalDevManager({
-    runnableComponents,
-    debug: options.debug,
-    deployedBuild,
-    isGithubLinked,
-    parentAccountId: targetProjectAccountId,
-    projectConfig,
-    projectDir,
-    projectId: project.id,
-    targetAccountId: targetTestingAccountId,
-    env,
-  });
-
-  await LocalDev.start();
-
-  handleExit(({ isSIGHUP }) => LocalDev.stop(!isSIGHUP));
+    if (createNewDeveloperTestAccount) {
+        targetTestingAccountId = await createDeveloperTestAccountForLocalDev(accountId, accountConfig, env);
+        targetProjectAccountId = accountId;
+    }
+    let { projectExists, project } = await ensureProjectExists(targetProjectAccountId, projectConfig.name, {
+        allowCreate: false,
+        noLogs: true,
+        withPolling: createNewSandbox,
+    });
+    let deployedBuild;
+    let isGithubLinked;
+    SpinniesManager.init();
+    if (projectExists) {
+        deployedBuild = project.deployedBuild;
+        isGithubLinked =
+            project.sourceIntegration &&
+                project.sourceIntegration.source === 'GITHUB';
+    }
+    else {
+        project = await createNewProjectForLocalDev(projectConfig, targetProjectAccountId, createNewSandbox, hasPublicApps);
+        deployedBuild = await createInitialBuildForNewProject(projectConfig, projectDir, targetProjectAccountId);
+    }
+    const LocalDev = new LocalDevManager({
+        runnableComponents,
+        debug: options.debug,
+        deployedBuild,
+        isGithubLinked,
+        parentAccountId: targetProjectAccountId,
+        projectConfig,
+        projectDir,
+        projectId: project.id,
+        targetAccountId: targetTestingAccountId,
+        env,
+    });
+    await LocalDev.start();
+    handleExit(({ isSIGHUP }) => LocalDev.stop(!isSIGHUP));
 };
-
 exports.builder = yargs => {
-  addConfigOptions(yargs);
-  addAccountOptions(yargs);
-  addUseEnvironmentOptions(yargs);
-  addTestingOptions(yargs);
-
-  yargs.example([['$0 project dev', i18n(`${i18nKey}.examples.default`)]]);
-
-  return yargs;
+    addConfigOptions(yargs);
+    addAccountOptions(yargs);
+    addUseEnvironmentOptions(yargs);
+    addTestingOptions(yargs);
+    yargs.example([['$0 project dev', i18n(`${i18nKey}.examples.default`)]]);
+    return yargs;
 };

package/commands/project/download.d.ts

@@ -0,0 +1,4 @@
+export const command: "download [--project]";
+export const describe: string | undefined;
+export function handler(options: any): Promise<never>;
+export function builder(yargs: any): any;

package/commands/project/download.js

@@ -1,143 +1,91 @@
+"use strict";
 const path = require('path');
 const chalk = require('chalk');
-
-const {
-  getAccountId,
-  addUseEnvironmentOptions,
-} = require('../../lib/commonOpts');
+const { getAccountId, addUseEnvironmentOptions, } = require('../../lib/commonOpts');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { getCwd, sanitizeFileName } = require('@hubspot/local-dev-lib/path');
 const { logError, ApiErrorContext } = require('../../lib/errorHandlers/index');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { extractZipArchive } = require('@hubspot/local-dev-lib/archive');
-const {
-  downloadProject,
-  fetchProjectBuilds,
-} = require('@hubspot/local-dev-lib/api/projects');
+const { downloadProject, fetchProjectBuilds, } = require('@hubspot/local-dev-lib/api/projects');
 const { ensureProjectExists, getProjectConfig } = require('../../lib/projects');
 const { loadAndValidateOptions } = require('../../lib/validation');
-const {
-  downloadProjectPrompt,
-} = require('../../lib/prompts/downloadProjectPrompt');
+const { downloadProjectPrompt, } = require('../../lib/prompts/downloadProjectPrompt');
 const { i18n } = require('../../lib/lang');
 const { uiBetaTag } = require('../../lib/ui');
-
 const i18nKey = 'commands.project.subcommands.download';
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-
 exports.command = 'download [--project]';
 exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
-
-exports.handler = async options => {
-  await loadAndValidateOptions(options);
-
-  const { projectConfig } = await getProjectConfig();
-
-  if (projectConfig) {
-    logger.error(i18n(`${i18nKey}.warnings.cannotDownloadWithinProject`));
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  const { project, dest, buildNumber } = options;
-  let { project: promptedProjectName } = await downloadProjectPrompt(options);
-  let projectName = promptedProjectName || project;
-
-  const accountId = getAccountId(options);
-
-  trackCommandUsage('project-download', null, accountId);
-
-  try {
-    const { projectExists } = await ensureProjectExists(
-      accountId,
-      projectName,
-      {
-        allowCreate: false,
-        noLogs: true,
-      }
-    );
-
-    if (!projectExists) {
-      logger.error(
-        i18n(`${i18nKey}.errors.projectNotFound`, {
-          projectName: chalk.bold(projectName),
-          accountId: chalk.bold(accountId),
-        })
-      );
-      let { name: promptedProjectName } = await downloadProjectPrompt(options);
-      projectName = promptedProjectName || project;
+exports.handler = async (options) => {
+    await loadAndValidateOptions(options);
+    const { projectConfig } = await getProjectConfig();
+    if (projectConfig) {
+        logger.error(i18n(`${i18nKey}.warnings.cannotDownloadWithinProject`));
+        process.exit(EXIT_CODES.ERROR);
     }
-
-    const absoluteDestPath = dest ? path.resolve(getCwd(), dest) : getCwd();
-
-    let buildNumberToDownload = buildNumber;
-
-    if (!buildNumberToDownload) {
-      const { data: projectBuildsResult } = await fetchProjectBuilds(
-        accountId,
-        projectName
-      );
-
-      const { results: projectBuilds } = projectBuildsResult;
-
-      if (projectBuilds && projectBuilds.length) {
-        const latestBuild = projectBuilds[0];
-        buildNumberToDownload = latestBuild.buildId;
-      }
+    const { project, dest, buildNumber } = options;
+    let { project: promptedProjectName } = await downloadProjectPrompt(options);
+    let projectName = promptedProjectName || project;
+    const accountId = getAccountId(options);
+    trackCommandUsage('project-download', null, accountId);
+    try {
+        const { projectExists } = await ensureProjectExists(accountId, projectName, {
+            allowCreate: false,
+            noLogs: true,
+        });
+        if (!projectExists) {
+            logger.error(i18n(`${i18nKey}.errors.projectNotFound`, {
+                projectName: chalk.bold(projectName),
+                accountId: chalk.bold(accountId),
+            }));
+            let { name: promptedProjectName } = await downloadProjectPrompt(options);
+            projectName = promptedProjectName || project;
+        }
+        const absoluteDestPath = dest ? path.resolve(getCwd(), dest) : getCwd();
+        let buildNumberToDownload = buildNumber;
+        if (!buildNumberToDownload) {
+            const { data: projectBuildsResult } = await fetchProjectBuilds(accountId, projectName);
+            const { results: projectBuilds } = projectBuildsResult;
+            if (projectBuilds && projectBuilds.length) {
+                const latestBuild = projectBuilds[0];
+                buildNumberToDownload = latestBuild.buildId;
+            }
+        }
+        const { data: zippedProject } = await downloadProject(accountId, projectName, buildNumberToDownload);
+        await extractZipArchive(zippedProject, sanitizeFileName(projectName), path.resolve(absoluteDestPath), { includesRootDir: false });
+        logger.log(i18n(`${i18nKey}.logs.downloadSucceeded`, {
+            buildId: buildNumberToDownload,
+            projectName,
+        }));
+        process.exit(EXIT_CODES.SUCCESS);
+    }
+    catch (e) {
+        logError(e, new ApiErrorContext({ accountId, request: 'project download' }));
+        process.exit(EXIT_CODES.ERROR);
     }
-
-    const { data: zippedProject } = await downloadProject(
-      accountId,
-      projectName,
-      buildNumberToDownload
-    );
-
-    await extractZipArchive(
-      zippedProject,
-      sanitizeFileName(projectName),
-      path.resolve(absoluteDestPath),
-      { includesRootDir: false }
-    );
-
-    logger.log(
-      i18n(`${i18nKey}.logs.downloadSucceeded`, {
-        buildId: buildNumberToDownload,
-        projectName,
-      })
-    );
-    process.exit(EXIT_CODES.SUCCESS);
-  } catch (e) {
-    logError(
-      e,
-      new ApiErrorContext({ accountId, request: 'project download' })
-    );
-    process.exit(EXIT_CODES.ERROR);
-  }
 };
-
 exports.builder = yargs => {
-  addUseEnvironmentOptions(yargs);
-
-  yargs.options({
-    project: {
-      describe: i18n(`${i18nKey}.options.project.describe`),
-      type: 'string',
-    },
-    dest: {
-      describe: i18n(`${i18nKey}.options.dest.describe`),
-      type: 'string',
-    },
-    buildNumber: {
-      describe: i18n(`${i18nKey}.options.buildNumber.describe`),
-      type: 'number',
-    },
-  });
-
-  yargs.example([
-    [
-      '$0 project download --project=myProject --dest=myProjectFolder',
-      i18n(`${i18nKey}.examples.default`),
-    ],
-  ]);
-
-  return yargs;
+    addUseEnvironmentOptions(yargs);
+    yargs.options({
+        project: {
+            describe: i18n(`${i18nKey}.options.project.describe`),
+            type: 'string',
+        },
+        dest: {
+            describe: i18n(`${i18nKey}.options.dest.describe`),
+            type: 'string',
+        },
+        buildNumber: {
+            describe: i18n(`${i18nKey}.options.buildNumber.describe`),
+            type: 'number',
+        },
+    });
+    yargs.example([
+        [
+            '$0 project download --project=myProject --dest=myProjectFolder',
+            i18n(`${i18nKey}.examples.default`),
+        ],
+    ]);
+    return yargs;
 };

package/commands/project/installDeps.d.ts

@@ -0,0 +1,6 @@
+export const command: "install-deps [packages..]";
+export const describe: any;
+export function handler({ packages }: {
+    packages: any;
+}): Promise<undefined>;
+export function builder(yargs: any): void;