@hubspot/cli 3.0.9 → 3.0.10-beta.11

package/lib/prompts.js

@@ -7,6 +7,9 @@ const {
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { API_KEY_REGEX, STRING_WITH_NO_SPACES_REGEX } = require('./regex');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.lib.prompts';
 
 const promptUser = async promptConfig => {
   const prompt = inquirer.createPromptModule();
@@ -18,14 +21,14 @@ const promptUser = async promptConfig => {
  * then opens their browser to the personal-access-key shortlink
  */
 const personalAccessKeyPrompt = async ({ env } = {}) => {
-  await promptUser([PERSONAL_ACCESS_KEY_BROWSER_OPEN_PREP]);
   const websiteOrigin = getHubSpotWebsiteOrigin(env);
   const url = `${websiteOrigin}/l/personal-access-key`;
   if (process.env.BROWSER !== 'none') {
+    await promptUser([PERSONAL_ACCESS_KEY_BROWSER_OPEN_PREP]);
     open(url, { url: true });
   }
 
-  logger.log(`Opening ${url} in your web browser`);
+  logger.log(i18n(`${i18nKey}.logs.openingWebBrowser`, { url }));
   const { personalAccessKey } = await promptUser(PERSONAL_ACCESS_KEY);
 
   return {
@@ -36,25 +39,24 @@ const personalAccessKeyPrompt = async ({ env } = {}) => {
 
 const ACCOUNT_ID = {
   name: 'accountId',
-  message:
-    'Enter the account ID for your account (the number under the DOMAIN column at https://app.hubspot.com/myaccounts-beta ):',
+  message: i18n(`${i18nKey}.accountId`),
   type: 'number',
   validate(val) {
     if (!Number.isNaN(val) && val > 0) {
       return true;
     }
-    return 'You did not enter a valid account ID. Please try again.';
+    return i18n(`${i18nKey}.errors.invalidAccountId`);
   },
 };
 
 const CLIENT_ID = {
   name: 'clientId',
-  message: 'Enter your OAuth2 client ID:',
+  message: i18n(`${i18nKey}.clientId`),
   validate(val) {
     if (typeof val !== 'string') {
-      return 'You entered an invalid OAuth2 client ID. Please try again.';
+      return i18n(`${i18nKey}.errors.invalidOauthClientId`);
     } else if (val.length !== 36) {
-      return 'The OAuth2 client ID must be 36 characters long. Please try again.';
+      return i18n(`${i18nKey}.errors.invalidOauthClientIdLength`);
     }
     return true;
   },
@@ -62,14 +64,14 @@ const CLIENT_ID = {
 
 const CLIENT_SECRET = {
   name: 'clientSecret',
-  message: 'Enter your OAuth2 client secret:',
+  message: i18n(`${i18nKey}.clientSecret`),
   validate(val) {
     if (typeof val !== 'string') {
-      return 'You entered an invalid OAuth2 client secret. Please try again.';
+      return i18n(`${i18nKey}.errors.invalidOauthClientSecret`);
     } else if (val.length !== 36) {
-      return 'The OAuth2 client secret must be 36 characters long. Please try again.';
+      return i18n(`${i18nKey}.errors.invalidOauthClientSecretLength`);
     } else if (val[0] === '*') {
-      return 'Please copy the actual OAuth2 client secret rather than the asterisks that mask it.';
+      return i18n(`${i18nKey}.errors.invalidOauthClientSecretCopy`);
     }
     return true;
   },
@@ -77,14 +79,14 @@ const CLIENT_SECRET = {
 
 const ACCOUNT_NAME = {
   name: 'name',
-  message: 'Enter a unique name to reference your account:',
+  message: i18n(`${i18nKey}.accountName`),
   validate(val) {
     if (typeof val !== 'string') {
-      return 'You entered an invalid name. Please try again.';
+      return i18n(`${i18nKey}.errors.invalidName`);
     } else if (!val.length) {
-      return 'The name may not be blank. Please try again.';
+      return i18n(`${i18nKey}.errors.nameRequired`);
     } else if (!STRING_WITH_NO_SPACES_REGEX.test(val)) {
-      return 'The name may not contain spaces. Please try again.';
+      return i18n(`${i18nKey}.errors.spacesInName`);
     }
     return true;
   },
@@ -92,11 +94,10 @@ const ACCOUNT_NAME = {
 
 const ACCOUNT_API_KEY = {
   name: 'apiKey',
-  message:
-    'Enter the API key for your account (found at https://app.hubspot.com/l/api-key):',
+  message: i18n(`${i18nKey}.apiKey`),
   validate(val) {
     if (!API_KEY_REGEX.test(val)) {
-      return 'You did not enter a valid API key. Please try again.';
+      return i18n(`${i18nKey}.errors.invalidAPIKey`);
     }
     return true;
   },
@@ -104,18 +105,17 @@ const ACCOUNT_API_KEY = {
 
 const PERSONAL_ACCESS_KEY_BROWSER_OPEN_PREP = {
   name: 'personalAcessKeyBrowserOpenPrep',
-  message:
-    "When you're ready, we'll open a secure page in your default browser where you can view and copy your personal access key, which you'll need to complete the next step.\n<Press enter to open the page and generate your personal access key>",
+  message: i18n(`${i18nKey}.personalAccessKeyBrowserOpenPrep`),
 };
 
 const PERSONAL_ACCESS_KEY = {
   name: 'personalAccessKey',
-  message: 'Enter your personal access key:',
+  message: i18n(`${i18nKey}.personalAccessKey`),
   validate(val) {
     if (typeof val !== 'string') {
-      return 'You did not enter a valid access key. Please try again.';
+      return i18n(`${i18nKey}.errors.invalidPersonalAccessKey`);
     } else if (val[0] === '•') {
-      return 'Please copy the actual access key rather than the bullets that mask it.';
+      return i18n(`${i18nKey}.errors.invalidPersonalAccessKeyCopy`);
     }
     return true;
   },
@@ -124,8 +124,7 @@ const PERSONAL_ACCESS_KEY = {
 const SCOPES = {
   type: 'checkbox',
   name: 'scopes',
-  message:
-    'Select access scopes (see https://developers.hubspot.com/docs/methods/oauth2/initiate-oauth-integration#scopes)',
+  message: i18n(`${i18nKey}.scopes`),
   default: DEFAULT_OAUTH_SCOPES,
   choices: OAUTH_SCOPES,
 };
@@ -137,7 +136,7 @@ const folderOverwritePrompt = folderName => {
   return promptUser({
     type: 'confirm',
     name: 'overwrite',
-    message: `The folder with name '${folderName}' already exists. Overwrite?`,
+    message: i18n(`${i18nKey}.folderOverwrite`, { folderName }),
     default: false,
   });
 };

package/lib/serverlessLogs.js

@@ -9,6 +9,7 @@ const {
   ApiErrorContext,
 } = require('@hubspot/cli-lib/errorHandlers');
 const { base64EncodeString } = require('@hubspot/cli-lib/lib/encoding');
+const { EXIT_CODES } = require('../lib/enums/exitCodes');
 
 const TAIL_DELAY = 5000;
 
@@ -17,7 +18,7 @@ const handleKeypressToExit = exit => {
   process.stdin.setRawMode(true);
   process.stdin.on('keypress', (str, key) => {
     if (key && ((key.ctrl && key.name == 'c') || key.name === 'escape')) {
-      exit();
+      exit(key.name === 'escape' ? 'esc' : 'ctrl+c');
     }
   });
 };
@@ -25,17 +26,15 @@ const handleKeypressToExit = exit => {
 const tailLogs = async ({
   accountId,
   compact,
-  spinner,
+  spinnies,
   fetchLatest,
   tailCall,
 }) => {
   let initialAfter;
 
-  spinner.start();
-
   try {
     const latestLog = await fetchLatest();
-    initialAfter = base64EncodeString(latestLog.id);
+    initialAfter = latestLog && base64EncodeString(latestLog.id);
   } catch (e) {
     // A 404 means no latest log exists(never executed)
     if (e.statusCode !== 404) {
@@ -54,8 +53,7 @@ const tailLogs = async ({
       latestLog = await tailCall(after);
       nextAfter = latestLog.paging.next.after;
     } catch (e) {
-      logger.info('Stopped polling due to error.');
-      spinner.clear();
+      spinnies.fail('tailLogs', { text: 'Stopped polling due to error.' });
       if (e.statusCode !== 404) {
         logApiErrorInstance(
           e,
@@ -64,11 +62,10 @@ const tailLogs = async ({
           })
         );
       }
-      process.exit();
+      process.exit(EXIT_CODES.SUCCESS);
     }
 
     if (latestLog && latestLog.results.length) {
-      spinner.clear();
       outputLogs(latestLog, {
         compact,
       });
@@ -79,9 +76,11 @@ const tailLogs = async ({
     }, TAIL_DELAY);
   };
 
-  handleKeypressToExit(() => {
-    spinner.stop();
-    process.exit();
+  handleKeypressToExit(exitKey => {
+    spinnies.succeed('tailLogs', {
+      text: `Stopped polling because "${exitKey}" was pressed.`,
+    });
+    process.exit(EXIT_CODES.SUCCESS);
   });
   await tail(initialAfter);
 };

package/lib/ui.js

@@ -0,0 +1,48 @@
+const chalk = require('chalk');
+const supportsHyperlinks = require('supports-hyperlinks');
+const { getAccountConfig } = require('@hubspot/cli-lib/lib/config');
+const { logger } = require('@hubspot/cli-lib/logger');
+
+/**
+ * Outputs horizontal line
+ *
+ * @returns
+ */
+const uiLine = () => {
+  logger.log('-'.repeat(50));
+};
+
+/**
+ * Returns a hyperlink or link and description
+ *
+ * @param {string} linkText
+ * @param {string} url
+ * @param {object} options
+ * @returns {string}
+ */
+const uiLink = (linkText, url, options = {}) => {
+  if (supportsHyperlinks.stdout) {
+    return ['\u001B]8;;', url, '\u0007', linkText, '\u001B]8;;\u0007'].join('');
+  } else {
+    return options.fallback ? `${linkText}: ${url}` : linkText;
+  }
+};
+
+/**
+ * Returns formatted account name and ID
+ *
+ * @param {number} accountId
+ * @returns {string}
+ */
+const uiAccountDescription = accountId => {
+  const account = getAccountConfig(accountId);
+  return chalk.bold(
+    account.name ? `${account.name} (${account.portalId})` : account.portalId
+  );
+};
+
+module.exports = {
+  uiLine,
+  uiLink,
+  uiAccountDescription,
+};

package/lib/validation.js

@@ -24,6 +24,7 @@ const { getAccountId, getMode, setLogLevel } = require('./commonOpts');
 const { logDebugInfo } = require('./debugInfo');
 const fs = require('fs');
 const path = require('path');
+const { EXIT_CODES } = require('./enums/exitCodes');
 
 async function loadAndValidateOptions(options) {
   setLogLevel(options);
@@ -33,7 +34,7 @@ async function loadAndValidateOptions(options) {
   checkAndWarnGitInclusion();
 
   if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
+    process.exit(EXIT_CODES.ERROR);
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/cli",
-  "version": "3.0.9",
+  "version": "3.0.10-beta.11",
   "description": "CLI for working with HubSpot",
   "license": "Apache-2.0",
   "repository": {
@@ -8,20 +8,22 @@
     "url": "https://github.com/HubSpot/hubspot-cms-tools"
   },
   "dependencies": {
-    "@hubspot/cli-lib": "^3.0.9",
-    "@hubspot/serverless-dev-runtime": "^3.0.9",
+    "@hubspot/cli-lib": "^3.0.10-beta.10",
+    "@hubspot/serverless-dev-runtime": "^3.0.10-beta.11",
     "archiver": "^5.3.0",
-    "chalk": "^4.1.0",
+    "chalk": "^4.1.2",
     "express": "^4.17.1",
     "findup-sync": "^4.0.0",
     "fs-extra": "^8.1.0",
-    "inquirer": "^6.3.1",
+    "inquirer": "^8.2.0",
+    "moment": "^2.29.1",
     "open": "^7.0.3",
     "ora": "^4.0.3",
     "shelljs": "0.8.3",
     "spinnies": "^0.5.1",
+    "supports-hyperlinks": "^2.2.0",
     "tmp": "^0.2.1",
-    "update-notifier": "3.0.1",
+    "update-notifier": "^5.1.0",
     "yargs": "15.4.1"
   },
   "devDependencies": {
@@ -37,5 +39,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "172b7c424c13c0ac21eb730e7d7a403a5787c00e"
+  "gitHead": "52da01961c90b30b6fc9f30bffac2527d937a032"
 }

package/commands/project/init.js

@@ -1,108 +0,0 @@
-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 { createProject } = require('@hubspot/cli-lib/api/dfs');
-const { validateAccount } = require('../../lib/validation');
-const { getCwd } = require('@hubspot/cli-lib/path');
-const path = require('path');
-const {
-  getOrCreateProjectConfig,
-  showWelcomeMessage,
-} = require('../../lib/projects');
-
-const loadAndValidateOptions = async options => {
-  setLogLevel(options);
-  logDebugInfo(options);
-  const { config: configPath } = options;
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
-
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
-};
-
-exports.command = 'init [path]';
-exports.describe = false;
-
-exports.handler = async options => {
-  loadAndValidateOptions(options);
-
-  const { path: projectPath } = options;
-  const accountId = getAccountId(options);
-
-  trackCommandUsage('project-init', { projectPath }, accountId);
-
-  const cwd = projectPath ? path.resolve(getCwd(), projectPath) : getCwd();
-  const projectConfig = await getOrCreateProjectConfig(cwd);
-
-  logger.log(`Initializing project: ${projectConfig.name}`);
-
-  try {
-    await createProject(accountId, projectConfig.name);
-
-    logger.success(
-      `"${projectConfig.name}" creation succeeded in account ${accountId}`
-    );
-  } catch (e) {
-    if (e.statusCode === 409) {
-      logger.log(
-        `Project ${projectConfig.name} already exists in ${accountId}.`
-      );
-    } else {
-      return logApiErrorInstance(
-        e,
-        new ApiErrorContext({ accountId, projectPath })
-      );
-    }
-  }
-
-  showWelcomeMessage(projectConfig.name, accountId);
-};
-
-exports.builder = yargs => {
-  yargs.positional('path', {
-    describe: 'Path to a project folder',
-    type: 'string',
-  });
-  // TODO: These are not currently used
-  yargs.options({
-    name: {
-      describe: 'Project name (cannot be changed)',
-      type: 'string',
-    },
-    srcDir: {
-      describe: 'Directory of project',
-      type: 'string',
-    },
-  });
-
-  yargs.example([
-    [
-      '$0 project init myProjectFolder',
-      'Initialize a project within the myProjectFolder folder',
-    ],
-  ]);
-
-  addConfigOptions(yargs, true);
-  addAccountOptions(yargs, true);
-  addUseEnvironmentOptions(yargs, true);
-
-  return yargs;
-};