hs open command

packages/cms-cli/bin/cli.js

@@ -22,6 +22,7 @@ const fetchCommand = require('../commands/fetch');
 const filemanagerCommand = require('../commands/filemanager');
 const secretsCommand = require('../commands/secrets');
 const customObjectCommand = require('../commands/customObject');
+const openCommand = require('../commands/open');
 
 const notifier = updateNotifier({ pkg });
 
@@ -63,6 +64,7 @@ const argv = yargs
   .command(filemanagerCommand)
   .command(secretsCommand)
   .command(customObjectCommand)
+  .command(openCommand)
   .help()
   .recommendCommands()
   .demandCommand(1, '')

packages/cms-cli/commands/open.js

@@ -0,0 +1,72 @@
+const {
+  addPortalOptions,
+  addConfigOptions,
+  getPortalId,
+  addUseEnvironmentOptions,
+} = require('../lib/commonOpts');
+const { trackCommandUsage } = require('../lib/usageTracking');
+const { logSiteLinks, getSiteLinksAsArray, openLink } = require('../lib/links');
+const inquirer = require('inquirer');
+
+const separator = ' => ';
+const createListPrompt = async portalId =>
+  inquirer.prompt([
+    {
+      type: 'rawlist',
+      look: false,
+      name: 'open',
+      pageSize: 20,
+      message: 'Select a link to open',
+      choices: getSiteLinksAsArray(portalId).map(
+        l => `${l.shortcut}${separator}${l.url}`
+      ),
+      filter: val => val.split(separator)[0],
+    },
+  ]);
+
+exports.command = 'open [shortcut]';
+exports.describe = 'Quickly open a page to HubSpot in your browser';
+
+exports.handler = async options => {
+  const { shortcut, list } = options;
+  const portalId = getPortalId(options);
+
+  trackCommandUsage('open', { shortcut }, portalId);
+
+  if (shortcut === undefined && !list) {
+    const choice = await createListPrompt(portalId);
+    openLink(portalId, choice.open);
+  } else if (list) {
+    logSiteLinks(portalId);
+    return;
+  } else {
+    openLink(portalId, shortcut);
+  }
+};
+
+exports.builder = yargs => {
+  yargs.positional('[shortcut]', {
+    describe: "Shortcut of the link you'd like to open",
+    type: 'string',
+  });
+
+  yargs.option('list', {
+    alias: 'l',
+    describe: 'List all supported shortcuts',
+    type: 'boolean',
+  });
+
+  yargs.example([
+    ['$0 open'],
+    ['$0 open --list'],
+    ['$0 open settings'],
+    ['$0 open settings/navigation'],
+    ['$0 open sn'],
+  ]);
+
+  addConfigOptions(yargs, true);
+  addPortalOptions(yargs, true);
+  addUseEnvironmentOptions(yargs, true);
+
+  return yargs;
+};

packages/cms-cli/lib/links.js

