Merge pull request #567 from HubSpot/project-create-command

Project create command

Author: anthmatic

packages/cli-lib/lib/constants.js

@@ -118,6 +118,10 @@ const PROJECT_TEMPLATE_TYPES = {
   },
 };
 
+const PROJECT_TEMPLATE_REPO = {
+  'getting-started': 'getting-started-project-template',
+};
+
 const TEMPLATE_TYPES = {
   unmapped: 0,
   email_base_template: 1,
@@ -239,6 +243,7 @@ module.exports = {
   PROJECT_BUILD_STATUS_TEXT,
   PROJECT_DEPLOY_STATUS,
   PROJECT_DEPLOY_STATUS_TEXT,
+  PROJECT_TEMPLATE_REPO,
   PROJECT_OVERALL_STATUS,
   PROJECT_TEMPLATE_TYPES,
   PROJECT_TEXT,

packages/cli/commands/project.js

@@ -4,7 +4,7 @@ const {
   addOverwriteOptions,
 } = require('../lib/commonOpts');
 const deploy = require('./project/deploy');
-const init = require('./project/init');
+const create = require('./project/create');
 const upload = require('./project/upload');
 const logs = require('./project/logs');
 
@@ -18,7 +18,7 @@ exports.builder = yargs => {
 
   // TODO: deploy must be updated
   yargs.command(deploy).demandCommand(1, '');
-  yargs.command(init).demandCommand(0, '');
+  yargs.command(create).demandCommand(0, '');
   yargs.command(upload).demandCommand(0, '');
   yargs.command(logs).demandCommand(1, '');
 

packages/cli/commands/project/init.js renamed to packages/cli/commands/project/create.js

@@ -12,17 +12,11 @@ const {
   validateConfig,
   checkAndWarnGitInclusion,
 } = require('@hubspot/cli-lib');
-const {
-  logApiErrorInstance,
-  ApiErrorContext,
-} = require('@hubspot/cli-lib/errorHandlers');
-const { logger } = require('@hubspot/cli-lib/logger');
-const { createProject } = require('@hubspot/cli-lib/api/dfs');
 const { validateAccount } = require('../../lib/validation');
 const { getCwd } = require('@hubspot/cli-lib/path');
 const path = require('path');
 const {
-  getOrCreateProjectConfig,
+  createProjectConfig,
   showWelcomeMessage,
 } = require('../../lib/projects');
 
@@ -38,40 +32,20 @@ const loadAndValidateOptions = async options => {
   }
 };
 
-exports.command = 'init [path]';
+exports.command = 'create [path]';
 exports.describe = false;
 
 exports.handler = async options => {
   loadAndValidateOptions(options);
 
-  const { path: projectPath } = options;
+  const { path: projectPath, name } = options;
   const accountId = getAccountId(options);
 
-  trackCommandUsage('project-init', { projectPath }, accountId);
+  trackCommandUsage('project-create', { projectPath }, accountId);
 
   const cwd = projectPath ? path.resolve(getCwd(), projectPath) : getCwd();
-  const projectConfig = await getOrCreateProjectConfig(cwd);
-
-  logger.log(`Initializing project: ${projectConfig.name}`);
-
-  try {
-    await createProject(accountId, projectConfig.name);
 
-    logger.success(
-      `"${projectConfig.name}" creation succeeded in account ${accountId}`
-    );
-  } catch (e) {
-    if (e.statusCode === 409) {
-      logger.log(
-        `Project ${projectConfig.name} already exists in ${accountId}.`
-      );
-    } else {
-      return logApiErrorInstance(
-        e,
-        new ApiErrorContext({ accountId, projectPath })
-      );
-    }
-  }
+  const projectConfig = await createProjectConfig(cwd, name);
 
   showWelcomeMessage(projectConfig.name, accountId);
 };
@@ -81,22 +55,17 @@ exports.builder = yargs => {
     describe: 'Path to a project folder',
     type: 'string',
   });
-  // TODO: These are not currently used
   yargs.options({
     name: {
       describe: 'Project name (cannot be changed)',
       type: 'string',
     },
-    srcDir: {
-      describe: 'Directory of project',
-      type: 'string',
-    },
   });
 
   yargs.example([
     [
-      '$0 project init myProjectFolder',
-      'Initialize a project within the myProjectFolder folder',
+      '$0 project create myProjectFolder',
+      'Create a project within the myProjectFolder folder',
     ],
   ]);
 

packages/cli/commands/project/deploy.js

@@ -21,10 +21,7 @@ const { logger } = require('@hubspot/cli-lib/logger');
 const { deployProject, fetchProject } = require('@hubspot/cli-lib/api/dfs');
 const { getCwd } = require('@hubspot/cli-lib/path');
 const { validateAccount } = require('../../lib/validation');
-const {
-  getOrCreateProjectConfig,
-  pollDeployStatus,
-} = require('../../lib/projects');
+const { getProjectConfig, pollDeployStatus } = require('../../lib/projects');
 
 const loadAndValidateOptions = async options => {
   setLogLevel(options);
@@ -50,7 +47,7 @@ exports.handler = async options => {
   trackCommandUsage('project-deploy', { projectPath }, accountId);
 
   const cwd = projectPath ? path.resolve(getCwd(), projectPath) : getCwd();
-  const projectConfig = await getOrCreateProjectConfig(cwd);
+  const projectConfig = await getProjectConfig(cwd);
 
   logger.debug(`Deploying project at path: ${projectPath}`);
 

packages/cli/lib/projects.js

@@ -1,4 +1,4 @@
-const fs = require('fs');
+const fs = require('fs-extra');
 const path = require('path');
 
 const chalk = require('chalk');
@@ -7,18 +7,19 @@ const { prompt } = require('inquirer');
 const Spinnies = require('spinnies');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { getEnv } = require('@hubspot/cli-lib/lib/config');
+const { createProject } = require('@hubspot/cli-lib/projects');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
 const {
   ENVIRONMENTS,
   POLLING_DELAY,
+  PROJECT_TEMPLATE_REPO,
   PROJECT_OVERALL_STATUS,
   PROJECT_TEXT,
 } = require('@hubspot/cli-lib/lib/constants');
 const {
   getBuildStatus,
   getDeployStatus,
   fetchProject,
-  createProject,
 } = require('@hubspot/cli-lib/api/dfs');
 const {
   logApiErrorInstance,
@@ -53,6 +54,7 @@ const isTaskComplete = task => {
 
 const writeProjectConfig = (configPath, config) => {
   try {
+    fs.ensureFileSync(configPath);
     fs.writeFileSync(configPath, JSON.stringify(config, null, 2));
     logger.debug(`Wrote project config at ${configPath}`);
   } catch (e) {
@@ -78,14 +80,25 @@ const getProjectConfig = async projectPath => {
   }
 };
 
-const getOrCreateProjectConfig = async projectPath => {
+const createProjectConfig = async (projectPath, projectName) => {
   const projectConfig = await getProjectConfig(projectPath);
+  const projectConfigPath = path.join(projectPath, 'hsproject.json');
 
-  if (!projectConfig) {
-    const { name, srcDir } = await prompt([
+  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'}`
+    );
+    const { name, template, srcDir } = await prompt([
       {
         name: 'name',
         message: 'Please enter a project name:',
+        when: !projectName,
         validate: input => {
           if (!input) {
             return 'A project name is required';
@@ -94,20 +107,43 @@ const getOrCreateProjectConfig = async projectPath => {
         },
       },
       {
-        name: 'srcDir',
-        message: 'Which directory contains your project files?',
-        validate: input => {
-          if (!input) {
-            return 'A source directory is required';
-          }
-          return true;
-        },
+        name: 'template',
+        message: 'Start from a template?',
+        type: 'rawlist',
+        choices: [
+          {
+            name: 'No template',
+            value: 'none',
+          },
+          {
+            name: 'Getting Started Project',
+            value: 'getting-started',
+          },
+        ],
       },
     ]);
-    writeProjectConfig(path.join(projectPath, 'hsproject.json'), {
-      name,
-      srcDir,
-    });
+
+    if (template === 'none') {
+      fs.ensureDirSync(path.join(projectPath, 'src'));
+
+      writeProjectConfig(projectConfigPath, {
+        name: projectName || name,
+        srcDir: 'src',
+      });
+    } else {
+      await createProject(
+        projectPath,
+        'project',
+        PROJECT_TEMPLATE_REPO[template],
+        ''
+      );
+      const _config = JSON.parse(fs.readFileSync(projectConfigPath));
+      writeProjectConfig(projectConfigPath, {
+        ..._config,
+        name: projectName || name,
+      });
+    }
+
     return { name, srcDir };
   }
 
@@ -178,31 +214,24 @@ const getProjectDetailUrl = (projectName, accountId) => {
   return `${baseUrl}/developer-projects/${accountId}/project/${projectName}`;
 };
 
-const showWelcomeMessage = (projectName, accountId) => {
-  const projectDetailUrl = getProjectDetailUrl(projectName, accountId);
-
+const showWelcomeMessage = () => {
   logger.log('');
-  logger.log(chalk.bold('> Welcome to HubSpot Developer Projects!'));
+  logger.log(chalk.bold('Welcome to HubSpot Developer Projects!'));
   logger.log(
     '\n-------------------------------------------------------------\n'
   );
-  if (projectDetailUrl) {
-    logger.log(chalk.italic(`View this project at: ${projectDetailUrl}`));
-  }
-  logger.log('');
-  logger.log(chalk.bold('Getting Started'));
-  logger.log('');
-  logger.log('1. hs project upload');
+  logger.log(chalk.bold("What's next?\n"));
+  logger.log('🎨 Add deployables to your project with `hs create`.\n');
   logger.log(
-    '   Upload your project files to HubSpot. Upload action adds your files to a build.'
+    `🏗  Run \`hs project upload\` to upload your files to HubSpot and trigger builds.\n`
   );
-  logger.log();
-  logger.log('2. View your changes on the preview build url');
-  logger.log();
-  logger.log('Use `hs project --help` to learn more about the command.');
   logger.log(
-    '\n-------------------------------------------------------------\n'
+    `🚀 Ready to take your project live? Run \`hs project deploy\`.\n`
+  );
+  logger.log(
+    `🔗 Use \`hs project --help\` to learn more about available commands.\n`
   );
+  logger.log('-------------------------------------------------------------');
 };
 
 const makeGetTaskStatus = taskType => {
@@ -311,9 +340,10 @@ const makeGetTaskStatus = taskType => {
 module.exports = {
   writeProjectConfig,
   getProjectConfig,
-  getOrCreateProjectConfig,
+  createProjectConfig,
   validateProjectConfig,
   showWelcomeMessage,
+  getProjectDetailUrl,
   pollBuildStatus: makeGetTaskStatus('build'),
   pollDeployStatus: makeGetTaskStatus('deploy'),
   ensureProjectExists,