@hubspot/cli 6.2.0 → 6.2.2-experimental.0

package/commands/cms/lighthouseScore.js

@@ -1,329 +1,265 @@
+"use strict";
 const SpinniesManager = require('../../lib/ui/SpinniesManager');
-const {
-  addAccountOptions,
-  addConfigOptions,
-  addUseEnvironmentOptions,
-  getAccountId,
-} = require('../../lib/commonOpts');
+const { addAccountOptions, addConfigOptions, addUseEnvironmentOptions, getAccountId, } = require('../../lib/commonOpts');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { getTableContents, getTableHeader } = require('../../lib/ui/table');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { promptUser } = require('../../lib/prompts/promptUtils');
 const { i18n } = require('../../lib/lang');
 const { fetchThemes } = require('@hubspot/local-dev-lib/api/designManager');
-const {
-  requestLighthouseScore,
-  getLighthouseScoreStatus,
-  getLighthouseScore,
-} = require('@hubspot/local-dev-lib/api/lighthouseScore');
+const { requestLighthouseScore, getLighthouseScoreStatus, getLighthouseScore, } = require('@hubspot/local-dev-lib/api/lighthouseScore');
 const { HUBSPOT_FOLDER, MARKETPLACE_FOLDER } = require('../../lib/constants');
 const { uiLink } = require('../../lib/ui');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-
 const i18nKey = 'commands.cms.subcommands.lighthouseScore';
-
 const DEFAULT_TABLE_HEADER = [
-  'Accessibility',
-  'Best practices',
-  'Performace',
-  'PWA',
-  'SEO',
+    'Accessibility',
+    'Best practices',
+    'Performace',
+    'PWA',
+    'SEO',
 ];
-
 exports.command = 'lighthouse-score [--theme]';
 exports.describe = false; // i18n(`${i18nKey}.describe`);
