@hubspot/cli 6.2.0 → 6.2.2-experimental.0

package/commands/project/add.js

@@ -1,86 +1,61 @@
+"use strict";
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { getAccountId } = require('@hubspot/local-dev-lib/config');
 const { logError } = require('../../lib/errorHandlers/index');
 const { fetchReleaseData } = require('@hubspot/local-dev-lib/github');
-
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { i18n } = require('../../lib/lang');
 const { projectAddPrompt } = require('../../lib/prompts/projectAddPrompt');
-const {
-  createProjectComponent,
-  getProjectComponentsByVersion,
-} = require('../../lib/projects');
+const { createProjectComponent, getProjectComponentsByVersion, } = require('../../lib/projects');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { uiBetaTag } = require('../../lib/ui');
-const {
-  HUBSPOT_PROJECT_COMPONENTS_GITHUB_PATH,
-} = require('../../lib/constants');
-
+const { HUBSPOT_PROJECT_COMPONENTS_GITHUB_PATH, } = require('../../lib/constants');
 const i18nKey = 'commands.project.subcommands.add';
-
 exports.command = 'add';
 exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
-
-exports.handler = async options => {
-  await loadAndValidateOptions(options);
-
-  logger.log('');
-  logger.log(i18n(`${i18nKey}.creatingComponent.message`));
-  logger.log('');
-
-  const accountId = getAccountId(options);
-
-  const releaseData = await fetchReleaseData(
-    HUBSPOT_PROJECT_COMPONENTS_GITHUB_PATH
-  );
-  const projectComponentsVersion = releaseData.tag_name;
-
-  const components = await getProjectComponentsByVersion(
-    projectComponentsVersion
-  );
-
-  let { component, name } = await projectAddPrompt(components, options);
-
-  name = name || options.name;
-
-  if (!component) {
-    component = components.find(t => t.path === options.type);
-  }
-
-  trackCommandUsage('project-add', null, accountId);
-
-  try {
-    await createProjectComponent(component, name, projectComponentsVersion);
+exports.handler = async (options) => {
+    await loadAndValidateOptions(options);
     logger.log('');
-    logger.log(
-      i18n(`${i18nKey}.success.message`, {
-        componentName: name,
-      })
-    );
-  } catch (error) {
-    logError(error);
-  }
+    logger.log(i18n(`${i18nKey}.creatingComponent.message`));
+    logger.log('');
+    const accountId = getAccountId(options);
+    const releaseData = await fetchReleaseData(HUBSPOT_PROJECT_COMPONENTS_GITHUB_PATH);
+    const projectComponentsVersion = releaseData.tag_name;
+    const components = await getProjectComponentsByVersion(projectComponentsVersion);
+    let { component, name } = await projectAddPrompt(components, options);
+    name = name || options.name;
+    if (!component) {
+        component = components.find(t => t.path === options.type);
+    }
+    trackCommandUsage('project-add', null, accountId);
+    try {
+        await createProjectComponent(component, name, projectComponentsVersion);
+        logger.log('');
+        logger.log(i18n(`${i18nKey}.success.message`, {
+            componentName: name,
+        }));
+    }
+    catch (error) {
+        logError(error);
+    }
 };
-
 exports.builder = yargs => {
-  yargs.options({
-    type: {
-      describe: i18n(`${i18nKey}.options.type.describe`),
-      type: 'string',
-    },
-    name: {
-      describe: i18n(`${i18nKey}.options.name.describe`),
-      type: 'string',
-    },
-  });
-
-  yargs.example([['$0 project add', i18n(`${i18nKey}.examples.default`)]]);
-  yargs.example([
-    [
-      '$0 project add --name="my-component" --type="components/example-app"',
-      i18n(`${i18nKey}.examples.withFlags`),
-    ],
-  ]);
-
-  return yargs;
+    yargs.options({
+        type: {
+            describe: i18n(`${i18nKey}.options.type.describe`),
+            type: 'string',
+        },
+        name: {
+            describe: i18n(`${i18nKey}.options.name.describe`),
+            type: 'string',
+        },
+    });
+    yargs.example([['$0 project add', i18n(`${i18nKey}.examples.default`)]]);
+    yargs.example([
+        [
+            '$0 project add --name="my-component" --type="components/example-app"',
+            i18n(`${i18nKey}.examples.withFlags`),
+        ],
+    ]);
+    return yargs;
 };

package/commands/project/cloneApp.d.ts

@@ -0,0 +1,4 @@
+export const command: "clone-app";
+export const describe: string | undefined;
+export function handler(options: any): Promise<void>;
+export function builder(yargs: any): any;

package/commands/project/cloneApp.js

@@ -1,205 +1,142 @@
+"use strict";
 const path = require('path');
 const fs = require('fs');
-const {
-  addAccountOptions,
-  addConfigOptions,
-  getAccountId,
-  addUseEnvironmentOptions,
-} = require('../../lib/commonOpts');
-const {
-  trackCommandUsage,
-  trackCommandMetadataUsage,
-} = require('../../lib/usageTracking');
+const { addAccountOptions, addConfigOptions, getAccountId, addUseEnvironmentOptions, } = require('../../lib/commonOpts');
+const { trackCommandUsage, trackCommandMetadataUsage, } = require('../../lib/usageTracking');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { i18n } = require('../../lib/lang');
-const {
-  selectPublicAppPrompt,
-} = require('../../lib/prompts/selectPublicAppPrompt');
-const {
-  createProjectPrompt,
-} = require('../../lib/prompts/createProjectPrompt');
+const { selectPublicAppPrompt, } = require('../../lib/prompts/selectPublicAppPrompt');
+const { createProjectPrompt, } = require('../../lib/prompts/createProjectPrompt');
 const { poll } = require('../../lib/polling');
-const {
-  uiBetaTag,
-  uiLine,
-  uiCommandReference,
-  uiAccountDescription,
-} = require('../../lib/ui');
+const { uiBetaTag, uiLine, uiCommandReference, uiAccountDescription, } = require('../../lib/ui');
 const SpinniesManager = require('../../lib/ui/SpinniesManager');
 const { logError, ApiErrorContext } = require('../../lib/errorHandlers/index');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 const { isAppDeveloperAccount } = require('../../lib/accountTypes');
 const { writeProjectConfig } = require('../../lib/projects');
 const { PROJECT_CONFIG_FILE } = require('../../lib/constants');
-const {
-  cloneApp,
-  checkCloneStatus,
-  downloadClonedProject,
-} = require('@hubspot/local-dev-lib/api/projects');
+const { cloneApp, checkCloneStatus, downloadClonedProject, } = require('@hubspot/local-dev-lib/api/projects');
 const { getCwd, sanitizeFileName } = require('@hubspot/local-dev-lib/path');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { getAccountConfig } = require('@hubspot/local-dev-lib/config');
 const { extractZipArchive } = require('@hubspot/local-dev-lib/archive');
-
 const i18nKey = 'commands.project.subcommands.cloneApp';
-
 exports.command = 'clone-app';
 exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
-
-exports.handler = async options => {
-  await loadAndValidateOptions(options);
-
-  const accountId = getAccountId(options);
-  const accountConfig = getAccountConfig(accountId);
-  const accountName = uiAccountDescription(accountId);
-
-  trackCommandUsage('clone-app', {}, accountId);
-
-  if (!isAppDeveloperAccount(accountConfig)) {
-    uiLine();
-    logger.error(i18n(`${i18nKey}.errors.invalidAccountTypeTitle`));
-    logger.log(
-      i18n(`${i18nKey}.errors.invalidAccountTypeDescription`, {
-        useCommand: uiCommandReference('hs accounts use'),
-        authCommand: uiCommandReference('hs auth'),
-      })
-    );
-    uiLine();
-    process.exit(EXIT_CODES.SUCCESS);
-  }
-
-  let appId;
-  let name;
-  let location;
-  try {
-    appId = options.appId;
-    if (!appId) {
-      const appIdResponse = await selectPublicAppPrompt({
-        accountId,
-        accountName,
-        options,
-        isMigratingApp: false,
-      });
-      appId = appIdResponse.appId;
+exports.handler = async (options) => {
+    await loadAndValidateOptions(options);
+    const accountId = getAccountId(options);
+    const accountConfig = getAccountConfig(accountId);
+    const accountName = uiAccountDescription(accountId);
+    trackCommandUsage('clone-app', {}, accountId);
+    if (!isAppDeveloperAccount(accountConfig)) {
+        uiLine();
+        logger.error(i18n(`${i18nKey}.errors.invalidAccountTypeTitle`));
+        logger.log(i18n(`${i18nKey}.errors.invalidAccountTypeDescription`, {
+            useCommand: uiCommandReference('hs accounts use'),
+            authCommand: uiCommandReference('hs auth'),
+        }));
+        uiLine();
+        process.exit(EXIT_CODES.SUCCESS);
     }
-
-    const projectResponse = await createProjectPrompt('', options, true);
-    name = projectResponse.name;
-    location = projectResponse.location;
-  } catch (error) {
-    logError(error, new ApiErrorContext({ accountId }));
-    process.exit(EXIT_CODES.ERROR);
-  }
-  try {
-    SpinniesManager.init();
-
-    SpinniesManager.add('cloneApp', {
-      text: i18n(`${i18nKey}.cloneStatus.inProgress`),
-    });
-
-    const {
-      data: { exportId },
-    } = await cloneApp(accountId, appId);
-    const {
-      data: { status },
-    } = await poll(checkCloneStatus, accountId, exportId);
-    if (status === 'SUCCESS') {
-      // Ensure correct project folder structure exists
-      const baseDestPath = path.resolve(getCwd(), location);
-      const absoluteDestPath = path.resolve(baseDestPath, 'src', 'app');
-      fs.mkdirSync(absoluteDestPath, { recursive: true });
-
-      // Extract zipped app files and place them in correct directory
-      const { data: zippedApp } = await downloadClonedProject(
-        accountId,
-        exportId
-      );
-      await extractZipArchive(
-        zippedApp,
-        sanitizeFileName(name),
-        absoluteDestPath,
-        {
-          includesRootDir: true,
-          hideLogs: true,
+    let appId;
+    let name;
+    let location;
+    try {
+        appId = options.appId;
+        if (!appId) {
+            const appIdResponse = await selectPublicAppPrompt({
+                accountId,
+                accountName,
+                options,
+                isMigratingApp: false,
+            });
+            appId = appIdResponse.appId;
         }
-      );
-
-      // Create hsproject.json file
-      const configPath = path.join(baseDestPath, PROJECT_CONFIG_FILE);
-      const configContent = {
-        name,
-        srcDir: 'src',
-        platformVersion: '2023.2',
-      };
-      const success = writeProjectConfig(configPath, configContent);
-
-      trackCommandMetadataUsage(
-        'clone-app',
-        {
-          type: name,
-          assetType: appId,
-          successful: success,
-        },
-        accountId
-      );
-
-      SpinniesManager.succeed('cloneApp', {
-        text: i18n(`${i18nKey}.cloneStatus.done`),
-        succeedColor: 'white',
-      });
-      if (!success) {
-        logger.error(
-          i18n(`${i18nKey}.errors.couldNotWriteConfigPath`),
-          configPath
-        );
-      }
-      logger.log('');
-      uiLine();
-      logger.success(i18n(`${i18nKey}.cloneStatus.success`, { location }));
-      logger.log('');
-      process.exit(EXIT_CODES.SUCCESS);
+        const projectResponse = await createProjectPrompt('', options, true);
+        name = projectResponse.name;
+        location = projectResponse.location;
     }
-  } catch (error) {
-    trackCommandMetadataUsage(
-      'clone-app',
-      { projectName: name, appId, status: 'FAILURE', error },
-      accountId
-    );
-
-    SpinniesManager.fail('cloneApp', {
-      text: i18n(`${i18nKey}.cloneStatus.failure`),
-      failColor: 'white',
-    });
-    // Migrations endpoints return a response object with an errors property. The errors property contains an array of errors.
-    if (error.errors && Array.isArray(error.errors)) {
-      error.errors.forEach(e =>
-        logError(e, new ApiErrorContext({ accountId }))
-      );
-    } else {
-      logError(error, new ApiErrorContext({ accountId }));
+    catch (error) {
+        logError(error, new ApiErrorContext({ accountId }));
+        process.exit(EXIT_CODES.ERROR);
+    }
+    try {
+        SpinniesManager.init();
+        SpinniesManager.add('cloneApp', {
+            text: i18n(`${i18nKey}.cloneStatus.inProgress`),
+        });
+        const { data: { exportId }, } = await cloneApp(accountId, appId);
+        const { status } = await poll(checkCloneStatus, accountId, exportId);
+        if (status === 'SUCCESS') {
+            // Ensure correct project folder structure exists
+            const baseDestPath = path.resolve(getCwd(), location);
+            const absoluteDestPath = path.resolve(baseDestPath, 'src', 'app');
+            fs.mkdirSync(absoluteDestPath, { recursive: true });
+            // Extract zipped app files and place them in correct directory
+            const { data: zippedApp } = await downloadClonedProject(accountId, exportId);
+            await extractZipArchive(zippedApp, sanitizeFileName(name), absoluteDestPath, {
+                includesRootDir: true,
+                hideLogs: true,
+            });
+            // Create hsproject.json file
+            const configPath = path.join(baseDestPath, PROJECT_CONFIG_FILE);
+            const configContent = {
+                name,
+                srcDir: 'src',
+                platformVersion: '2023.2',
+            };
+            const success = writeProjectConfig(configPath, configContent);
+            trackCommandMetadataUsage('clone-app', {
+                type: name,
+                assetType: appId,
+                successful: success,
+            }, accountId);
+            SpinniesManager.succeed('cloneApp', {
+                text: i18n(`${i18nKey}.cloneStatus.done`),
+                succeedColor: 'white',
+            });
+            if (!success) {
+                logger.error(i18n(`${i18nKey}.errors.couldNotWriteConfigPath`), configPath);
+            }
+            logger.log('');
+            uiLine();
+            logger.success(i18n(`${i18nKey}.cloneStatus.success`, { location }));
+            logger.log('');
+            process.exit(EXIT_CODES.SUCCESS);
+        }
+    }
+    catch (error) {
+        trackCommandMetadataUsage('clone-app', { projectName: name, appId, status: 'FAILURE', error }, accountId);
+        SpinniesManager.fail('cloneApp', {
+            text: i18n(`${i18nKey}.cloneStatus.failure`),
+            failColor: 'white',
+        });
+        // Migrations endpoints return a response object with an errors property. The errors property contains an array of errors.
+        if (error.errors && Array.isArray(error.errors)) {
+            error.errors.forEach(e => logError(e, new ApiErrorContext({ accountId })));
+        }
+        else {
+            logError(error, new ApiErrorContext({ accountId }));
+        }
     }
-  }
 };
-
 exports.builder = yargs => {
-  yargs.options({
-    location: {
-      describe: i18n(`${i18nKey}.options.location.describe`),
-      type: 'string',
-    },
-    appId: {
-      describe: i18n(`${i18nKey}.options.appId.describe`),
-      type: 'number',
-    },
-  });
-
-  yargs.example([
-    ['$0 project clone-app', i18n(`${i18nKey}.examples.default`)],
-  ]);
-
-  addConfigOptions(yargs);
-  addAccountOptions(yargs);
-  addUseEnvironmentOptions(yargs);
-
-  return yargs;
+    yargs.options({
+        location: {
+            describe: i18n(`${i18nKey}.options.location.describe`),
+            type: 'string',
+        },
+        appId: {
+            describe: i18n(`${i18nKey}.options.appId.describe`),
+            type: 'number',
+        },
+    });
+    yargs.example([
+        ['$0 project clone-app', i18n(`${i18nKey}.examples.default`)],
+    ]);
+    addConfigOptions(yargs);
+    addAccountOptions(yargs);
+    addUseEnvironmentOptions(yargs);
+    return yargs;
 };

package/commands/project/create.d.ts

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

package/commands/project/create.js

@@ -1,97 +1,63 @@
-const {
-  addAccountOptions,
-  addConfigOptions,
-  getAccountId,
-  addUseEnvironmentOptions,
-} = require('../../lib/commonOpts');
+"use strict";
+const { addAccountOptions, addConfigOptions, getAccountId, addUseEnvironmentOptions, } = require('../../lib/commonOpts');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { getCwd } = require('@hubspot/local-dev-lib/path');
 const path = require('path');
 const chalk = require('chalk');
-const {
-  createProjectPrompt,
-} = require('../../lib/prompts/createProjectPrompt');
+const { createProjectPrompt, } = require('../../lib/prompts/createProjectPrompt');
 const { createProjectConfig } = require('../../lib/projects');
 const { i18n } = require('../../lib/lang');
 const { uiBetaTag, uiFeatureHighlight } = require('../../lib/ui');
-const {
-  HUBSPOT_PROJECT_COMPONENTS_GITHUB_PATH,
-} = require('../../lib/constants');
+const { HUBSPOT_PROJECT_COMPONENTS_GITHUB_PATH, } = require('../../lib/constants');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { fetchReleaseData } = require('@hubspot/local-dev-lib/github');
-
 const i18nKey = 'commands.project.subcommands.create';
-
 exports.command = 'create';
 exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
-
-exports.handler = async options => {
-  await loadAndValidateOptions(options);
-
-  const accountId = getAccountId(options);
-
-  const hasCustomTemplateSource = Boolean(options.templateSource);
-
-  let githubRef = '';
-
-  if (!hasCustomTemplateSource) {
-    const releaseData = await fetchReleaseData(
-      HUBSPOT_PROJECT_COMPONENTS_GITHUB_PATH
-    );
-    githubRef = releaseData.tag_name;
-  }
-
-  const { name, template, location } = await createProjectPrompt(
-    githubRef,
-    options
-  );
-
-  trackCommandUsage('project-create', { type: template.name }, accountId);
-
-  await createProjectConfig(
-    path.resolve(getCwd(), options.location || location),
-    options.name || name,
-    template,
-    options.templateSource,
-    githubRef
-  );
-
-  logger.log('');
-  logger.log(chalk.bold(i18n(`${i18nKey}.logs.welcomeMessage`)));
-  uiFeatureHighlight([
-    'projectDevCommand',
-    'projectHelpCommand',
-    'feedbackCommand',
-    'sampleProjects',
-  ]);
+exports.handler = async (options) => {
+    await loadAndValidateOptions(options);
+    const accountId = getAccountId(options);
+    const hasCustomTemplateSource = Boolean(options.templateSource);
+    let githubRef = '';
+    if (!hasCustomTemplateSource) {
+        const releaseData = await fetchReleaseData(HUBSPOT_PROJECT_COMPONENTS_GITHUB_PATH);
+        githubRef = releaseData.tag_name;
+    }
+    const { name, template, location } = await createProjectPrompt(githubRef, options);
+    trackCommandUsage('project-create', { type: template.name }, accountId);
+    await createProjectConfig(path.resolve(getCwd(), options.location || location), options.name || name, template, options.templateSource, githubRef);
+    logger.log('');
+    logger.log(chalk.bold(i18n(`${i18nKey}.logs.welcomeMessage`)));
+    uiFeatureHighlight([
+        'projectDevCommand',
+        'projectHelpCommand',
+        'feedbackCommand',
+        'sampleProjects',
+    ]);
 };
-
 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',
-    },
-    templateSource: {
-      describe: i18n(`${i18nKey}.options.templateSource.describe`),
-      type: 'string',
-    },
-  });
-
-  yargs.example([['$0 project create', i18n(`${i18nKey}.examples.default`)]]);
-
-  addConfigOptions(yargs);
-  addAccountOptions(yargs);
-  addUseEnvironmentOptions(yargs);
-
-  return 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',
+        },
+        templateSource: {
+            describe: i18n(`${i18nKey}.options.templateSource.describe`),
+            type: 'string',
+        },
+    });
+    yargs.example([['$0 project create', i18n(`${i18nKey}.examples.default`)]]);
+    addConfigOptions(yargs);
+    addAccountOptions(yargs);
+    addUseEnvironmentOptions(yargs);
+    return yargs;
 };

package/commands/project/deploy.d.ts

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