@hubspot/cli 4.0.1-beta.4 → 4.0.2-beta.0

package/bin/cli.js

@@ -35,6 +35,7 @@ const moduleCommand = require('../commands/module');
 const configCommand = require('../commands/config');
 const accountsCommand = require('../commands/accounts');
 const sandboxesCommand = require('../commands/sandbox');
+const processCommand = require('../commands/process');
 const cmsCommand = require('../commands/cms');
 const { EXIT_CODES } = require('../lib/enums/exitCodes');
 
@@ -154,6 +155,7 @@ const argv = yargs
   .command(configCommand)
   .command(accountsCommand)
   .command(sandboxesCommand)
+  .command(processCommand, false)
   .help()
   .recommendCommands()
   .demandCommand(1, '')

package/commands/cms/lighthouseScore.js

@@ -49,7 +49,10 @@ const selectTheme = async accountId => {
       message: i18n(`${i18nKey}.info.promptMessage`),
       choices: async () => {
         try {
-          const result = await fetchThemes(accountId);
+          const result = await fetchThemes(accountId, {
+            limit: 500,
+            sorting: 'MOST_USED',
+          });
           if (result && result.objects) {
             return result.objects
               .map(({ theme }) => theme.path)

package/commands/init.js

@@ -8,6 +8,7 @@ const {
 } = require('@hubspot/cli-lib/lib/config');
 const { addConfigOptions } = require('../lib/commonOpts');
 const { handleExit } = require('@hubspot/cli-lib/lib/process');
+const { checkAndUpdateGitignore } = require('@hubspot/cli-lib/lib/git');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 const {
   DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME,
@@ -116,6 +117,8 @@ exports.handler = async options => {
     );
     const configPath = getConfigPath();
 
+    checkAndUpdateGitignore(configPath);
+
     logger.log('');
     logger.success(
       i18n(`${i18nKey}.success.configFileCreated`, {

package/commands/process.js

@@ -0,0 +1,85 @@
+const path = require('path');
+const fs = require('fs');
+const { createIgnoreFilter } = require('@hubspot/cli-lib/ignoreRules');
+const { isAllowedExtension } = require('@hubspot/cli-lib//path');
+const { logger } = require('@hubspot/cli-lib/logger');
+const { walk } = require('@hubspot/cli-lib/lib/walk');
+const { getThemeJSONPath } = require('@hubspot/cli-lib/lib/files');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const {
+  FieldsJs,
+  isProcessableFieldsJs,
+} = require('@hubspot/cli-lib/lib/handleFieldsJs');
+const i18nKey = 'cli.commands.process';
+
+exports.command = 'process';
+exports.describe = false;
+
+const invalidPath = src => {
+  logger.error(
+    i18n(`${i18nKey}.errors.invalidPath`, {
+      path: src,
+    })
+  );
+};
+
+exports.handler = async options => {
+  const src = options.src;
+  const projectRoot = path.dirname(getThemeJSONPath(src));
+  let stats;
+  try {
+    stats = fs.statSync(src);
+    if (!stats.isFile() && !stats.isDirectory()) {
+      invalidPath(src);
+      return;
+    }
+  } catch (e) {
+    invalidPath(src);
+  }
+
+  if (stats.isFile()) {
+    const fieldsJs = await new FieldsJs(
+      projectRoot,
+      src,
+      undefined,
+      options.fieldOptions
+    ).init();
+    if (fieldsJs.rejected) return;
+    fieldsJs.saveOutput();
+  } else if (stats.isDirectory()) {
+    const filePaths = await walk(src);
+    const allowedFilePaths = filePaths
+      .filter(file => {
+        if (!isAllowedExtension(file)) {
+          return false;
+        }
+        return true;
+      })
+      .filter(createIgnoreFilter());
+    for (const filePath of allowedFilePaths) {
+      if (isProcessableFieldsJs(projectRoot, filePath, true)) {
+        const fieldsJs = await new FieldsJs(
+          projectRoot,
+          filePath,
+          undefined,
+          options.fieldOptions
+        ).init();
+        if (fieldsJs.rejected) return;
+        fieldsJs.saveOutput();
+      }
+    }
+  }
+};
+
+exports.builder = yargs => {
+  yargs.positional('src', {
+    describe: i18n(`${i18nKey}.positionals.src.describe`),
+    type: 'string',
+  });
+  yargs.option('fieldOptions', {
+    describe: i18n(`${i18nKey}.options.options.describe`),
+    type: 'array',
+    default: [''],
+  });
+  return yargs;
+};

package/commands/sandbox/create.js

@@ -13,6 +13,9 @@ const { loadAndValidateOptions } = require('../../lib/validation');
 const { createSandboxPrompt } = require('../../lib/prompts/sandboxesPrompt');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
+const {
+  debugErrorAndContext,
+} = require('@hubspot/cli-lib/errorHandlers/standardErrors');
 const {
   ENVIRONMENTS,
   PERSONAL_ACCESS_KEY_AUTH_METHOD,
@@ -103,7 +106,7 @@ const personalAccessKeyFlow = async (env, account, name) => {
   ]);
 };
 
-exports.command = 'create [name]';
+exports.command = 'create [--name]';
 exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
@@ -117,10 +120,10 @@ exports.handler = async options => {
     succeedColor: 'white',
   });
 
-  let namePrompt;
-
   trackCommandUsage('sandbox-create', {}, accountId);
 
+  let namePrompt;
+
   if (!name) {
     namePrompt = await createSandboxPrompt();
   }
@@ -146,11 +149,16 @@ exports.handler = async options => {
       }),
     });
   } catch (err) {
+    debugErrorAndContext(err);
+
+    trackCommandUsage('sandbox-create', { success: false }, accountId);
+
     spinnies.fail('sandboxCreate', {
       text: i18n(`${i18nKey}.loading.fail`, {
         sandboxName,
       }),
     });
+
     if (isMissingScopeError(err)) {
       logger.error(
         i18n(`${i18nKey}.failure.scopes.message`, {
@@ -180,13 +188,16 @@ exports.handler = async options => {
 };
 
 exports.builder = yargs => {
-  yargs.positional('name', {
-    describe: i18n(`${i18nKey}.positionals.name.describe`),
+  yargs.option('name', {
+    describe: i18n(`${i18nKey}.options.name.describe`),
     type: 'string',
   });
 
   yargs.example([
-    ['$0 sandbox create MySandboxAccount', i18n(`${i18nKey}.examples.default`)],
+    [
+      '$0 sandbox create --name=MySandboxAccount',
+      i18n(`${i18nKey}.examples.default`),
+    ],
   ]);
 
   addConfigOptions(yargs, true);

package/commands/sandbox/delete.js

@@ -8,12 +8,17 @@ const {
 const { logger } = require('@hubspot/cli-lib/logger');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { loadAndValidateOptions } = require('../../lib/validation');
+const {
+  debugErrorAndContext,
+} = require('@hubspot/cli-lib/errorHandlers/standardErrors');
 
 const { deleteSandbox } = require('@hubspot/cli-lib/sandboxes');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
 const { getConfig, getEnv } = require('@hubspot/cli-lib');
 const { deleteSandboxPrompt } = require('../../lib/prompts/sandboxesPrompt');
-const { removeAccountFromConfig } = require('@hubspot/cli-lib/lib/config');
+const {
+  removeSandboxAccountFromConfig,
+} = require('@hubspot/cli-lib/lib/config');
 const {
   selectAndSetAsDefaultAccountPrompt,
 } = require('../../lib/prompts/accountsPrompt');
@@ -111,12 +116,18 @@ exports.handler = async options => {
     );
     logger.log('');
 
-    const promptDefaultAccount = removeAccountFromConfig(sandboxAccountId);
+    const promptDefaultAccount = removeSandboxAccountFromConfig(
+      sandboxAccountId
+    );
     if (promptDefaultAccount) {
       await selectAndSetAsDefaultAccountPrompt(config);
     }
     process.exit(EXIT_CODES.SUCCESS);
   } catch (err) {
+    debugErrorAndContext(err);
+
+    trackCommandUsage('sandbox-delete', { success: false }, sandboxAccountId);
+
     if (
       err.error &&
       err.error.category === OBJECT_NOT_FOUND &&
@@ -130,7 +141,9 @@ exports.handler = async options => {
       );
       logger.log('');
 
-      const promptDefaultAccount = removeAccountFromConfig(sandboxAccountId);
+      const promptDefaultAccount = removeSandboxAccountFromConfig(
+        sandboxAccountId
+      );
       if (promptDefaultAccount) {
         await selectAndSetAsDefaultAccountPrompt(config);
       }

package/commands/upload.js

@@ -1,6 +1,5 @@
 const fs = require('fs');
 const path = require('path');
-
 const { uploadFolder, hasUploadErrors } = require('@hubspot/cli-lib');
 const { getFileMapperQueryValues } = require('@hubspot/cli-lib/fileMapper');
 const { upload } = require('@hubspot/cli-lib/api/fileMapper');
@@ -29,11 +28,18 @@ const {
 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');
+const {
+  getThemePreviewUrl,
+  getThemeJSONPath,
+} = 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');
+const {
+  FieldsJs,
+  isProcessableFieldsJs,
+  cleanupTmpDirSync,
+} = require('@hubspot/cli-lib/lib/handleFieldsJs');
 
 exports.command = 'upload [--src] [--dest]';
 exports.describe = i18n(`${i18nKey}.describe`);
@@ -61,11 +67,34 @@ exports.handler = async 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);
+  const saveOutput = options.saveOutput;
+  let dest = options.dest || uploadPromptAnswers.dest;
+  let absoluteSrcPath = path.resolve(getCwd(), src);
+  if (!dest) {
+    logger.error(i18n(`${i18nKey}.errors.destinationRequired`));
+    return;
+  }
+  // The theme.json file must always be at the root of the project - so we look for that and determine the root path based on it.
+  const projectRoot = path.dirname(getThemeJSONPath(absoluteSrcPath));
+  const processFieldsJs = isProcessableFieldsJs(
+    projectRoot,
+    absoluteSrcPath,
+    options.processFieldsJs
+  );
+  let fieldsJs;
+  if (processFieldsJs) {
+    fieldsJs = await new FieldsJs(
+      projectRoot,
+      absoluteSrcPath,
+      undefined,
+      options.fieldOptions
+    ).init();
+    if (fieldsJs.rejected) return;
+    // Ensures that the dest path is a .json. The user might pass '.js' accidentally - this ensures it just works.
+    absoluteSrcPath = fieldsJs.outputPath;
+    dest = path.join(path.dirname(dest), 'fields.json');
+  }
   let stats;
   try {
     stats = fs.statSync(absoluteSrcPath);
@@ -86,10 +115,6 @@ exports.handler = async options => {
     return;
   }
 
-  if (!dest) {
-    logger.error(i18n(`${i18nKey}.errors.destinationRequired`));
-    return;
-  }
   const normalizedDest = convertToUnixPath(dest);
   trackCommandUsage(
     'upload',
@@ -106,7 +131,7 @@ exports.handler = async options => {
     process.exit(EXIT_CODES.WARNING);
   }
   if (stats.isFile()) {
-    if (!isAllowedExtension(src)) {
+    if (!isAllowedExtension(src) && !processFieldsJs) {
       logger.error(
         i18n(`${i18nKey}.errors.invalidPath`, {
           path: src,
@@ -123,7 +148,6 @@ exports.handler = async options => {
       );
       return;
     }
-
     upload(
       accountId,
       absoluteSrcPath,
@@ -156,6 +180,13 @@ exports.handler = async options => {
           })
         );
         process.exit(EXIT_CODES.WARNING);
+      })
+      .finally(() => {
+        if (!processFieldsJs) return;
+        if (saveOutput) {
+          fieldsJs.saveOutput();
+        }
+        cleanupTmpDirSync(fieldsJs.rootWriteDir);
       });
   } else {
     logger.log(
@@ -165,9 +196,15 @@ exports.handler = async options => {
         src,
       })
     );
-    uploadFolder(accountId, absoluteSrcPath, dest, {
-      mode,
-    })
+    uploadFolder(
+      accountId,
+      absoluteSrcPath,
+      dest,
+      {
+        mode,
+      },
+      options
+    )
       .then(results => {
         if (!hasUploadErrors(results)) {
           logger.success(
@@ -214,5 +251,24 @@ exports.builder = yargs => {
     describe: i18n(`${i18nKey}.positionals.dest.describe`),
     type: 'string',
   });
+  yargs.option('fieldOptions', {
+    describe: i18n(`${i18nKey}.options.options.describe`),
+    type: 'array',
+    default: [''],
+    hidden: true,
+  });
+  yargs.option('saveOutput', {
+    describe: i18n(`${i18nKey}.options.saveOutput.describe`),
+    type: 'boolean',
+    default: false,
+    hidden: true,
+  });
+  yargs.option('processFieldsJs', {
+    describe: i18n(`${i18nKey}.options.processFields.describe`),
+    alias: ['processFields'],
+    type: 'boolean',
+    default: false,
+    hidden: true,
+  });
   return yargs;
 };

package/commands/watch.js

@@ -82,6 +82,7 @@ exports.handler = async options => {
     remove,
     disableInitial: initialUpload ? false : true,
     notify,
+    commandOptions: options,
   });
 };
 
@@ -99,6 +100,12 @@ exports.builder = yargs => {
     describe: i18n(`${i18nKey}.positionals.dest.describe`),
     type: 'string',
   });
+  yargs.option('fieldOptions', {
+    describe: i18n(`${i18nKey}.options.options.describe`),
+    type: 'array',
+    default: [''],
+    hidden: true,
+  });
   yargs.option('remove', {
     alias: 'r',
     describe: i18n(`${i18nKey}.options.remove.describe`),
@@ -121,6 +128,18 @@ exports.builder = yargs => {
     type: 'string',
     requiresArg: true,
   });
-
+  yargs.option('processFieldsJs', {
+    describe: i18n(`${i18nKey}.options.processFields.describe`),
+    alias: ['processFields'],
+    type: 'boolean',
+    default: false,
+    hidden: true,
+  });
+  yargs.option('saveOutput', {
+    describe: i18n(`${i18nKey}.options.saveOutput.describe`),
+    type: 'boolean',
+    default: false,
+    hidden: true,
+  });
   return yargs;
 };

package/lib/projects.js

@@ -224,6 +224,13 @@ const getProjectBuildDetailUrl = (projectName, buildId, accountId) => {
   return `${getProjectDetailUrl(projectName, accountId)}/build/${buildId}`;
 };
 
+const getProjectDeployDetailUrl = (projectName, deployId, accountId) => {
+  if (!projectName || !deployId || !accountId) return;
+  return `${getProjectDetailUrl(
+    projectName,
+    accountId
+  )}/activity/deploy/${deployId}`;
+};
 const uploadProjectFiles = async (accountId, projectName, filePath) => {
   const i18nKey = 'cli.commands.project.subcommands.upload';
   const spinnies = new Spinnies({
@@ -343,10 +350,13 @@ const makePollTaskStatusFunc = ({
     }
   };
 
-  return async (accountId, taskName, taskId) => {
-    let hubspotLinkText = '';
+  return async (accountId, taskName, taskId, deployedBuildId = null) => {
+    const displayId = deployedBuildId || taskId;
+
     if (linkToHubSpot) {
-      logger.log(`\n${linkToHubSpot(taskName, taskId, accountId)}\n`);
+      logger.log(
+        `\n${linkToHubSpot(accountId, taskName, taskId, deployedBuildId)}\n`
+      );
     }
 
     const spinnies = new Spinnies({
@@ -372,7 +382,7 @@ const makePollTaskStatusFunc = ({
       const subTaskName = subTask[statusText.SUBTASK_NAME_KEY];
 
       spinnies.add(subTaskName, {
-        text: `${chalk.bold(subTaskName)} #${taskId} ${
+        text: `${chalk.bold(subTaskName)} #${displayId} ${
           statusText.STATUS_TEXT[statusText.STATES.ENQUEUED]
         }\n`,
         indent: 2,
@@ -395,7 +405,7 @@ const makePollTaskStatusFunc = ({
               return;
             }
 
-            const updatedText = `${chalk.bold(subTaskName)} #${taskId} ${
+            const updatedText = `${chalk.bold(subTaskName)} #${displayId} ${
               statusText.STATUS_TEXT[subTask.status]
             }\n`;
 
@@ -413,17 +423,17 @@ const makePollTaskStatusFunc = ({
           });
 
           if (isTaskComplete(taskStatus)) {
-            subTaskStatus.forEach(subTask => {
-              spinnies.remove(subTask[statusText.SUBTASK_NAME_KEY]);
-            });
+            // subTaskStatus.forEach(subTask => {
+            //   spinnies.remove(subTask[statusText.SUBTASK_NAME_KEY]);
+            // });
 
             if (status === statusText.STATES.SUCCESS) {
               spinnies.succeed('overallTaskStatus', {
-                text: `${statusStrings.SUCCESS(taskName)}${hubspotLinkText}`,
+                text: statusStrings.SUCCESS(taskName),
               });
             } else if (status === statusText.STATES.FAILURE) {
               spinnies.fail('overallTaskStatus', {
-                text: `${statusStrings.FAIL(taskName)}${hubspotLinkText}`,
+                text: statusStrings.FAIL(taskName),
               });
 
               const failedSubtask = subTaskStatus.filter(
@@ -433,7 +443,7 @@ const makePollTaskStatusFunc = ({
               uiLine();
               logger.log(
                 `${statusStrings.SUBTASK_FAIL(
-                  taskId,
+                  displayId,
                   failedSubtask.length === 1
                     ? failedSubtask[0][statusText.SUBTASK_NAME_KEY]
                     : failedSubtask.length + ' components'
@@ -470,10 +480,10 @@ const makePollTaskStatusFunc = ({
 };
 
 const pollBuildStatus = makePollTaskStatusFunc({
-  linkToHubSpot: (projectName, buildId, accountId) =>
+  linkToHubSpot: (accountId, taskName, taskId) =>
     uiLink(
-      `View build #${buildId} in HubSpot`,
-      getProjectBuildDetailUrl(projectName, buildId, accountId)
+      `View build #${taskId} in HubSpot`,
+      getProjectBuildDetailUrl(taskName, taskId, accountId)
     ),
   statusFn: getBuildStatus,
   statusText: PROJECT_BUILD_TEXT,
@@ -481,22 +491,27 @@ const pollBuildStatus = makePollTaskStatusFunc({
     INITIALIZE: name => `Building ${chalk.bold(name)}`,
     SUCCESS: name => `Built ${chalk.bold(name)}`,
     FAIL: name => `Failed to build ${chalk.bold(name)}`,
-    SUBTASK_FAIL: (taskId, name) =>
-      `Build #${taskId} failed because there was a problem\nbuilding ${chalk.bold(
+    SUBTASK_FAIL: (buildId, name) =>
+      `Build #${buildId} failed because there was a problem\nbuilding ${chalk.bold(
         name
       )}`,
   },
 });
 
 const pollDeployStatus = makePollTaskStatusFunc({
+  linkToHubSpot: (accountId, taskName, taskId, deployedBuildId) =>
+    uiLink(
+      `View deploy of build #${deployedBuildId} in HubSpot`,
+      getProjectDeployDetailUrl(taskName, taskId, accountId)
+    ),
   statusFn: getDeployStatus,
   statusText: PROJECT_DEPLOY_TEXT,
   statusStrings: {
     INITIALIZE: name => `Deploying ${chalk.bold(name)}`,
     SUCCESS: name => `Deployed ${chalk.bold(name)}`,
     FAIL: name => `Failed to deploy ${chalk.bold(name)}`,
-    SUBTASK_FAIL: (taskId, name) =>
-      `Deploy for build #${taskId} failed because there was a\nproblem deploying ${chalk.bold(
+    SUBTASK_FAIL: (deployedBuildId, name) =>
+      `Deploy for build #${deployedBuildId} failed because there was a\nproblem deploying ${chalk.bold(
         name
       )}`,
   },

package/lib/prompts/cmsFieldPrompt.js

@@ -0,0 +1,50 @@
+const path = require('path');
+const fs = require('fs');
+const { promptUser } = require('./promptUtils');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const escapeRegExp = require('@hubspot/cli-lib/lib/escapeRegExp');
+const i18nKey = 'cli.lib.prompts.uploadPrompt';
+const FIELDS_FILES = ['fields.json', 'fields.js', 'fields.cjs', 'fields.mjs'];
+
+const fieldsJsPrompt = async (filePath, projectDir, skipFiles = []) => {
+  const dirName = path.dirname(filePath);
+
+  // Get a list of all field files in the directory, resolve their absolute path, and remove the ones that we already skipped.
+  const fileChoices = fs
+    .readdirSync(dirName)
+    .filter(file => FIELDS_FILES.includes(file))
+    .map(file => path.resolve(dirName, file))
+    .filter(file => !skipFiles.includes(file));
+
+  if (!fileChoices.length) return [filePath, []];
+  if (fileChoices.length == 1) return [fileChoices[0], []];
+
+  // We get the directory above the project one so that relative paths are printed with the root of the project dir attached.
+  projectDir = projectDir.substring(0, projectDir.lastIndexOf('/'));
+  const projectDirRegex = new RegExp(`^${escapeRegExp(projectDir)}`);
+  const fileDir = path.dirname(fileChoices[0]).replace(projectDirRegex, '');
+
+  const selection = [];
+  fileChoices.forEach(fileChoice => {
+    selection.push({
+      name: fileChoice.replace(projectDirRegex, ''),
+      value: fileChoice,
+    });
+  });
+  const promptVal = await promptUser([
+    {
+      message: i18n(`${i18nKey}.fieldsPrompt`, { dir: fileDir }),
+      type: 'list',
+      name: 'filePathChoice',
+      choices: selection,
+    },
+  ]);
+  const choice = promptVal.filePathChoice;
+
+  // Add the ones that were not picked to skip files array.
+  const notPicked = fileChoices.filter(item => item !== choice);
+  skipFiles.push(...notPicked);
+  return [choice, skipFiles];
+};
+
+module.exports = { fieldsJsPrompt };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/cli",
-  "version": "4.0.1-beta.4",
+  "version": "4.0.2-beta.0",
   "description": "CLI for working with HubSpot",
   "license": "Apache-2.0",
   "repository": {
@@ -8,8 +8,8 @@
     "url": "https://github.com/HubSpot/hubspot-cms-tools"
   },
   "dependencies": {
-    "@hubspot/cli-lib": "4.0.1-beta.4",
-    "@hubspot/serverless-dev-runtime": "4.0.1-beta.4",
+    "@hubspot/cli-lib": "4.0.2-beta.0",
+    "@hubspot/serverless-dev-runtime": "4.0.2-beta.0",
     "archiver": "^5.3.0",
     "chalk": "^4.1.2",
     "express": "^4.17.1",
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "38cd22d1d1a3d8d06d65dfb40ba4d6b3b659e205"
+  "gitHead": "861cd70866ca2e8f803d5b61c73fccd04f3d6c75"
 }