@hubspot/cli 3.0.13-beta.1 → 3.0.13-beta.4

package/bin/cli.js

@@ -31,6 +31,7 @@ const openCommand = require('../commands/open');
 const mvCommand = require('../commands/mv');
 const projectCommands = require('../commands/project');
 const themeCommand = require('../commands/theme');
+const moduleCommand = require('../commands/module');
 const configCommand = require('../commands/config');
 const accountsCommand = require('../commands/accounts');
 const sandboxesCommand = require('../commands/sandbox');
@@ -81,6 +82,18 @@ const argv = yargs
     describe: 'set log level to debug',
     type: 'boolean',
   })
+  .option('noHyperlinks', {
+    default: false,
+    describe: 'prevent hyperlinks from displaying in the ui',
+    hidden: true,
+    type: 'boolean',
+  })
+  .option('noColor', {
+    default: false,
+    describe: 'prevent color from displaying in the ui',
+    hidden: true,
+    type: 'boolean',
+  })
   .check(argv => {
     if (argv._.length === 1 && ['upload', 'watch'].includes(argv._[0])) {
       if (getIsInProject(argv.src)) {
@@ -120,6 +133,7 @@ const argv = yargs
   .command(mvCommand)
   .command(projectCommands)
   .command(themeCommand)
+  .command(moduleCommand)
   .command(configCommand)
   .command(accountsCommand)
   .command(sandboxesCommand)

package/commands/module/marketplace-validate.js

@@ -0,0 +1,77 @@
+const { logger } = require('@hubspot/cli-lib/logger');
+
+const {
+  addConfigOptions,
+  addAccountOptions,
+  addUseEnvironmentOptions,
+  getAccountId,
+} = require('../../lib/commonOpts');
+const { loadAndValidateOptions } = require('../../lib/validation');
+const { trackCommandUsage } = require('../../lib/usageTracking');
+const {
+  logValidatorResults,
+} = require('../../lib/validators/logValidatorResults');
+const {
+  applyRelativeValidators,
+} = require('../../lib/validators/applyValidators');
+const MARKETPLACE_VALIDATORS = require('../../lib/validators');
+const { VALIDATION_RESULT } = require('../../lib/validators/constants');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.module.subcommands.marketplaceValidate';
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
+
+exports.command = 'marketplace-validate <src>';
+exports.describe = i18n(`${i18nKey}.describe`);
+
+exports.handler = async options => {
+  const { src } = options;
+
+  await loadAndValidateOptions(options);
+
+  const accountId = getAccountId(options);
+
+  if (!options.json) {
+    logger.log(
+      i18n(`${i18nKey}.logs.validatingModule`, {
+        path: src,
+      })
+    );
+  }
+  trackCommandUsage('validate', {}, accountId);
+
+  applyRelativeValidators(
+    MARKETPLACE_VALIDATORS.module,
+    src,
+    src,
+    accountId
+  ).then(groupedResults => {
+    logValidatorResults(groupedResults, { logAsJson: options.json });
+
+    if (
+      groupedResults
+        .flat()
+        .some(result => result.result === VALIDATION_RESULT.FATAL)
+    ) {
+      process.exit(EXIT_CODES.WARNING);
+    }
+  });
+};
+
+exports.builder = yargs => {
+  addConfigOptions(yargs, true);
+  addAccountOptions(yargs, true);
+  addUseEnvironmentOptions(yargs, true);
+
+  yargs.options({
+    json: {
+      describe: i18n(`${i18nKey}.options.json.describe`),
+      type: 'boolean',
+    },
+  });
+  yargs.positional('src', {
+    describe: i18n(`${i18nKey}.positionals.src.describe`),
+    type: 'string',
+  });
+  return yargs;
+};

package/commands/module.js

@@ -0,0 +1,17 @@
+const marketplaceValidate = require('./module/marketplace-validate');
+const { addConfigOptions, addAccountOptions } = require('../lib/commonOpts');
+// const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+// const i18nKey = 'cli.commands.module';
+
+exports.command = 'module';
+exports.describe = false; //i18n(`${i18nKey}.describe`);
+
+exports.builder = yargs => {
+  addConfigOptions(yargs, true);
+  addAccountOptions(yargs, true);
+
+  yargs.command(marketplaceValidate).demandCommand(1, '');
+
+  return yargs;
+};

package/commands/project/logs.js

@@ -120,7 +120,7 @@ const handleFunctionLog = async (accountId, options) => {
   return false;
 };
 
-exports.command = 'logs [--project] [--app] [--function]';
+exports.command = 'logs [--project] [--app] [--function] [--endpoint]';
 exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
@@ -128,21 +128,22 @@ exports.handler = async options => {
 
   const accountId = getAccountId(options);
 
-  logger.log(options);
   const {
     projectName: promptProjectName,
     appName: promptAppName,
     functionName: promptFunctionName,
+    endpointName: promptEndpointName,
   } = await projectLogsPrompt(accountId, options);
 
   const projectName = options.project || promptProjectName;
   const appName = options.app || promptAppName;
   const functionName =
     options.function || promptFunctionName || options.endpoint;
+  const endpointName = options.endpoint || promptEndpointName;
 
   let relativeAppPath;
 
-  if (appName && !options.endpoint) {
+  if (appName && !endpointName) {
     await ensureProjectExists(accountId, projectName, {
       allowCreate: false,
     });
@@ -168,21 +169,31 @@ exports.handler = async options => {
 
   trackCommandUsage('project-logs', { latest: options.latest }, accountId);
 
-  const logsInfo = [
-    [accountId, `"${projectName}"`, `"${appName}"`, functionName],
-  ];
+  const logsInfo = [accountId, `"${projectName}"`];
+  let tableHeader;
 
-  logsInfo.unshift(
-    getTableHeader([
+  if (endpointName) {
+    logsInfo.push(`"${endpointName}"`);
+    tableHeader = getTableHeader([
+      i18n(`${i18nKey}.table.accountHeader`),
+      i18n(`${i18nKey}.table.projectHeader`),
+      i18n(`${i18nKey}.table.endpointHeader`),
+    ]);
+  } else {
+    logsInfo.push(`"${appName}"`);
+    logsInfo.push(functionName);
+    tableHeader = getTableHeader([
       i18n(`${i18nKey}.table.accountHeader`),
       i18n(`${i18nKey}.table.projectHeader`),
       i18n(`${i18nKey}.table.appHeader`),
       i18n(`${i18nKey}.table.functionHeader`),
-    ])
-  );
+    ]);
+  }
 
   logger.log(i18n(`${i18nKey}.logs.showingLogs`));
-  logger.log(getTableContents(logsInfo, { border: { bodyLeft: '  ' } }));
+  logger.log(
+    getTableContents([tableHeader, logsInfo], { border: { bodyLeft: '  ' } })
+  );
 
   logger.log(
     uiLink(
@@ -197,7 +208,7 @@ exports.handler = async options => {
     ...options,
     projectName,
     appPath: relativeAppPath,
-    functionName,
+    functionName: functionName || endpointName,
   });
 
   if (showFinalMessage) {
@@ -217,7 +228,6 @@ exports.builder = yargs => {
       endpoint: {
         alias: 'endpoint',
         describe: i18n(`${i18nKey}.options.endpoint.describe`),
-        hidden: true,
         requiresArg: true,
         type: 'string',
       },
@@ -253,10 +263,11 @@ exports.builder = yargs => {
     })
     .conflicts('follow', 'limit');
 
+  yargs.example([['$0 project logs', i18n(`${i18nKey}.examples.default`)]]);
   yargs.example([
     [
-      '$0 project logs --project="my-project" --app="app" --function=my-function',
-      i18n(`${i18nKey}.examples.default`),
+      '$0 project logs --project=my-project --app=app --function=my-function',
+      i18n(`${i18nKey}.examples.withOptions`),
     ],
   ]);
 

package/commands/theme/marketplace-validate.js

@@ -16,7 +16,9 @@ const { trackCommandUsage } = require('../../lib/usageTracking');
 const {
   logValidatorResults,
 } = require('../../lib/validators/logValidatorResults');
-const { applyValidators } = require('../../lib/validators/applyValidators');
+const {
+  applyAbsoluteValidators,
+} = require('../../lib/validators/applyValidators');
 const MARKETPLACE_VALIDATORS = require('../../lib/validators');
 const { VALIDATION_RESULT } = require('../../lib/validators/constants');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
@@ -65,7 +67,7 @@ exports.handler = async options => {
 
   const themeFiles = await walk(absoluteSrcPath);
 
-  applyValidators(
+  applyAbsoluteValidators(
     MARKETPLACE_VALIDATORS.theme,
     absoluteSrcPath,
     themeFiles,

package/commands/upload.js

@@ -26,6 +26,7 @@ const {
   getAccountId,
   getMode,
 } = require('../lib/commonOpts');
+const { uploadPrompt } = require('../lib/prompts/uploadPrompt');
 const { validateMode, loadAndValidateOptions } = require('../lib/validation');
 const { trackCommandUsage } = require('../lib/usageTracking');
 const { getThemePreviewUrl } = require('@hubspot/cli-lib/lib/files');
@@ -34,7 +35,7 @@ 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.command = 'upload [--src] [--dest]';
 exports.describe = i18n(`${i18nKey}.describe`);
 
 const logThemePreview = (filePath, accountId) => {
@@ -50,8 +51,6 @@ const logThemePreview = (filePath, accountId) => {
 };
 
 exports.handler = async options => {
-  const { src, dest } = options;
-
   await loadAndValidateOptions(options);
 
   if (!validateMode(options)) {
@@ -60,6 +59,12 @@ exports.handler = async options => {
 
   const accountId = getAccountId(options);
   const mode = getMode(options);
+
+  const uploadPromptAnswers = await uploadPrompt(options);
+
+  const src = options.src || uploadPromptAnswers.src;
+  const dest = options.dest || uploadPromptAnswers.dest;
+
   const absoluteSrcPath = path.resolve(getCwd(), src);
   let stats;
   try {

package/commands/watch.js

@@ -13,6 +13,7 @@ const {
   getAccountId,
   getMode,
 } = require('../lib/commonOpts');
+const { uploadPrompt } = require('../lib/prompts/uploadPrompt');
 const { validateMode, loadAndValidateOptions } = require('../lib/validation');
 const { trackCommandUsage } = require('../lib/usageTracking');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
@@ -20,11 +21,11 @@ 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.command = 'watch [--src] [--dest]';
 exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  const { src, dest, remove, initialUpload, disableInitial, notify } = options;
+  const { remove, initialUpload, disableInitial, notify } = options;
 
   await loadAndValidateOptions(options);
 
@@ -35,6 +36,11 @@ exports.handler = async options => {
   const accountId = getAccountId(options);
   const mode = getMode(options);
 
+  const uploadPromptAnswers = await uploadPrompt(options);
+
+  const src = options.src || uploadPromptAnswers.src;
+  const dest = options.dest || uploadPromptAnswers.dest;
+
   const absoluteSrcPath = path.resolve(getCwd(), src);
   try {
     const stats = fs.statSync(absoluteSrcPath);

package/lib/hasFlag.js

@@ -0,0 +1,15 @@
+const process = require('process');
+
+// See https://github.com/sindresorhus/has-flag/blob/main/index.js (License: https://github.com/sindresorhus/has-flag/blob/main/license)
+
+function hasFlag(flag, argv = process.argv) {
+  const prefix = flag.startsWith('-') ? '' : flag.length === 1 ? '-' : '--';
+  const position = argv.indexOf(prefix + flag);
+  const terminatorPosition = argv.indexOf('--');
+  return (
+    position !== -1 &&
+    (terminatorPosition === -1 || position < terminatorPosition)
+  );
+}
+
+module.exports = hasFlag;

package/lib/projects.js

@@ -483,8 +483,7 @@ const pollBuildStatus = makePollTaskStatusFunc({
   linkToHubSpot: (projectName, buildId, accountId) =>
     uiLink(
       `View build #${buildId} in HubSpot`,
-      getProjectBuildDetailUrl(projectName, buildId, accountId),
-      { useColor: true }
+      getProjectBuildDetailUrl(projectName, buildId, accountId)
     ),
   statusFn: getBuildStatus,
   statusText: PROJECT_BUILD_TEXT,

package/lib/prompts/projectsLogsPrompt.js

@@ -7,22 +7,55 @@ const { EXIT_CODES } = require('../enums/exitCodes');
 
 const i18nKey = 'cli.lib.prompts.projectLogsPrompt';
 
+const SERVERLESS_FUNCTION_TYPES = {
+  APP_FUNCTION: 'app-function',
+  PUBLIC_ENDPOINT: 'public-endpoint',
+};
+
 const projectLogsPrompt = (accountId, promptOptions = {}) => {
   return promptUser([
     {
       name: 'projectName',
-      message: i18n(`${i18nKey}.projectName`),
+      message: i18n(`${i18nKey}.projectName.message`),
       when: !promptOptions.project,
       default: async () => {
         const { projectConfig } = await getProjectConfig();
         return projectConfig && projectConfig.name ? projectConfig.name : null;
       },
+      validate: name =>
+        !name.length ? i18n(`${i18nKey}.projectName.error`) : true,
+    },
+    {
+      name: 'logType',
+      type: 'list',
+      message: i18n(`${i18nKey}.logType.message`),
+      when:
+        !promptOptions.app &&
+        !promptOptions.function &&
+        !promptOptions.endpoint,
+      choices: [
+        {
+          name: i18n(`${i18nKey}.logType.function`),
+          value: SERVERLESS_FUNCTION_TYPES.APP_FUNCTION,
+        },
+        {
+          name: i18n(`${i18nKey}.logType.endpoint`),
+          value: SERVERLESS_FUNCTION_TYPES.PUBLIC_ENDPOINT,
+        },
+      ],
     },
     {
       name: 'appName',
       type: 'list',
       message: i18n(`${i18nKey}.appName`),
-      when: !promptOptions.app && !promptOptions.endpoint,
+      when: ({ logType }) => {
+        return (
+          (promptOptions.function ||
+            logType === SERVERLESS_FUNCTION_TYPES.APP_FUNCTION) &&
+          !promptOptions.app &&
+          !promptOptions.endpoint
+        );
+      },
       choices: async ({ projectName }) => {
         const name = projectName || promptOptions.project;
 
@@ -47,7 +80,25 @@ const projectLogsPrompt = (accountId, promptOptions = {}) => {
     {
       name: 'functionName',
       message: i18n(`${i18nKey}.functionName`),
-      when: !promptOptions.function && !promptOptions.endpoint,
+      when: ({ logType }) => {
+        return (
+          (promptOptions.app ||
+            logType === SERVERLESS_FUNCTION_TYPES.APP_FUNCTION) &&
+          !promptOptions.function &&
+          !promptOptions.endpoint
+        );
+      },
+    },
+    {
+      name: 'endpointName',
+      message: i18n(`${i18nKey}.endpointName`),
+      when: ({ logType }) => {
+        return (
+          logType === SERVERLESS_FUNCTION_TYPES.PUBLIC_ENDPOINT &&
+          !promptOptions.function &&
+          !promptOptions.endpoint
+        );
+      },
     },
   ]);
 };

package/lib/prompts/uploadPrompt.js

@@ -0,0 +1,39 @@
+const path = require('path');
+const { getCwd } = require('@hubspot/cli-lib/path');
+const { promptUser } = require('./promptUtils');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.lib.prompts.uploadPrompt';
+
+const uploadPrompt = (promptOptions = {}) => {
+  return promptUser([
+    {
+      name: 'src',
+      message: i18n(`${i18nKey}.enterSrc`),
+      when: !promptOptions.src,
+      default: '.',
+      validate: input => {
+        if (!input) {
+          return i18n(`${i18nKey}.errors.srcRequired`);
+        }
+        return true;
+      },
+    },
+    {
+      name: 'dest',
+      message: i18n(`${i18nKey}.enterDest`),
+      when: !promptOptions.dest,
+      default: path.basename(getCwd()),
+      validate: input => {
+        if (!input) {
+          return i18n(`${i18nKey}.errors.destRequired`);
+        }
+        return true;
+      },
+    },
+  ]);
+};
+
+module.exports = {
+  uploadPrompt,
+};

package/lib/serverlessLogs.js

@@ -1,5 +1,6 @@
 const https = require('https');
 const Spinnies = require('spinnies');
+const chalk = require('chalk');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { outputLogs } = require('@hubspot/cli-lib/lib/logs');
 const {
@@ -17,6 +18,7 @@ const TAIL_DELAY = 5000;
 const handleUserInput = spinnies => {
   const onTerminate = async () => {
     spinnies.remove('tailLogs');
+    spinnies.remove('stopMessage');
     process.exit(EXIT_CODES.SUCCESS);
   };
 
@@ -83,7 +85,11 @@ const tailLogs = async ({
   const spinnies = new Spinnies();
 
   spinnies.add('tailLogs', {
-    text: `Following logs for ${name}. Press "Q" to stop following`,
+    text: `Following logs for ${name}`,
+  });
+  spinnies.add('stopMessage', {
+    text: `> Press ${chalk.bold('q')} to stop following`,
+    status: 'non-spinnable',
   });
 
   handleUserInput(spinnies);

package/lib/supportHyperlinks.js

@@ -0,0 +1,75 @@
+'use strict';
+const hasFlag = require('./hasFlag');
+
+//See https://github.com/jamestalmage/supports-hyperlinks (License: https://github.com/jamestalmage/supports-hyperlinks/blob/master/license)
+
+function parseVersion(versionString) {
+  if (/^\d{3,4}$/.test(versionString)) {
+    // Env var doesn't always use dots. example: 4601 => 46.1.0
+    const m = /(\d{1,2})(\d{2})/.exec(versionString);
+    return {
+      major: 0,
+      minor: parseInt(m[1], 10),
+      patch: parseInt(m[2], 10),
+    };
+  }
+
+  const versions = (versionString || '').split('.').map(n => parseInt(n, 10));
+  return {
+    major: versions[0],
+    minor: versions[1],
+    patch: versions[2],
+  };
+}
+
+function supportsHyperlink(stream) {
+  const { env } = process;
+
+  if (hasFlag('noHyperlinks')) {
+    return false;
+  }
+
+  if (stream && !stream.isTTY) {
+    return false;
+  }
+
+  if (process.platform === 'win32') {
+    return false;
+  }
+
+  if ('CI' in env) {
+    return false;
+  }
+
+  if ('TERM_PROGRAM' in env) {
+    const version = parseVersion(env.TERM_PROGRAM_VERSION);
+
+    switch (env.TERM_PROGRAM) {
+      case 'iTerm.app':
+        if (version.major === 3) {
+          return version.minor >= 1;
+        }
+
+        return version.major > 3;
+      // No default
+    }
+  }
+
+  if ('VTE_VERSION' in env) {
+    // 0.50.0 was supposed to support hyperlinks, but throws a segfault
+    if (env.VTE_VERSION === '0.50.0') {
+      return false;
+    }
+
+    const version = parseVersion(env.VTE_VERSION);
+    return version.major > 0 || version.minor >= 50;
+  }
+
+  return false;
+}
+
+module.exports = {
+  supportsHyperlink,
+  stdout: supportsHyperlink(process.stdout),
+  stderr: supportsHyperlink(process.stderr),
+};