@hubspot/cli 4.0.1 → 4.0.2-beta.2

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/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/upload.js

@@ -1,6 +1,7 @@
 const fs = require('fs');
 const path = require('path');
-
+const { walk } = require('@hubspot/cli-lib/lib/walk');
+const { createIgnoreFilter } = require('@hubspot/cli-lib/ignoreRules');
 const { uploadFolder, hasUploadErrors } = require('@hubspot/cli-lib');
 const { getFileMapperQueryValues } = require('@hubspot/cli-lib/fileMapper');
 const { upload } = require('@hubspot/cli-lib/api/fileMapper');
@@ -27,13 +28,21 @@ const {
   getMode,
 } = require('../lib/commonOpts');
 const { uploadPrompt } = require('../lib/prompts/uploadPrompt');
+const { fieldsJsPrompt } = require('../lib/prompts/cmsFieldPrompt');
 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 +70,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 +118,6 @@ exports.handler = async options => {
     return;
   }
 
-  if (!dest) {
-    logger.error(i18n(`${i18nKey}.errors.destinationRequired`));
-    return;
-  }
   const normalizedDest = convertToUnixPath(dest);
   trackCommandUsage(
     'upload',
@@ -106,7 +134,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 +151,6 @@ exports.handler = async options => {
       );
       return;
     }
-
     upload(
       accountId,
       absoluteSrcPath,
@@ -156,6 +183,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 +199,22 @@ exports.handler = async options => {
         src,
       })
     );
-    uploadFolder(accountId, absoluteSrcPath, dest, {
-      mode,
-    })
+
+    // Generate the first-pass file list in here, and pass to uploadFolder.
+    const filePaths = await getUploadableFileList(
+      absoluteSrcPath,
+      options.processFieldsJs
+    );
+    uploadFolder(
+      accountId,
+      absoluteSrcPath,
+      dest,
+      {
+        mode,
+      },
+      options,
+      filePaths
+    )
       .then(results => {
         if (!hasUploadErrors(results)) {
           logger.success(
@@ -200,6 +247,46 @@ exports.handler = async options => {
   }
 };
 
+/*
+ * Walks the src folder for files, filters them based on ignore filter.
+ * If processFieldsJs is true then will check for any JS fields conflicts (i.e., JS fields file and fields.json file) and prompt to resolve
+ */
+const getUploadableFileList = async (src, processFieldsJs) => {
+  const filePaths = await walk(src);
+  const allowedFiles = filePaths
+    .filter(file => {
+      if (!isAllowedExtension(file)) {
+        return false;
+      }
+      return true;
+    })
+    .filter(createIgnoreFilter());
+  if (!processFieldsJs) {
+    return allowedFiles;
+  }
+
+  let uploadableFiles = [];
+  let skipFiles = [];
+  for (const filePath of allowedFiles) {
+    const fileName = path.basename(filePath);
+    if (skipFiles.includes(filePath)) continue;
+    const isProcessable = isProcessableFieldsJs(src, filePath, processFieldsJs);
+    if (isProcessable || fileName == 'fields.json') {
+      // This prompt checks if there are multiple field files in the folder and gets user to choose.
+      const [choice, updatedSkipFiles] = await fieldsJsPrompt(
+        filePath,
+        src,
+        skipFiles
+      );
+      skipFiles = updatedSkipFiles;
+      // If they chose something other than the current file, move on.
+      if (choice !== filePath) continue;
+    }
+    uploadableFiles.push(filePath);
+  }
+  return uploadableFiles;
+};
+
 exports.builder = yargs => {
   addConfigOptions(yargs, true);
   addAccountOptions(yargs, true);
@@ -214,5 +301,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/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",
+  "version": "4.0.2-beta.2",
   "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",
-    "@hubspot/serverless-dev-runtime": "4.0.1",
+    "@hubspot/cli-lib": "4.0.2-beta.2",
+    "@hubspot/serverless-dev-runtime": "4.0.2-beta.2",
     "archiver": "^5.3.0",
     "chalk": "^4.1.2",
     "express": "^4.17.1",
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "416585f18c9b856b4da3ef502d1eccaded9281d5"
+  "gitHead": "e934f0fea1842d1f28df725c425308327f449f6a"
 }