@hubspot/cli 3.0.10-beta.6 → 3.0.10

package/commands/upload.js

@@ -1,12 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 
-const {
-  loadConfig,
-  uploadFolder,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
+const { uploadFolder } = require('@hubspot/cli-lib');
 const { getFileMapperQueryValues } = require('@hubspot/cli-lib/fileMapper');
 const { upload } = require('@hubspot/cli-lib/api/fileMapper');
 const {
@@ -28,45 +23,39 @@ const {
   addAccountOptions,
   addModeOptions,
   addUseEnvironmentOptions,
-  setLogLevel,
   getAccountId,
   getMode,
 } = require('../lib/commonOpts');
-const { logDebugInfo } = require('../lib/debugInfo');
-const { validateAccount, validateMode } = require('../lib/validation');
+const { validateMode, loadAndValidateOptions } = require('../lib/validation');
 const { trackCommandUsage } = require('../lib/usageTracking');
 const { getThemePreviewUrl } = require('@hubspot/cli-lib/lib/files');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.upload';
+const { EXIT_CODES } = require('../lib/enums/exitCodes');
 
 exports.command = 'upload <src> <dest>';
-exports.describe =
-  'Upload a folder or file from your computer to the HubSpot CMS';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 const logThemePreview = (filePath, accountId) => {
   const previewUrl = getThemePreviewUrl(filePath, accountId);
   // Only log if we are actually in a theme
   if (previewUrl) {
-    logger.log(`
-      To preview this theme, visit:
-      ${previewUrl}
-      `);
+    logger.log(
+      i18n(`${i18nKey}.previewUrl`, {
+        previewUrl,
+      })
+    );
   }
 };
 
 exports.handler = async options => {
-  const { src, dest, config: configPath } = options;
-  setLogLevel(options);
-  logDebugInfo(options);
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
+  const { src, dest } = options;
 
-  if (
-    !(
-      validateConfig() &&
-      (await validateAccount(options)) &&
-      validateMode(options)
-    )
-  ) {
-    process.exit(1);
+  await loadAndValidateOptions(options);
+
+  if (!validateMode(options)) {
+    process.exit(EXIT_CODES.ERROR);
   }
 
   const accountId = getAccountId(options);
@@ -76,16 +65,24 @@ exports.handler = async options => {
   try {
     stats = fs.statSync(absoluteSrcPath);
     if (!stats.isFile() && !stats.isDirectory()) {
-      logger.error(`The path "${src}" is not a path to a file or folder`);
+      logger.error(
+        i18n(`${i18nKey}.errors.invalidPath`, {
+          path: src,
+        })
+      );
       return;
     }
   } catch (e) {
-    logger.error(`The path "${src}" is not a path to a file or folder`);
+    logger.error(
+      i18n(`${i18nKey}.errors.invalidPath`, {
+        path: src,
+      })
+    );
     return;
   }
 
   if (!dest) {
-    logger.error('A destination path needs to be passed');
+    logger.error(i18n(`${i18nKey}.errors.destinationRequired`));
     return;
   }
   const normalizedDest = convertToUnixPath(dest);
@@ -101,16 +98,24 @@ exports.handler = async options => {
 
   if (srcDestIssues.length) {
     srcDestIssues.forEach(({ message }) => logger.error(message));
-    process.exit(1);
+    process.exit(EXIT_CODES.ERROR);
   }
   if (stats.isFile()) {
     if (!isAllowedExtension(src)) {
-      logger.error(`The file "${src}" does not have a valid extension`);
+      logger.error(
+        i18n(`${i18nKey}.errors.invalidPath`, {
+          path: src,
+        })
+      );
       return;
     }
 
     if (shouldIgnoreFile(absoluteSrcPath)) {
-      logger.error(`The file "${src}" is being ignored via an .hsignore rule`);
+      logger.error(
+        i18n(`${i18nKey}.errors.fileIgnored`, {
+          path: src,
+        })
+      );
       return;
     }
 
@@ -122,15 +127,21 @@ exports.handler = async options => {
     )
       .then(() => {
         logger.success(
-          'Uploaded file from "%s" to "%s" in the Design Manager of account %s',
-          src,
-          normalizedDest,
-          accountId
+          i18n(`${i18nKey}.success.fileUploaded`, {
+            accountId,
+            dest: normalizedDest,
+            src,
+          })
         );
         logThemePreview(src, accountId);
       })
       .catch(error => {
-        logger.error('Uploading file "%s" to "%s" failed', src, normalizedDest);
+        logger.error(
+          i18n(`${i18nKey}.errors.uploadFailed`, {
+            dest: normalizedDest,
+            src,
+          })
+        );
         logApiUploadErrorInstance(
           error,
           new ApiErrorContext({
@@ -142,19 +153,30 @@ exports.handler = async options => {
       });
   } else {
     logger.log(
-      `Uploading files from "${src}" to "${dest}" in the Design Manager of account ${accountId}`
+      i18n(`${i18nKey}.uploading`, {
+        accountId,
+        dest,
+        src,
+      })
     );
     uploadFolder(accountId, absoluteSrcPath, dest, {
       mode,
     })
       .then(() => {
         logger.success(
-          `Uploading files to "${dest}" in the Design Manager is complete`
+          i18n(`${i18nKey}.success.uploadComplete`, {
+            dest,
+          })
         );
         logThemePreview(src, accountId);
       })
       .catch(error => {
-        logger.error('Uploading failed');
+        logger.error(
+          i18n(`${i18nKey}.errors.uploadFailed`, {
+            dest,
+            src,
+          })
+        );
         logErrorInstance(error, {
           accountId,
         });
@@ -169,12 +191,11 @@ exports.builder = yargs => {
   addUseEnvironmentOptions(yargs, true);
 
   yargs.positional('src', {
-    describe:
-      'Path to the local file, relative to your current working directory.',
+    describe: i18n(`${i18nKey}.positionals.src.describe`),
     type: 'string',
   });
   yargs.positional('dest', {
-    describe: 'Path in HubSpot Design Tools, can be a net new path.',
+    describe: i18n(`${i18nKey}.positionals.dest.describe`),
     type: 'string',
   });
   return yargs;

package/commands/watch.js

@@ -1,12 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 
-const {
-  watch,
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
+const { watch } = require('@hubspot/cli-lib');
 const { getCwd } = require('@hubspot/cli-lib/path');
 const { logger } = require('@hubspot/cli-lib/logger');
 
@@ -15,42 +10,26 @@ const {
   addAccountOptions,
   addModeOptions,
   addUseEnvironmentOptions,
-  setLogLevel,
   getAccountId,
   getMode,
 } = require('../lib/commonOpts');
-const { logDebugInfo } = require('../lib/debugInfo');
-const { validateAccount, validateMode } = require('../lib/validation');
+const { validateMode, loadAndValidateOptions } = require('../lib/validation');
 const { trackCommandUsage } = require('../lib/usageTracking');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.watch';
+const { EXIT_CODES } = require('../lib/enums/exitCodes');
 
 exports.command = 'watch <src> <dest>';
-exports.describe =
-  'Watch a directory on your computer for changes and upload the changed files to the HubSpot CMS';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  const {
-    src,
-    dest,
-    config: configPath,
-    remove,
-    initialUpload,
-    disableInitial,
-    notify,
-  } = options;
-
-  setLogLevel(options);
-  logDebugInfo(options);
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
-
-  if (
-    !(
-      validateConfig() &&
-      (await validateAccount(options)) &&
-      validateMode(options)
-    )
-  ) {
-    process.exit(1);
+  const { src, dest, remove, initialUpload, disableInitial, notify } = options;
+
+  await loadAndValidateOptions(options);
+
+  if (!validateMode(options)) {
+    process.exit(EXIT_CODES.ERROR);
   }
 
   const accountId = getAccountId(options);
@@ -60,32 +39,34 @@ exports.handler = async options => {
   try {
     const stats = fs.statSync(absoluteSrcPath);
     if (!stats.isDirectory()) {
-      logger.log(`The "${src}" is not a path to a directory`);
+      logger.log(
+        i18n(`${i18nKey}.errors.invalidPath`, {
+          path: src,
+        })
+      );
       return;
     }
   } catch (e) {
-    logger.log(`The "${src}" is not a path to a directory`);
+    logger.log(
+      i18n(`${i18nKey}.errors.invalidPath`, {
+        path: src,
+      })
+    );
     return;
   }
 
   if (!dest) {
-    logger.log('A destination directory needs to be passed');
+    logger.log(i18n(`${i18nKey}.errors.destinationRequired`));
     return;
   }
 
   if (disableInitial) {
-    logger.info(
-      'Passing the "--disable-initial" option is no longer necessary. Running "hs watch" no longer uploads the watched directory by default.'
-    );
+    logger.info(i18n(`${i18nKey}.warnings.disableInitial`));
   } else {
-    logger.info(
-      `The "watch" command no longer uploads the watched directory when started. The directory "${src}" was not uploaded.`
-    );
+    logger.info(i18n(`${i18nKey}.warnings.notUploaded`, { path: src }));
 
     if (!initialUpload) {
-      logger.info(
-        'To upload the directory run "hs upload" beforehand or add the "--initial-upload" option when running "hs watch".'
-      );
+      logger.info(i18n(`${i18nKey}.warnings.initialUpload`));
     }
   }
 
@@ -105,35 +86,32 @@ exports.builder = yargs => {
   addUseEnvironmentOptions(yargs, true);
 
   yargs.positional('src', {
-    describe:
-      'Path to the local directory your files are in, relative to your current working directory',
+    describe: i18n(`${i18nKey}.positionals.src.describe`),
     type: 'string',
   });
   yargs.positional('dest', {
-    describe: 'Path in HubSpot Design Tools. Can be a net new path',
+    describe: i18n(`${i18nKey}.positionals.dest.describe`),
     type: 'string',
   });
   yargs.option('remove', {
     alias: 'r',
-    describe:
-      'Will cause watch to delete files in your HubSpot account that are not found locally.',
+    describe: i18n(`${i18nKey}.options.remove.describe`),
     type: 'boolean',
   });
   yargs.option('initial-upload', {
     alias: 'i',
-    describe: 'Upload directory before watching for updates',
+    describe: i18n(`${i18nKey}.options.initialUpload.describe`),
     type: 'boolean',
   });
   yargs.option('disable-initial', {
     alias: 'd',
-    describe: 'Disable the initial upload when watching a directory (default)',
+    describe: i18n(`${i18nKey}.options.disableInitial.describe`),
     type: 'boolean',
     hidden: true,
   });
   yargs.option('notify', {
     alias: 'n',
-    describe:
-      'Log to specified file when a watch task is triggered and after workers have gone idle. Ex. --notify path/to/file',
+    describe: i18n(`${i18nKey}.options.notify.describe`),
     type: 'string',
     requiresArg: true,
   });

package/lib/commonOpts.js

@@ -6,48 +6,51 @@ const {
   DEFAULT_MODE,
   Mode,
 } = require('@hubspot/cli-lib');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.lib.commonOpts';
 const { LOG_LEVEL } = Logger;
 
 const addAccountOptions = program =>
   program.option('portal', {
     alias: ['p', 'account', 'a'],
-    describe: 'HubSpot portal id or name from config',
+    describe: i18n(`${i18nKey}.options.portal.describe`),
     type: 'string',
   });
 
 const addConfigOptions = yargs =>
   yargs.option('config', {
     alias: 'c',
-    describe: 'path to a config file',
+    describe: i18n(`${i18nKey}.options.config.describe`),
     type: 'string',
   });
 
 const addOverwriteOptions = yargs =>
   yargs.option('overwrite', {
     alias: 'o',
-    describe: 'overwrite existing files',
+    describe: i18n(`${i18nKey}.options.overwrite.describe`),
     type: 'boolean',
     default: false,
   });
 
 const addModeOptions = (yargs, { read, write }) => {
   const modes = `<${Object.values(Mode).join(' | ')}>`;
-  const help = read
-    ? `read from ${modes}`
-    : write
-    ? `write to ${modes}`
-    : `${modes}`;
 
   return yargs.option('mode', {
     alias: 'm',
-    describe: help,
+    describe: i18n(
+      `${i18nKey}.options.modes.describe.${
+        read ? 'read' : write ? 'write' : 'default'
+      }`,
+      { modes }
+    ),
     type: 'string',
   });
 };
 
 const addTestingOptions = yargs =>
   yargs.option('qa', {
-    describe: 'run command in qa mode',
+    describe: i18n(`${i18nKey}.options.qa.describe`),
     type: 'boolean',
     default: false,
     hidden: true,
@@ -55,7 +58,7 @@ const addTestingOptions = yargs =>
 
 const addUseEnvironmentOptions = yargs =>
   yargs.option('use-env', {
-    describe: 'use environment variable config',
+    describe: i18n(`${i18nKey}.options.useEnv.describe`),
     type: 'boolean',
     default: false,
   });

package/lib/enums/exitCodes.js

@@ -0,0 +1,14 @@
+/*
+ * 0: Successful run
+ * 1: Config problem or internal error
+ * 2: Warnings or validation issues
+ */
+const EXIT_CODES = {
+  SUCCESS: 0,
+  ERROR: 1,
+  WARNING: 2,
+};
+
+module.exports = {
+  EXIT_CODES,
+};

package/lib/links.js

@@ -1,4 +1,3 @@
-const supportsHyperlinks = require('supports-hyperlinks');
 const { getEnv } = require('@hubspot/cli-lib/lib/config');
 const { ENVIRONMENTS } = require('@hubspot/cli-lib/lib/constants');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
@@ -121,18 +120,9 @@ const openLink = (accountId, shortcut) => {
   logger.success(`We opened ${match.url} in your browser`);
 };
 
-const link = (linkText, url) => {
-  if (supportsHyperlinks.stdout) {
-    return ['\u001B]8;;', url, '\u0007', linkText, '\u001B]8;;\u0007'].join('');
-  } else {
-    return `${linkText}: ${url}`;
-  }
-};
-
 module.exports = {
   getSiteLinks,
   getSiteLinksAsArray,
   logSiteLinks,
   openLink,
-  link,
 };