@@ -0,0 +1,130 @@
+const { getEnv } = require('@hubspot/cms-lib/lib/config');
+const { ENVIRONMENTS } = require('@hubspot/cms-lib/lib/constants');
+const { getHubSpotWebsiteOrigin } = require('@hubspot/cms-lib/lib/urls');
+const { logger } = require('@hubspot/cms-lib/logger');
+const chalk = require('chalk');
+const { table, getBorderCharacters } = require('table');
+const open = require('open');
+
+const logSiteLinks = portalId => {
+  const linksAsArray = getSiteLinksAsArray(portalId).map(l => [
+    `${l.shortcut}${l.alias ? ` [alias: ${l.alias}]` : ''}`,
+    '=>',
+    l.url,
+  ]);
+
+  linksAsArray.unshift([chalk.bold('Shortcut'), '', chalk.bold('Url')]);
+
+  const tableConfig = {
+    singleLine: true,
+    border: getBorderCharacters(`void`),
+  };
+
+  logger.log(table(linksAsArray, tableConfig));
+};
+
+const getSiteLinksAsArray = portalId =>
+  Object.values(getSiteLinks(portalId)).sort((a, b) =>
+    a.shortcut < b.shortcut ? -1 : 1
+  );
+
+const getSiteLinks = portalId => {
+  const baseUrl = getHubSpotWebsiteOrigin(
+    getEnv() === 'qa' ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD
+  );
+
+  return {
+    APPS_MARKETPLACE: {
+      shortcut: 'apps-marketplace',
+      alias: 'apm',
+      url: `${baseUrl}/ecosystem/${portalId}/marketplace/apps`,
+    },
+    ASSET_MARKETPLACE: {
+      shortcut: 'asset-marketplace',
+      alias: 'asm',
+      url: `${baseUrl}/ecosystem/${portalId}/marketplace/products`,
+    },
+    CONTENT_STAGING: {
+      shortcut: 'content-staging',
+      alias: 'cs',
+      url: `${baseUrl}/content/${portalId}/staging`,
+    },
+    DESIGN_MANAGER: {
+      shortcut: 'design-manager',
+      alias: 'dm',
+      url: `${baseUrl}/design-manager/${portalId}`,
+    },
+    DOCS: {
+      shortcut: 'docs',
+      url: 'https://developers.hubspot.com',
+    },
+    FILE_MANAGER: {
+      shortcut: 'file-manager',
+      alias: 'fm',
+      url: `${baseUrl}/files/${portalId}`,
+    },
+    FORUMS: {
+      shortcut: 'forums',
+      url: 'https://community.hubspot.com',
+    },
+    HUBDB: {
+      shortcut: 'hubdb',
+      alias: 'hdb',
+      url: `${baseUrl}/hubdb/${portalId}`,
+    },
+    SETTINGS: {
+      shortcut: 'settings',
+      alias: 's',
+      url: `${baseUrl}/settings/${portalId}`,
+    },
+    SETTINGS_NAVIGATION: {
+      shortcut: 'settings/navigation',
+      alias: 'sn',
+      url: `${baseUrl}/menus/${portalId}/edit/`,
+    },
+    SETTINGS_PAGE: {
+      shortcut: 'settings/page',
+      alias: 'sp',
+      url: `${baseUrl}/settings/${portalId}/website/pages/all-domains/page-templates`,
+    },
+    SETTINGS_URL_REDIRECTS: {
+      shortcut: 'settings/url-redirects',
+      alias: 'sur',
+      url: `${baseUrl}/domains/${portalId}/url-redirects`,
+    },
+    PURCHASED_ASSETS: {
+      shortcut: 'purchased-assets',
+      alias: 'pa',
+      url: `${baseUrl}/marketplace/${portalId}/manage-purchases`,
+    },
+
+    WEBSITE_PAGES: {
+      shortcut: 'website-pages',
+      alias: 'wp',
+      url: `${baseUrl}/website/${portalId}/pages/site`,
+    },
+  };
+};
+
+const openLink = (portalId, shortcut) => {
+  const match = Object.values(getSiteLinks(portalId)).find(
+    l => l.shortcut === shortcut || (l.alias && l.alias === shortcut)
+  );
+
+  if (!match) {
+    logger.error(
+      `We couldn't find a shortcut matching ${shortcut}.  Type 'hs open list' to see a list of available shortcuts`
+    );
+    return;
+  }
+
+  open(match.url, { url: true });
+  logger.success(`We opened ${match.url} in your browser`);
+};
+
+module.exports = {
+  getSiteLinks,
+  getSiteLinksAsArray,
+  logSiteLinks,
+  openLink,
+};

yarn.lock

@@ -5478,12 +5478,7 @@ lodash.uniq@^4.5.0:
   resolved "https://registry.yarnpkg.com/lodash.uniq/-/lodash.uniq-4.5.0.tgz#d0225373aeb652adc1bc82e4945339a842754773"
   integrity sha1-0CJTc662Uq3BvILklFM5qEJ1R3M=
 
-lodash@^4.17.11, lodash@^4.17.12, lodash@^4.17.14, lodash@^4.17.15, lodash@^4.17.19, lodash@^4.2.1:
-  version "4.17.20"
-  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.20.tgz#b44a9b6297bcb698f1c51a3545a2b3b368d59c52"
-  integrity sha512-PlhdFcillOINfeV7Ni6oF1TAEayyZBoZ8bcshTHqOYJYlrqzRK5hagpagky5o4HfCzzd1TRkXPMFq6cKk9rGmA==
-
-lodash@^4.17.20:
+lodash@^4.17.11, lodash@^4.17.12, lodash@^4.17.14, lodash@^4.17.15, lodash@^4.17.19, lodash@^4.17.20, lodash@^4.2.1:
   version "4.17.20"
   resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.20.tgz#b44a9b6297bcb698f1c51a3545a2b3b368d59c52"
   integrity sha512-PlhdFcillOINfeV7Ni6oF1TAEayyZBoZ8bcshTHqOYJYlrqzRK5hagpagky5o4HfCzzd1TRkXPMFq6cKk9rGmA==