@hubspot/cli 3.0.10-beta.6 → 3.0.10

package/lib/projects.js

@@ -3,7 +3,6 @@ const path = require('path');
 
 const chalk = require('chalk');
 const findup = require('findup-sync');
-const { prompt } = require('inquirer');
 const Spinnies = require('spinnies');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { getEnv } = require('@hubspot/cli-lib/lib/config');
@@ -11,12 +10,12 @@ const {
   createProject: createProjectTemplate,
 } = require('@hubspot/cli-lib/projects');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
-
 const {
   ENVIRONMENTS,
   POLLING_DELAY,
-  PROJECT_TEMPLATE_REPO,
+  PROJECT_TEMPLATES,
   PROJECT_TEXT,
+  PROJECT_CONFIG_FILE,
 } = require('@hubspot/cli-lib/lib/constants');
 const {
   createProject,
@@ -28,6 +27,10 @@ const {
   logApiErrorInstance,
   ApiErrorContext,
 } = require('@hubspot/cli-lib/errorHandlers');
+const { getCwd } = require('@hubspot/cli-lib/path');
+const { promptUser } = require('./prompts/promptUtils');
+const { EXIT_CODES } = require('./enums/exitCodes');
+const { uiLine, uiAccountDescription } = require('../lib/ui');
 
 const PROJECT_STRINGS = {
   BUILD: {
@@ -37,6 +40,10 @@ const PROJECT_STRINGS = {
       } in this project ...\n`,
     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(
+        name
+      )}`,
   },
   DEPLOY: {
     INITIALIZE: (name, numOfComponents) =>
@@ -45,6 +52,10 @@ const PROJECT_STRINGS = {
       } in this project ...\n`,
     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(
+        name
+      )}`,
   },
 };
 
@@ -58,89 +69,93 @@ const writeProjectConfig = (configPath, config) => {
   }
 };
 