-
-const selectTheme = async accountId => {
-  const { theme: selectedTheme } = await promptUser([
-    {
-      type: 'list',
-      look: false,
-      name: 'theme',
-      message: i18n(`${i18nKey}.info.promptMessage`),
-      choices: async () => {
+const selectTheme = async (accountId) => {
+    const { theme: selectedTheme } = await promptUser([
+        {
+            type: 'list',
+            look: false,
+            name: 'theme',
+            message: i18n(`${i18nKey}.info.promptMessage`),
+            choices: async () => {
+                try {
+                    const { data: result } = await fetchThemes(accountId, {
+                        limit: 500,
+                        sorting: 'MOST_USED',
+                    });
+                    if (result && result.objects) {
+                        return result.objects
+                            .map(({ theme }) => theme.path)
+                            .filter(themePath => !themePath.startsWith(HUBSPOT_FOLDER) &&
+                            !themePath.startsWith(MARKETPLACE_FOLDER));
+                    }
+                }
+                catch (err) {
+                    logger.error(i18n(`${i18nKey}.errors.failedToFetchThemes`));
+                    process.exit(EXIT_CODES.ERROR);
+                }
+            },
+        },
+    ]);
+    return selectedTheme;
+};
+exports.handler = async (options) => {
+    await loadAndValidateOptions(options);
+    const accountId = getAccountId(options);
+    const includeDesktopScore = options.target === 'desktop' || !options.verbose;
+    const includeMobileScore = options.target === 'mobile' || !options.verbose;
+    let themeToCheck = options.theme;
+    if (themeToCheck) {
+        let isValidTheme = true;
         try {
-          const { data: result } = await fetchThemes(accountId, {
-            limit: 500,
-            sorting: 'MOST_USED',
-          });
-          if (result && result.objects) {
-            return result.objects
-              .map(({ theme }) => theme.path)
-              .filter(
-                themePath =>
-                  !themePath.startsWith(HUBSPOT_FOLDER) &&
-                  !themePath.startsWith(MARKETPLACE_FOLDER)
-              );
-          }
-        } catch (err) {
-          logger.error(i18n(`${i18nKey}.errors.failedToFetchThemes`));
-          process.exit(EXIT_CODES.ERROR);
+            const { data: result } = await fetchThemes(accountId, {
+                name: encodeURIComponent(themeToCheck),
+            });
+            isValidTheme = result && result.total;
+        }
+        catch (err) {
+            isValidTheme = false;
+        }
+        if (!isValidTheme) {
+            logger.error(i18n(`${i18nKey}.errors.themeNotFound`, { theme: themeToCheck }));
+            process.exit(EXIT_CODES.ERROR);
         }
-      },
-    },
-  ]);
-
-  return selectedTheme;
-};
-
-exports.handler = async options => {
-  await loadAndValidateOptions(options);
-  const accountId = getAccountId(options);
-
-  const includeDesktopScore = options.target === 'desktop' || !options.verbose;
-  const includeMobileScore = options.target === 'mobile' || !options.verbose;
-  let themeToCheck = options.theme;
-
-  if (themeToCheck) {
-    let isValidTheme = true;
-    try {
-      const { data: result } = await fetchThemes(accountId, {
-        name: encodeURIComponent(themeToCheck),
-      });
-      isValidTheme = result && result.total;
-    } catch (err) {
-      isValidTheme = false;
     }
-    if (!isValidTheme) {
-      logger.error(
-        i18n(`${i18nKey}.errors.themeNotFound`, { theme: themeToCheck })
-      );
-      process.exit(EXIT_CODES.ERROR);
+    else {
+        themeToCheck = await selectTheme(accountId);
+        logger.log();
     }
-  } else {
-    themeToCheck = await selectTheme(accountId);
-    logger.log();
-  }
-
-  // Kick off the scoring
-  let requestResult;
-  try {
-    const { data } = await requestLighthouseScore(accountId, {
-      themePath: themeToCheck,
-    });
-    requestResult = data;
-  } catch (err) {
-    logger.debug(err);
-  }
-
-  if (!requestResult || !requestResult.mobileId || !requestResult.desktopId) {
-    logger.error(i18n(`${i18nKey}.errors.failedToGetLighthouseScore`));
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  // Poll till scoring is finished
-  try {
-    SpinniesManager.init();
-
-    SpinniesManager.add('lighthouseScore', {
-      text: i18n(`${i18nKey}.info.generatingScore`, { theme: themeToCheck }),
-    });
-
-    const checkScoreStatus = async () => {
-      let desktopScoreStatus = 'COMPLETED';
-      if (includeDesktopScore) {
-        const { data } = await getLighthouseScoreStatus(accountId, {
-          themeId: requestResult.desktopId,
+    // Kick off the scoring
+    let requestResult;
+    try {
+        const { data } = await requestLighthouseScore(accountId, {
+            themePath: themeToCheck,
         });
-        desktopScoreStatus = data;
-      }
-
-      let mobileScoreStatus = 'COMPLETED';
-      if (includeDesktopScore) {
-        const { data } = await getLighthouseScoreStatus(accountId, {
-          themeId: requestResult.mobileId,
+        requestResult = data;
+    }
+    catch (err) {
+        logger.debug(err);
+    }
+    if (!requestResult || !requestResult.mobileId || !requestResult.desktopId) {
+        logger.error(i18n(`${i18nKey}.errors.failedToGetLighthouseScore`));
+        process.exit(EXIT_CODES.ERROR);
+    }
+    // Poll till scoring is finished
+    try {
+        SpinniesManager.init();
+        SpinniesManager.add('lighthouseScore', {
+            text: i18n(`${i18nKey}.info.generatingScore`, { theme: themeToCheck }),
         });
-        mobileScoreStatus = data;
-      }
-
-      if (
-        desktopScoreStatus === 'REQUESTED' ||
-        mobileScoreStatus === 'REQUESTED'
-      ) {
-        await new Promise(resolve => setTimeout(resolve, 2000));
+        const checkScoreStatus = async () => {
+            let desktopScoreStatus = 'COMPLETED';
+            if (includeDesktopScore) {
+                const { data } = await getLighthouseScoreStatus(accountId, {
+                    themeId: requestResult.desktopId,
+                });
+                desktopScoreStatus = data;
+            }
+            let mobileScoreStatus = 'COMPLETED';
+            if (includeDesktopScore) {
+                const { data } = await getLighthouseScoreStatus(accountId, {
+                    themeId: requestResult.mobileId,
+                });
+                mobileScoreStatus = data;
+            }
+            if (desktopScoreStatus === 'REQUESTED' ||
+                mobileScoreStatus === 'REQUESTED') {
+                await new Promise(resolve => setTimeout(resolve, 2000));
+                await checkScoreStatus();
+            }
+        };
         await checkScoreStatus();
-      }
-    };
-
-    await checkScoreStatus();
-
-    SpinniesManager.remove('lighthouseScore');
-  } catch (err) {
-    logger.debug(err);
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  // Fetch the scoring results
-  let desktopScoreResult = {};
-  let mobileScoreResult = {};
-  let verboseViewAverageScoreResult = {};
-  try {
-    const params = { isAverage: !options.verbose };
-
-    if (includeDesktopScore) {
-      const { data } = await getLighthouseScore(accountId, {
-        ...params,
-        desktopId: requestResult.desktopId,
-      });
-      desktopScoreResult = data;
+        SpinniesManager.remove('lighthouseScore');
+    }
+    catch (err) {
+        logger.debug(err);
+        process.exit(EXIT_CODES.ERROR);
     }
-
-    if (includeMobileScore) {
-      const { data } = await getLighthouseScore(accountId, {
-        ...params,
-        mobileId: requestResult.mobileId,
-      });
-      mobileScoreResult = data;
+    // Fetch the scoring results
+    let desktopScoreResult = {};
+    let mobileScoreResult = {};
+    let verboseViewAverageScoreResult = {};
+    try {
+        const params = { isAverage: !options.verbose };
+        if (includeDesktopScore) {
+            const { data } = await getLighthouseScore(accountId, {
+                ...params,
+                desktopId: requestResult.desktopId,
+            });
+            desktopScoreResult = data;
+        }
+        if (includeMobileScore) {
+            const { data } = await getLighthouseScore(accountId, {
+                ...params,
+                mobileId: requestResult.mobileId,
+            });
+            mobileScoreResult = data;
+        }
+        // This is needed to show the average scores above the verbose output
+        if (options.verbose) {
+            const { data } = await getLighthouseScore(accountId, {
+                ...params,
+                isAverage: true,
+                desktopId: includeDesktopScore ? requestResult.desktopId : null,
+                mobileId: includeMobileScore ? requestResult.mobileId : null,
+            });
+            verboseViewAverageScoreResult = data;
+        }
+    }
+    catch (err) {
+        logger.error(i18n(`${i18nKey}.errors.failedToGetLighthouseScore`));
+        process.exit(EXIT_CODES.ERROR);
     }
-    // This is needed to show the average scores above the verbose output
     if (options.verbose) {
-      const { data } = await getLighthouseScore(accountId, {
-        ...params,
-        isAverage: true,
-        desktopId: includeDesktopScore ? requestResult.desktopId : null,
-        mobileId: includeMobileScore ? requestResult.mobileId : null,
-      });
-      verboseViewAverageScoreResult = data;
+        logger.log(`${themeToCheck} ${options.target} scores`);
+        const tableHeader = getTableHeader(DEFAULT_TABLE_HEADER);
+        const scores = verboseViewAverageScoreResult.scores
+            ? verboseViewAverageScoreResult.scores[0]
+            : {};
+        const averageTableData = [
+            scores.accessibilityScore,
+            scores.bestPracticesScore,
+            scores.performanceScore,
+            scores.pwaScore,
+            scores.seoScore,
+        ];
+        logger.log(getTableContents([tableHeader, averageTableData], {
+            border: { bodyLeft: '  ' },
+        }));
+        logger.log(i18n(`${i18nKey}.info.pageTemplateScoreTitle`));
+        const table2Header = getTableHeader([
+            'Template path',
+            ...DEFAULT_TABLE_HEADER,
+        ]);
+        const scoreResult = options.target === 'desktop' ? desktopScoreResult : mobileScoreResult;
+        const templateTableData = scoreResult.scores.map(score => {
+            return [
+                score.templatePath,
+                score.accessibilityScore,
+                score.bestPracticesScore,
+                score.performanceScore,
+                score.pwaScore,
+                score.seoScore,
+            ];
+        });
+        logger.log(getTableContents([table2Header, ...templateTableData], {
+            border: { bodyLeft: '  ' },
+        }));
+        logger.log(i18n(`${i18nKey}.info.lighthouseLinksTitle`));
+        scoreResult.scores.forEach(score => {
+            logger.log(' ', uiLink(score.templatePath, score.link));
+        });
+        if (scoreResult.failedTemplatePaths.length) {
+            logger.log();
+            logger.error(i18n(`${i18nKey}.info.failedTemplatePathsTitle`));
+            scoreResult.failedTemplatePaths.forEach(failedTemplatePath => {
+                logger.log(' ', failedTemplatePath);
+            });
+        }
+        logger.log();
+        logger.info(i18n(`${i18nKey}.info.targetDeviceNote`, { target: options.target }));
     }
-  } catch (err) {
-    logger.error(i18n(`${i18nKey}.errors.failedToGetLighthouseScore`));
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  if (options.verbose) {
-    logger.log(`${themeToCheck} ${options.target} scores`);
-
-    const tableHeader = getTableHeader(DEFAULT_TABLE_HEADER);
-
-    const scores = verboseViewAverageScoreResult.scores
-      ? verboseViewAverageScoreResult.scores[0]
-      : {};
-
-    const averageTableData = [
-      scores.accessibilityScore,
-      scores.bestPracticesScore,
-      scores.performanceScore,
-      scores.pwaScore,
-      scores.seoScore,
-    ];
-
-    logger.log(
-      getTableContents([tableHeader, averageTableData], {
-        border: { bodyLeft: '  ' },
-      })
-    );
-    logger.log(i18n(`${i18nKey}.info.pageTemplateScoreTitle`));
-
-    const table2Header = getTableHeader([
-      'Template path',
-      ...DEFAULT_TABLE_HEADER,
-    ]);
-
-    const scoreResult =
-      options.target === 'desktop' ? desktopScoreResult : mobileScoreResult;
-
-    const templateTableData = scoreResult.scores.map(score => {
-      return [
-        score.templatePath,
-        score.accessibilityScore,
-        score.bestPracticesScore,
-        score.performanceScore,
-        score.pwaScore,
-        score.seoScore,
-      ];
-    });
-
-    logger.log(
-      getTableContents([table2Header, ...templateTableData], {
-        border: { bodyLeft: '  ' },
-      })
-    );
-
-    logger.log(i18n(`${i18nKey}.info.lighthouseLinksTitle`));
-
-    scoreResult.scores.forEach(score => {
-      logger.log(' ', uiLink(score.templatePath, score.link));
-    });
-
-    if (scoreResult.failedTemplatePaths.length) {
-      logger.log();
-      logger.error(i18n(`${i18nKey}.info.failedTemplatePathsTitle`));
-      scoreResult.failedTemplatePaths.forEach(failedTemplatePath => {
-        logger.log(' ', failedTemplatePath);
-      });
+    else {
+        logger.log(`Theme: ${themeToCheck}`);
+        const tableHeader = getTableHeader(['Target', ...DEFAULT_TABLE_HEADER]);
+        const getTableData = (target, scoreResult) => {
+            const scores = scoreResult.scores ? scoreResult.scores[0] : {};
+            return [
+                target,
+                scores.accessibilityScore,
+                scores.bestPracticesScore,
+                scores.performanceScore,
+                scores.pwaScore,
+                scores.seoScore,
+            ];
+        };
+        const tableData = [
+            getTableData('desktop', desktopScoreResult),
+            getTableData('mobile', mobileScoreResult),
+        ];
+        logger.log(getTableContents([tableHeader, ...tableData], {
+            border: { bodyLeft: '  ' },
+        }));
+        logger.info(i18n(`${i18nKey}.info.verboseOptionNote`));
     }
-
     logger.log();
-    logger.info(
-      i18n(`${i18nKey}.info.targetDeviceNote`, { target: options.target })
-    );
-  } else {
-    logger.log(`Theme: ${themeToCheck}`);
-    const tableHeader = getTableHeader(['Target', ...DEFAULT_TABLE_HEADER]);
-
-    const getTableData = (target, scoreResult) => {
-      const scores = scoreResult.scores ? scoreResult.scores[0] : {};
-      return [
-        target,
-        scores.accessibilityScore,
-        scores.bestPracticesScore,
-        scores.performanceScore,
-        scores.pwaScore,
-        scores.seoScore,
-      ];
-    };
-
-    const tableData = [
-      getTableData('desktop', desktopScoreResult),
-      getTableData('mobile', mobileScoreResult),
-    ];
-
-    logger.log(
-      getTableContents([tableHeader, ...tableData], {
-        border: { bodyLeft: '  ' },
-      })
-    );
-
-    logger.info(i18n(`${i18nKey}.info.verboseOptionNote`));
-  }
-
-  logger.log();
-  logger.log(
-    `Powered by ${uiLink(
-      'Google Lighthouse',
-      'https://developer.chrome.com/docs/lighthouse/overview/'
-    )}.`
-  );
-
-  process.exit();
+    logger.log(`Powered by ${uiLink('Google Lighthouse', 'https://developer.chrome.com/docs/lighthouse/overview/')}.`);
+    process.exit();
 };
-
 exports.builder = yargs => {
-  yargs.option('theme', {
-    describe: i18n(`${i18nKey}.options.theme.describe`),
-    type: 'string',
-  });
-  yargs.option('target', {
-    describe: i18n(`${i18nKey}.options.target.describe`),
-    type: 'string',
-    choices: ['desktop', 'mobile'],
-    default: 'desktop',
-  });
-  yargs.option('verbose', {
-    describe: i18n(`${i18nKey}.options.verbose.describe`),
-    boolean: true,
-    default: false,
-  });
-  yargs.example([
-    [
-      '$0 cms lighthouse-score --theme=my-theme',
-      i18n(`${i18nKey}.examples.default`),
-    ],
-  ]);
-
-  addConfigOptions(yargs);
-  addAccountOptions(yargs);
-  addUseEnvironmentOptions(yargs);
-
-  return yargs;
+    yargs.option('theme', {
+        describe: i18n(`${i18nKey}.options.theme.describe`),
+        type: 'string',
+    });
+    yargs.option('target', {
+        describe: i18n(`${i18nKey}.options.target.describe`),
+        type: 'string',
+        choices: ['desktop', 'mobile'],
+        default: 'desktop',
+    });
+    yargs.option('verbose', {
+        describe: i18n(`${i18nKey}.options.verbose.describe`),
+        boolean: true,
+        default: false,
+    });
+    yargs.example([
+        [
+            '$0 cms lighthouse-score --theme=my-theme',
+            i18n(`${i18nKey}.examples.default`),
+        ],
+    ]);
+    addConfigOptions(yargs);
+    addAccountOptions(yargs);
+    addUseEnvironmentOptions(yargs);
+    return yargs;
 };

package/commands/cms/reactModules.d.ts

@@ -0,0 +1,4 @@
+export const command: "get-react-module [--name] [--dest]";
+export const describe: any;
+export function handler(options: any): Promise<void>;
+export function builder(yargs: any): any;

package/commands/cms/reactModules.js

@@ -1,67 +1,58 @@
+"use strict";
 const fs = require('fs');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { retrieveDefaultModule } = require('@hubspot/local-dev-lib/cms/modules');
 const { i18n } = require('../../lib/lang');
 const path = require('path');
 const { trackCommandUsage } = require('../../lib/usageTracking');
-
 const i18nKey = 'commands.cms.subcommands.reactModule';
-
 exports.command = 'get-react-module [--name] [--dest]';
 exports.describe = i18n(`${i18nKey}.describe`);
-
-exports.handler = async options => {
-  const { name, dest } = options;
-
-  trackCommandUsage('get-react-modules');
-
-  const destPath = dest
-    ? path.join(dest, `${name}`)
-    : path.join(process.cwd(), `${name}`);
-
-  if (fs.existsSync(destPath)) {
-    logger.error(
-      i18n(`${i18nKey}.errors.pathExists`, {
-        path: destPath,
-      })
-    );
-    return;
-  }
-
-  try {
-    const modules = await retrieveDefaultModule(name, destPath);
-
-    if (!name) {
-      logger.group(i18n(`${i18nKey}.groupLabel`));
-      modules.forEach(module => {
-        logger.log(module.name);
-      });
-      logger.groupEnd(i18n(`${i18nKey}.groupLabel`));
-    } else {
-      logger.success(
-        i18n(`${i18nKey}.success.moduleDownloaded`, {
-          moduleName: name,
-          path: destPath,
-        })
-      );
+exports.handler = async (options) => {
+    const { name, dest } = options;
+    trackCommandUsage('get-react-modules');
+    const destPath = dest
+        ? path.join(dest, `${name}`)
+        : path.join(process.cwd(), `${name}`);
+    if (fs.existsSync(destPath)) {
+        logger.error(i18n(`${i18nKey}.errors.pathExists`, {
+            path: destPath,
+        }));
+        return;
     }
-  } catch (e) {
-    if (e.cause && e.cause.code === 'ERR_BAD_REQUEST') {
-      logger.error(i18n(`${i18nKey}.errors.invalidName`));
-    } else {
-      logger.error(e);
+    try {
+        const modules = await retrieveDefaultModule(name, destPath);
+        if (!name) {
+            logger.group(i18n(`${i18nKey}.groupLabel`));
+            modules.forEach(module => {
+                logger.log(module.name);
+            });
+            logger.groupEnd(i18n(`${i18nKey}.groupLabel`));
+        }
+        else {
+            logger.success(i18n(`${i18nKey}.success.moduleDownloaded`, {
+                moduleName: name,
+                path: destPath,
+            }));
+        }
+    }
+    catch (e) {
+        if (e.cause && e.cause.code === 'ERR_BAD_REQUEST') {
+            logger.error(i18n(`${i18nKey}.errors.invalidName`));
+        }
+        else {
+            logger.error(e);
+        }
     }
-  }
 };
-
 exports.builder = yargs => {
-  yargs.option('name', {
-    describe: i18n(`${i18nKey}.options.name.describe`),
-    type: 'string',
-  });
-  yargs.option('dest', {
-    describe: i18n(`${i18nKey}.options.dest.describe`),
-    type: 'string',
-  });
-  return yargs;
+    yargs.option('name', {
+        describe: i18n(`${i18nKey}.options.name.describe`),
+        type: 'string',
+    });
+    yargs.option('dest', {
+        describe: i18n(`${i18nKey}.options.dest.describe`),
+        type: 'string',
+    });
+    return yargs;
 };