-const getProjectConfig = async projectPath => {
-  const configPath = findup('hsproject.json', {
-    cwd: projectPath,
+const getIsInProject = async _dir => {
+  const configPath = await getProjectConfigPath(_dir);
+  return !!configPath;
+};
+
+const getProjectConfigPath = async _dir => {
+  const projectDir = _dir ? path.resolve(getCwd(), _dir) : getCwd();
+
+  const configPath = findup(PROJECT_CONFIG_FILE, {
+    cwd: projectDir,
     nocase: true,
   });
 
+  return configPath;
+};
+
+const getProjectConfig = async _dir => {
+  const configPath = await getProjectConfigPath(_dir);
   if (!configPath) {
-    return null;
+    return { projectConfig: null, projectDir: null };
   }
 
   try {
-    const projectConfig = fs.readFileSync(configPath);
-    return JSON.parse(projectConfig);
+    const config = fs.readFileSync(configPath);
+    const projectConfig = JSON.parse(config);
+    return {
+      projectDir: path.dirname(configPath),
+      projectConfig,
+    };
   } catch (e) {
     logger.error('Could not read from project config');
   }
 };
 
-const createProjectConfig = async (projectPath, projectName) => {
-  const projectConfig = await getProjectConfig(projectPath);
-  const projectConfigPath = path.join(projectPath, 'hsproject.json');
+const createProjectConfig = async (projectPath, projectName, template) => {
+  const { projectConfig, projectDir } = await getProjectConfig(projectPath);
 
   if (projectConfig) {
-    logger.log(
-      `Found an existing project config in this folder (${chalk.bold(
-        projectConfig.name
-      )})`
-    );
-  } else {
-    logger.log(
-      `Creating project in ${projectPath ? projectPath : 'the current folder'}`
+    logger.warn(
+      projectPath === projectDir
+        ? 'A project already exists in that location.'
+        : `Found an existing project definition in ${projectDir}.`
     );
-    const { name, template, srcDir } = await prompt([
+
+    const { shouldContinue } = await promptUser([
       {
-        name: 'name',
-        message: 'Please enter a project name:',
-        when: !projectName,
-        validate: input => {
-          if (!input) {
-            return 'A project name is required';
-          }
-          return true;
+        name: 'shouldContinue',
+        message: () => {
+          return projectPath === projectDir
+            ? 'Do you want to overwrite the existing project definition with a new one?'
+            : `Continue creating a new project in ${projectPath}?`;
         },
-      },
-      {
-        name: 'template',
-        message: 'Start from a template?',
-        type: 'rawlist',
-        choices: [
-          {
-            name: 'No template',
-            value: 'none',
-          },
-          {
-            name: 'Getting Started Project',
-            value: 'getting-started',
-          },
-        ],
+        type: 'confirm',
+        default: false,
       },
     ]);
 
-    if (template === 'none') {
-      fs.ensureDirSync(path.join(projectPath, 'src'));
-
-      writeProjectConfig(projectConfigPath, {
-        name: projectName || name,
-        srcDir: 'src',
-      });
-    } else {
-      await createProjectTemplate(
-        projectPath,
-        'project',
-        PROJECT_TEMPLATE_REPO[template],
-        ''
-      );
-      const _config = JSON.parse(fs.readFileSync(projectConfigPath));
-      writeProjectConfig(projectConfigPath, {
-        ..._config,
-        name: projectName || name,
-      });
+    if (!shouldContinue) {
+      return;
     }
+  }
+
+  const projectConfigPath = path.join(projectPath, PROJECT_CONFIG_FILE);
+
+  logger.log(
+    `Creating project in ${projectPath ? projectPath : 'the current folder'}`
+  );
+
+  if (template === 'none') {
+    fs.ensureDirSync(path.join(projectPath, 'src'));
 
-    return { name, srcDir };
+    writeProjectConfig(projectConfigPath, {
+      name: projectName,
+      srcDir: 'src',
+    });
+  } else {
+    await createProjectTemplate(
+      projectPath,
+      'project',
+      PROJECT_TEMPLATES.find(t => t.name === template).repo,
+      ''
+    );
+    const _config = JSON.parse(fs.readFileSync(projectConfigPath));
+    writeProjectConfig(projectConfigPath, {
+      ..._config,
+      name: projectName,
+    });
   }
 
   return projectConfig;
@@ -149,23 +164,23 @@ const createProjectConfig = async (projectPath, projectName) => {
 const validateProjectConfig = (projectConfig, projectDir) => {
   if (!projectConfig) {
     logger.error(
-      `Project config not found. Try running 'hs project init' first.`
+      `Project config not found. Try running 'hs project create' first.`
     );
-    process.exit(1);
+    process.exit(EXIT_CODES.ERROR);
   }
 
   if (!projectConfig.name || !projectConfig.srcDir) {
     logger.error(
-      'Project config is missing required fields. Try running `hs project init`.'
+      'Project config is missing required fields. Try running `hs project create`.'
     );
-    process.exit(1);
+    process.exit(EXIT_CODES.ERROR);
   }
 
   if (!fs.existsSync(path.resolve(projectDir, projectConfig.srcDir))) {
     logger.error(
-      `Project source directory '${projectConfig.srcDir}' does not exist.`
+      `Project source directory '${projectConfig.srcDir}' could not be found in ${projectDir}.`
     );
-    process.exit(1);
+    process.exit(EXIT_CODES.ERROR);
   }
 };
 
@@ -177,10 +192,12 @@ const ensureProjectExists = async (accountId, projectName, forceCreate) => {
       let shouldCreateProject = forceCreate;
 
       if (!shouldCreateProject) {
-        const promptResult = await prompt([
+        const promptResult = await promptUser([
           {
             name: 'shouldCreateProject',
-            message: `The project ${projectName} does not exist in ${accountId}. Would you like to create it?`,
+            message: `The project ${projectName} does not exist in ${uiAccountDescription(
+              accountId
+            )}. Would you like to create it?`,
             type: 'confirm',
           },
         ]);
@@ -222,7 +239,7 @@ const showWelcomeMessage = () => {
     '\n-------------------------------------------------------------\n'
   );
   logger.log(chalk.bold("What's next?\n"));
-  logger.log('🎨 Add deployables to your project with `hs create`.\n');
+  logger.log('🎨 Add components to your project with `hs create`.\n');
   logger.log(
     `🏗  Run \`hs project upload\` to upload your files to HubSpot and trigger builds.\n`
   );
@@ -264,6 +281,7 @@ const makeGetTaskStatus = taskType => {
     const spinnies = new Spinnies({
       succeedColor: 'white',
       failColor: 'white',
+      failPrefix: chalk.bold('!'),
     });
 
     spinnies.add('overallTaskStatus', { text: 'Beginning' });
@@ -309,12 +327,12 @@ const makeGetTaskStatus = taskType => {
                 });
                 break;
               case statusText.STATES.FAILURE:
-                spinnies.fail(subTask.buildName, {
+                spinnies.fail(subTask[statusText.SUBTASK_NAME_KEY], {
                   text: updatedText,
                 });
                 break;
               default:
-                spinnies.update(subTask.buildName, {
+                spinnies.update(subTask[statusText.SUBTASK_NAME_KEY], {
                   text: updatedText,
                 });
                 break;
@@ -322,8 +340,8 @@ const makeGetTaskStatus = taskType => {
           });
 
           if (isTaskComplete(taskStatus)) {
-            subTaskStatus.forEach(subBuild => {
-              spinnies.remove(subBuild[statusText.SUBTASK_NAME_KEY]);
+            subTaskStatus.forEach(subTask => {
+              spinnies.remove(subTask[statusText.SUBTASK_NAME_KEY]);
             });
 
             if (status === statusText.STATES.SUCCESS) {
@@ -334,6 +352,31 @@ const makeGetTaskStatus = taskType => {
               spinnies.fail('overallTaskStatus', {
                 text: statusStrings.FAIL(taskName),
               });
+
+              const failedSubtask = subTaskStatus.filter(
+                subtask => subtask.status === 'FAILURE'
+              );
+
+              uiLine();
+              logger.log(
+                `${statusStrings.SUBTASK_FAIL(
+                  buildId || taskId,
+                  failedSubtask.length === 1
+                    ? failedSubtask[0][statusText.SUBTASK_NAME_KEY]
+                    : failedSubtask.length + ' components'
+                )}\n`
+              );
+              logger.log('See below for a summary of errors.');
+              uiLine();
+
+              failedSubtask.forEach(subTask => {
+                logger.log(
+                  `\n--- ${chalk.bold(subTask[statusText.SUBTASK_NAME_KEY])} ${
+                    statusText.STATUS_TEXT[subTask.status]
+                  } with the following error ---`
+                );
+                logger.error(subTask.errorMessage);
+              });
             }
 
             clearInterval(pollInterval);
@@ -348,6 +391,7 @@ const makeGetTaskStatus = taskType => {
 module.exports = {
   writeProjectConfig,
   getProjectConfig,
+  getIsInProject,
   createProjectConfig,
   validateProjectConfig,
   showWelcomeMessage,

package/lib/{createApiSamplePrompt.js → prompts/createApiSamplePrompt.js}

@@ -1,9 +1,12 @@
-const inquirer = require('inquirer');
+const { promptUser } = require('./promptUtils');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.lib.prompts.createApiSamplePrompt';
 
 const getSampleTypesPrompt = choices => ({
   type: 'rawlist',
   name: 'sampleType',
-  message: 'Please, select API sample app',
+  message: i18n(`${i18nKey}.selectApiSampleApp`),
   choices: choices.map(choice => ({
     name: `${choice.name} - ${choice.description}`,
     value: choice.id,
@@ -13,7 +16,7 @@ const getSampleTypesPrompt = choices => ({
       if (input.length > 0) {
         resolve(true);
       }
-      reject('Please select API sample app');
+      reject(i18n(`${i18nKey}.errors.apiSampleAppRequired`));
     });
   },
 });
@@ -21,7 +24,7 @@ const getSampleTypesPrompt = choices => ({
 const getLanguagesPrompt = choices => ({
   type: 'rawlist',
   name: 'sampleLanguage',
-  message: "Please, select sample app's language",
+  message: i18n(`${i18nKey}.selectLanguage`),
   choices: choices.map(choice => ({
     name: choice,
     value: choice,
@@ -31,7 +34,7 @@ const getLanguagesPrompt = choices => ({
       if (input.length > 0) {
         resolve(true);
       }
-      reject("Please select API sample app's language");
+      reject(i18n(`${i18nKey}.errors.languageRequired`));
     });
   },
 });
@@ -39,16 +42,12 @@ const getLanguagesPrompt = choices => ({
 const createApiSamplePrompt = async samplesConfig => {
   try {
     const { samples } = samplesConfig;
-    const sampleTypeAnswer = await inquirer.prompt(
-      getSampleTypesPrompt(samples)
-    );
+    const sampleTypeAnswer = await promptUser(getSampleTypesPrompt(samples));
     const chosenSample = samples.find(
       sample => sample.id === sampleTypeAnswer.sampleType
     );
     const { languages } = chosenSample;
-    const languagesAnswer = await inquirer.prompt(
-      getLanguagesPrompt(languages)
-    );
+    const languagesAnswer = await promptUser(getLanguagesPrompt(languages));
     return {
       ...sampleTypeAnswer,
       ...languagesAnswer,

package/lib/{createFunctionPrompt.js → prompts/createFunctionPrompt.js}

@@ -1,66 +1,72 @@
-const inquirer = require('inquirer');
+const { promptUser } = require('./promptUtils');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
-const { STRING_WITH_NO_SPACES_REGEX } = require('./regex');
+const { STRING_WITH_NO_SPACES_REGEX } = require('../regex');
+
+const i18nKey = 'cli.lib.prompts.createFunctionPrompt';
 
 const FUNCTIONS_FOLDER_PROMPT = {
   name: 'functionsFolder',
-  message: 'Name of the folder where your function will be created',
+  message: i18n(`${i18nKey}.enterFolder`),
   validate(val) {
     if (typeof val !== 'string') {
-      return 'You entered an invalid name. Please try again.';
+      return i18n(`${i18nKey}.errors.invalid`);
     } else if (!val.length) {
-      return 'The name may not be blank. Please try again.';
+      return i18n(`${i18nKey}.errors.blank`);
     } else if (!STRING_WITH_NO_SPACES_REGEX.test(val)) {
-      return 'The name may not contain spaces. Please try again.';
+      return i18n(`${i18nKey}.errors.space`);
     }
     return true;
   },
 };
-const ENDPOINT_PATH_PROMPT = {
-  name: 'endpointPath',
-  message: 'Path portion of the URL created for the function',
+
+const FUNCTION_FILENAME_PROMPT = {
+  name: 'filename',
+  message: i18n(`${i18nKey}.enterFilename`),
   validate(val) {
     if (typeof val !== 'string') {
-      return 'You entered an invalid name. Please try again.';
+      return i18n(`${i18nKey}.errors.invalid`);
     } else if (!val.length) {
-      return 'The name may not be blank. Please try again.';
+      return i18n(`${i18nKey}.errors.blank`);
     } else if (!STRING_WITH_NO_SPACES_REGEX.test(val)) {
-      return 'The name may not contain spaces. Please try again.';
+      return i18n(`${i18nKey}.errors.space`);
     }
     return true;
   },
 };
+
 const ENDPOINT_METHOD_PROMPT = {
   type: 'list',
   name: 'endpointMethod',
-  message: 'Select the HTTP method for the endpoint',
+  message: i18n(`${i18nKey}.selectEndpointMethod`),
   default: 'GET',
   choices: ['DELETE', 'GET', 'PATCH', 'POST', 'PUT'],
 };
-const FUNCTION_FILENAME_PROMPT = {
-  name: 'filename',
-  message: 'Name of the JavaScript file for your function',
+
+const ENDPOINT_PATH_PROMPT = {
+  name: 'endpointPath',
+  message: i18n(`${i18nKey}.enterEndpointPath`),
   validate(val) {
     if (typeof val !== 'string') {
-      return 'You entered an invalid name. Please try again.';
+      return i18n(`${i18nKey}.errors.invalid`);
     } else if (!val.length) {
-      return 'The name may not be blank. Please try again.';
+      return i18n(`${i18nKey}.errors.blank`);
     } else if (!STRING_WITH_NO_SPACES_REGEX.test(val)) {
-      return 'The name may not contain spaces. Please try again.';
+      return i18n(`${i18nKey}.errors.space`);
     }
     return true;
   },
 };
 
 function createFunctionPrompt() {
-  const prompt = inquirer.createPromptModule();
-  return prompt([
+  return promptUser([
     FUNCTIONS_FOLDER_PROMPT,
     FUNCTION_FILENAME_PROMPT,
     ENDPOINT_METHOD_PROMPT,
     ENDPOINT_PATH_PROMPT,
   ]);
 }
+
 module.exports = {
   createFunctionPrompt,
 };

package/lib/{createModulePrompt.js → prompts/createModulePrompt.js}

@@ -1,13 +1,16 @@
-const inquirer = require('inquirer');
+const { promptUser } = require('./promptUtils');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.lib.prompts.createModulePrompt';
 
 const MODULE_LABEL_PROMPT = {
   name: 'moduleLabel',
-  message: 'What should the module label be?',
+  message: i18n(`${i18nKey}.enterLabel`),
   validate(val) {
     if (typeof val !== 'string') {
-      return 'You entered an invalid name. Please try again.';
+      return i18n(`${i18nKey}.errors.invalidLabel`);
     } else if (!val.length) {
-      return 'The name may not be blank. Please try again.';
+      return i18n(`${i18nKey}.errors.labelRequired`);
     }
     return true;
   },
@@ -15,7 +18,7 @@ const MODULE_LABEL_PROMPT = {
 const CONTENT_TYPES_PROMPT = {
   type: 'checkbox',
   name: 'contentTypes',
-  message: 'What types of content will this module be used in?',
+  message: i18n(`${i18nKey}.selectContentType`),
   default: ['PAGE'],
   choices: [
     { name: 'Page', value: 'PAGE' },
@@ -28,7 +31,7 @@ const CONTENT_TYPES_PROMPT = {
       if (input.length > 0) {
         resolve(true);
       }
-      reject('Please select at least one content type for this module.');
+      reject(i18n(`${i18nKey}.errors.contentTypeRequired`));
     });
   },
 };
@@ -36,14 +39,14 @@ const CONTENT_TYPES_PROMPT = {
 const GLOBAL_PROMPT = {
   type: 'confirm',
   name: 'global',
-  message: 'Is this a global module?',
+  message: i18n(`${i18nKey}.confirmGlobal`),
   default: false,
 };
 
 function createModulePrompt() {
-  const prompt = inquirer.createPromptModule();
-  return prompt([MODULE_LABEL_PROMPT, CONTENT_TYPES_PROMPT, GLOBAL_PROMPT]);
+  return promptUser([MODULE_LABEL_PROMPT, CONTENT_TYPES_PROMPT, GLOBAL_PROMPT]);
 }
+
 module.exports = {
   createModulePrompt,
 };

package/lib/prompts/createProjectPrompt.js

@@ -0,0 +1,68 @@
+const path = require('path');
+const { getCwd } = require('@hubspot/cli-lib/path');
+const { PROJECT_TEMPLATES } = require('@hubspot/cli-lib/lib/constants');
+const { promptUser } = require('./promptUtils');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.lib.prompts.createProjectPrompt';
+
+const createProjectPrompt = (promptOptions = {}) => {
+  return promptUser([
+    {
+      name: 'name',
+      message: i18n(`${i18nKey}.enterName`),
+      when: !promptOptions.name,
+      validate: input => {
+        if (!input) {
+          return i18n(`${i18nKey}.errors.nameRequired`);
+        }
+        return true;
+      },
+    },
+    {
+      name: 'location',
+      message: i18n(`${i18nKey}.enterLocation`),
+      when: !promptOptions.location,
+      default: answers => {
+        return path.resolve(getCwd(), answers.name || promptOptions.name);
+      },
+      validate: input => {
+        if (!input) {
+          return i18n(`${i18nKey}.errors.locationRequired`);
+        }
+        return true;
+      },
+    },
+    {
+      name: 'template',
+      message: () => {
+        return promptOptions.template &&
+          !PROJECT_TEMPLATES.find(t => t.name === promptOptions.template)
+          ? i18n(`${i18nKey}.errors.invalidTemplate`, {
+              template: promptOptions.template,
+            })
+          : i18n(`${i18nKey}.selectTemplate`);
+      },
+      when:
+        !promptOptions.template ||
+        !PROJECT_TEMPLATES.find(t => t.name === promptOptions.template),
+      type: 'list',
+      choices: [
+        {
+          name: i18n(`${i18nKey}.templateOptions.noTemplate`),
+          value: 'none',
+        },
+        ...PROJECT_TEMPLATES.map(template => {
+          return {
+            name: template.label,
+            value: template.name,
+          };
+        }),
+      ],
+    },
+  ]);
+};
+
+module.exports = {
+  createProjectPrompt,
+};

package/lib/{createTemplatePrompt.js → prompts/createTemplatePrompt.js}

@@ -1,9 +1,12 @@
-const inquirer = require('inquirer');
+const { promptUser } = require('./promptUtils');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.lib.prompts.createTemplatePrompt';
 
 const TEMPLATE_TYPE_PROMPT = {
   type: 'list',
   name: 'templateType',
-  message: 'Select the type of template to create',
+  message: i18n(`${i18nKey}.selectTemplate`),
   default: 'page',
   choices: [
     { name: 'page', value: 'page-template' },
@@ -17,9 +20,9 @@ const TEMPLATE_TYPE_PROMPT = {
 };
 
 function createTemplatePrompt() {
-  const prompt = inquirer.createPromptModule();
-  return prompt([TEMPLATE_TYPE_PROMPT]);
+  return promptUser([TEMPLATE_TYPE_PROMPT]);
 }
+
 module.exports = {
   createTemplatePrompt,
 };

package/lib/prompts/folderOverwritePrompt.js

@@ -0,0 +1,17 @@
+const { promptUser } = require('./promptUtils');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.lib.prompts.folderOverwritePrompt';
+
+const folderOverwritePrompt = folderName => {
+  return promptUser({
+    type: 'confirm',
+    name: 'overwrite',
+    message: i18n(`${i18nKey}.overwriteConfirm`, { folderName }),
+    default: false,
+  });
+};
+
+module.exports = {
+  folderOverwritePrompt,
+};