@hubspot/cli 7.2.0-beta.0 → 7.2.0

package/commands/list.js

@@ -1,37 +1,68 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-// @ts-nocheck
-const chalk = require('chalk');
-const { addAccountOptions, addConfigOptions, addGlobalOptions, addUseEnvironmentOptions, } = require('../lib/commonOpts');
-const { trackCommandUsage } = require('../lib/usageTracking');
-const { isPathFolder } = require('../lib/filesystem');
-const { logger } = require('@hubspot/local-dev-lib/logger');
-const { logError } = require('../lib/errorHandlers/index');
-const { getDirectoryContentsByPath, } = require('@hubspot/local-dev-lib/api/fileMapper');
-const { HUBSPOT_FOLDER, MARKETPLACE_FOLDER } = require('../lib/constants');
-const { i18n } = require('../lib/lang');
+exports.describe = exports.command = void 0;
+exports.handler = handler;
+exports.builder = builder;
+const chalk_1 = __importDefault(require("chalk"));
+const commonOpts_1 = require("../lib/commonOpts");
+const usageTracking_1 = require("../lib/usageTracking");
+const filesystem_1 = require("../lib/filesystem");
+const logger_1 = require("@hubspot/local-dev-lib/logger");
+const index_1 = require("../lib/errorHandlers/index");
+const fileMapper_1 = require("@hubspot/local-dev-lib/api/fileMapper");
+const constants_1 = require("../lib/constants");
+const lang_1 = require("../lib/lang");
+const exitCodes_1 = require("../lib/enums/exitCodes");
 const i18nKey = 'commands.list';
-const { EXIT_CODES } = require('../lib/enums/exitCodes');
+function addColorToContents(fileOrFolder) {
+    if (!(0, filesystem_1.isPathFolder)(fileOrFolder)) {
+        return chalk_1.default.reset.cyan(fileOrFolder);
+    }
+    if (fileOrFolder === constants_1.HUBSPOT_FOLDER || fileOrFolder === constants_1.MARKETPLACE_FOLDER) {
+        return chalk_1.default.reset.bold.blue(fileOrFolder);
+    }
+    return chalk_1.default.reset.blue(fileOrFolder);
+}
+function sortContents(a, b) {
+    // Pin @hubspot folder to top
+    if (a === constants_1.HUBSPOT_FOLDER) {
+        return -1;
+    }
+    else if (b === constants_1.HUBSPOT_FOLDER) {
+        return 1;
+    }
+    // Pin @marketplace folder to top
+    if (a === constants_1.MARKETPLACE_FOLDER) {
+        return -1;
+    }
+    else if (b === constants_1.MARKETPLACE_FOLDER) {
+        return 1;
+    }
+    return a.localeCompare(b);
+}
 exports.command = 'list [path]';
-exports.describe = i18n(`${i18nKey}.describe`);
-exports.handler = async (options) => {
-    const { path, derivedAccountId } = options;
+exports.describe = (0, lang_1.i18n)(`${i18nKey}.describe`);
+async function handler(args) {
+    const { path, derivedAccountId } = args;
     const directoryPath = path || '/';
     let contentsResp;
-    trackCommandUsage('list', null, derivedAccountId);
-    logger.debug(i18n(`${i18nKey}.gettingPathContents`, {
+    (0, usageTracking_1.trackCommandUsage)('list', undefined, derivedAccountId);
+    logger_1.logger.debug((0, lang_1.i18n)(`${i18nKey}.gettingPathContents`, {
         path: directoryPath,
     }));
     try {
-        const { data } = await getDirectoryContentsByPath(derivedAccountId, directoryPath);
+        const { data } = await (0, fileMapper_1.getDirectoryContentsByPath)(derivedAccountId, directoryPath);
         contentsResp = data;
     }
     catch (e) {
-        logError(e);
-        process.exit(EXIT_CODES.SUCCESS);
+        (0, index_1.logError)(e);
+        process.exit(exitCodes_1.EXIT_CODES.ERROR);
     }
     if (!contentsResp.folder) {
-        logger.info(i18n(`${i18nKey}.noFilesFoundAtPath`, {
+        logger_1.logger.info((0, lang_1.i18n)(`${i18nKey}.noFilesFoundAtPath`, {
             path: directoryPath,
         }));
         return;
@@ -41,7 +72,7 @@ exports.handler = async (options) => {
         ? ['@hubspot', ...contentsResp.children]
         : contentsResp.children;
     if (contents.length === 0) {
-        logger.info(i18n(`${i18nKey}.noFilesFoundAtPath`, {
+        logger_1.logger.info((0, lang_1.i18n)(`${i18nKey}.noFilesFoundAtPath`, {
             path: directoryPath,
         }));
         return;
@@ -50,43 +81,18 @@ exports.handler = async (options) => {
         .map(addColorToContents)
         .sort(sortContents)
         .join('\n');
-    logger.log(folderContentsOutput);
-};
-exports.builder = yargs => {
+    logger_1.logger.log(folderContentsOutput);
+    process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
+}
+function builder(yargs) {
+    (0, commonOpts_1.addConfigOptions)(yargs);
+    (0, commonOpts_1.addAccountOptions)(yargs);
+    (0, commonOpts_1.addUseEnvironmentOptions)(yargs);
+    (0, commonOpts_1.addGlobalOptions)(yargs);
     yargs.positional('path', {
-        describe: i18n(`${i18nKey}.positionals.path.describe`),
+        describe: (0, lang_1.i18n)(`${i18nKey}.positionals.path.describe`),
         type: 'string',
     });
-    yargs.example([['$0 list'], ['$0 list /'], ['$0 list serverless']]);
-    addConfigOptions(yargs);
-    addAccountOptions(yargs);
-    addUseEnvironmentOptions(yargs);
-    addGlobalOptions(yargs);
+    yargs.example([['$0 list'], ['$0 list /'], ['$0 list my-modules']]);
     return yargs;
-};
-const addColorToContents = fileOrFolder => {
-    if (!isPathFolder(fileOrFolder)) {
-        return chalk.reset.cyan(fileOrFolder);
-    }
-    if (fileOrFolder === HUBSPOT_FOLDER || fileOrFolder === MARKETPLACE_FOLDER) {
-        return chalk.reset.bold.blue(fileOrFolder);
-    }
-    return chalk.reset.blue(fileOrFolder);
-};
-const sortContents = (a, b) => {
-    // Pin @hubspot folder to top
-    if (a === HUBSPOT_FOLDER) {
-        return -1;
-    }
-    else if (b === HUBSPOT_FOLDER) {
-        return 1;
-    }
-    // Pin @marketplace folder to top
-    if (a === MARKETPLACE_FOLDER) {
-        return -1;
-    }
-    else if (b === MARKETPLACE_FOLDER) {
-        return 1;
-    }
-    return a.localeCompare(b);
-};
+}

package/commands/mv.d.ts

@@ -1 +1,11 @@
+import { Argv, ArgumentsCamelCase } from 'yargs';
+import { CommonArgs, ConfigArgs, EnvironmentArgs } from '../types/Yargs';
+export declare const command = "mv <srcPath> <destPath>";
+export declare const describe: string | undefined;
+type MvArgs = CommonArgs & ConfigArgs & EnvironmentArgs & {
+    srcPath: string;
+    destPath: string;
+};
+export declare function handler(args: ArgumentsCamelCase<MvArgs>): Promise<void>;
+export declare function builder(yargs: Argv): Argv<MvArgs>;
 export {};

package/commands/mv.js

@@ -1,58 +1,62 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// @ts-nocheck
-const { logger } = require('@hubspot/local-dev-lib/logger');
-const { moveFile } = require('@hubspot/local-dev-lib/api/fileMapper');
-const { isSpecifiedError } = require('@hubspot/local-dev-lib/errors/index');
-const { logError, ApiErrorContext } = require('../lib/errorHandlers/index');
-const { addConfigOptions, addAccountOptions, addUseEnvironmentOptions, addGlobalOptions, } = require('../lib/commonOpts');
-const { trackCommandUsage } = require('../lib/usageTracking');
-const { isPathFolder } = require('../lib/filesystem');
-const { i18n } = require('../lib/lang');
-const { uiBetaTag } = require('../lib/ui');
+exports.describe = exports.command = void 0;
+exports.handler = handler;
+exports.builder = builder;
+const logger_1 = require("@hubspot/local-dev-lib/logger");
+const fileMapper_1 = require("@hubspot/local-dev-lib/api/fileMapper");
+const index_1 = require("@hubspot/local-dev-lib/errors/index");
+const index_2 = require("../lib/errorHandlers/index");
+const commonOpts_1 = require("../lib/commonOpts");
+const usageTracking_1 = require("../lib/usageTracking");
+const filesystem_1 = require("../lib/filesystem");
+const lang_1 = require("../lib/lang");
+const ui_1 = require("../lib/ui");
 const i18nKey = 'commands.mv';
-const getCorrectedDestPath = (srcPath, destPath) => {
-    if (!isPathFolder(srcPath)) {
+function getCorrectedDestPath(srcPath, destPath) {
+    if (!(0, filesystem_1.isPathFolder)(srcPath)) {
         return destPath;
     }
     // Makes sure that nested folders are moved independently
     return `${destPath}/${srcPath.split('/').pop()}`;
-};
+}
 exports.command = 'mv <srcPath> <destPath>';
-exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
-exports.handler = async (options) => {
-    const { srcPath, destPath, derivedAccountId } = options;
-    trackCommandUsage('mv', null, derivedAccountId);
+exports.describe = (0, ui_1.uiBetaTag)((0, lang_1.i18n)(`${i18nKey}.describe`), false);
+async function handler(args) {
+    const { srcPath, destPath, derivedAccountId } = args;
+    (0, usageTracking_1.trackCommandUsage)('mv', undefined, derivedAccountId);
     try {
-        await moveFile(derivedAccountId, srcPath, getCorrectedDestPath(srcPath, destPath));
-        logger.success(i18n(`${i18nKey}.move`, {
+        await (0, fileMapper_1.moveFile)(derivedAccountId, srcPath, getCorrectedDestPath(srcPath, destPath));
+        logger_1.logger.success((0, lang_1.i18n)(`${i18nKey}.move`, {
             accountId: derivedAccountId,
             destPath,
             srcPath,
         }));
     }
     catch (error) {
-        logger.error(i18n(`${i18nKey}.errors.moveFailed`, {
+        logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.errors.moveFailed`, {
             accountId: derivedAccountId,
             destPath,
             srcPath,
         }));
-        if (isSpecifiedError(error, { statusCode: 409 })) {
-            logger.error(i18n(`${i18nKey}.errors.sourcePathExists`, {
+        if ((0, index_1.isSpecifiedError)(error, { statusCode: 409 })) {
+            logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.errors.sourcePathExists`, {
                 destPath,
                 srcPath,
             }));
         }
         else {
-            logError(error, new ApiErrorContext({
+            (0, index_2.logError)(error, new index_2.ApiErrorContext({
                 accountId: derivedAccountId,
-                srcPath,
-                destPath,
             }));
         }
     }
-};
-exports.builder = yargs => {
+}
+function builder(yargs) {
+    (0, commonOpts_1.addConfigOptions)(yargs);
+    (0, commonOpts_1.addAccountOptions)(yargs);
+    (0, commonOpts_1.addUseEnvironmentOptions)(yargs);
+    (0, commonOpts_1.addGlobalOptions)(yargs);
     yargs.positional('srcPath', {
         describe: 'Remote hubspot path',
         type: 'string',
@@ -61,9 +65,5 @@ exports.builder = yargs => {
         describe: 'Remote hubspot path',
         type: 'string',
     });
-    addConfigOptions(yargs);
-    addAccountOptions(yargs);
-    addUseEnvironmentOptions(yargs);
-    addGlobalOptions(yargs);
     return yargs;
-};
+}

package/commands/open.d.ts

@@ -1 +1,11 @@
+import { Argv, ArgumentsCamelCase } from 'yargs';
+import { CommonArgs, ConfigArgs, EnvironmentArgs, AccountArgs } from '../types/Yargs';
+export declare const command = "open [shortcut]";
+export declare const describe: string;
+type OpenArgs = CommonArgs & ConfigArgs & EnvironmentArgs & AccountArgs & {
+    shortcut?: string;
+    list?: boolean;
+};
+export declare function handler(args: ArgumentsCamelCase<OpenArgs>): Promise<void>;
+export declare function builder(yargs: Argv): Argv<OpenArgs>;
 export {};

package/commands/open.js

@@ -1,50 +1,57 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// @ts-nocheck
+exports.describe = exports.command = void 0;
+exports.handler = handler;
+exports.builder = builder;
+const commonOpts_1 = require("../lib/commonOpts");
+const usageTracking_1 = require("../lib/usageTracking");
+const links_1 = require("../lib/links");
+const promptUtils_1 = require("../lib/prompts/promptUtils");
+const lang_1 = require("../lib/lang");
 const exitCodes_1 = require("../lib/enums/exitCodes");
-const { addAccountOptions, addConfigOptions, addUseEnvironmentOptions, addGlobalOptions, } = require('../lib/commonOpts');
-const { trackCommandUsage } = require('../lib/usageTracking');
-const { logSiteLinks, getSiteLinksAsArray, openLink } = require('../lib/links');
-const { promptUser } = require('../lib/prompts/promptUtils');
-const { i18n } = require('../lib/lang');
 const i18nKey = 'commands.open';
 const separator = ' => ';
-const createListPrompt = async (accountId) => promptUser([
-    {
-        type: 'rawlist',
-        look: false,
-        name: 'open',
-        pageSize: 20,
-        message: i18n(`${i18nKey}.selectLink`),
-        choices: getSiteLinksAsArray(accountId).map(l => `${l.shortcut}${separator}${l.url}`),
-        filter: val => val.split(separator)[0],
-    },
-]);
+async function createListPrompt(accountId) {
+    return (0, promptUtils_1.promptUser)([
+        {
+            type: 'rawlist',
+            name: 'open',
+            pageSize: 20,
+            message: (0, lang_1.i18n)(`${i18nKey}.selectLink`),
+            choices: (0, links_1.getSiteLinksAsArray)(accountId).map(l => `${l.shortcut}${separator}${l.url}`),
+            filter: val => val.split(separator)[0],
+        },
+    ]);
+}
 exports.command = 'open [shortcut]';
-exports.describe = i18n(`${i18nKey}.describe`);
-exports.handler = async (options) => {
-    const { shortcut, list, derivedAccountId } = options;
-    trackCommandUsage('open', null, derivedAccountId);
+exports.describe = (0, lang_1.i18n)(`${i18nKey}.describe`);
+async function handler(args) {
+    const { shortcut, list, derivedAccountId } = args;
+    (0, usageTracking_1.trackCommandUsage)('open', undefined, derivedAccountId);
     if (shortcut === undefined && !list) {
         const choice = await createListPrompt(derivedAccountId);
-        openLink(derivedAccountId, choice.open);
+        (0, links_1.openLink)(derivedAccountId, choice.open);
     }
     else if (list) {
-        logSiteLinks(derivedAccountId);
+        (0, links_1.logSiteLinks)(derivedAccountId);
     }
-    else {
-        openLink(derivedAccountId, shortcut);
+    else if (shortcut) {
+        (0, links_1.openLink)(derivedAccountId, shortcut);
     }
     process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
-};
-exports.builder = yargs => {
+}
+function builder(yargs) {
+    (0, commonOpts_1.addConfigOptions)(yargs);
+    (0, commonOpts_1.addAccountOptions)(yargs);
+    (0, commonOpts_1.addUseEnvironmentOptions)(yargs);
+    (0, commonOpts_1.addGlobalOptions)(yargs);
     yargs.positional('[shortcut]', {
-        describe: i18n(`${i18nKey}.positionals.shortcut.describe`),
+        describe: (0, lang_1.i18n)(`${i18nKey}.positionals.shortcut.describe`),
         type: 'string',
     });
     yargs.option('list', {
         alias: 'l',
-        describe: i18n(`${i18nKey}.options.list.describe`),
+        describe: (0, lang_1.i18n)(`${i18nKey}.options.list.describe`),
         type: 'boolean',
     });
     yargs.example([
@@ -54,9 +61,5 @@ exports.builder = yargs => {
         ['$0 open settings/navigation'],
         ['$0 open sn'],
     ]);
-    addConfigOptions(yargs);
-    addAccountOptions(yargs);
-    addUseEnvironmentOptions(yargs);
-    addGlobalOptions(yargs);
     return yargs;
-};
+}

package/commands/remove.d.ts

@@ -1 +1,10 @@
+import { Argv, ArgumentsCamelCase } from 'yargs';
+import { AccountArgs, CommonArgs, ConfigArgs, EnvironmentArgs } from '../types/Yargs';
+export declare const command = "remove <path>";
+export declare const describe: string;
+type RemoveArgs = CommonArgs & ConfigArgs & EnvironmentArgs & AccountArgs & {
+    path: string;
+};
+export declare function handler(args: ArgumentsCamelCase<RemoveArgs>): Promise<void>;
+export declare function builder(yargs: Argv): Argv<RemoveArgs>;
 export {};

package/commands/remove.js

@@ -1,41 +1,43 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// @ts-nocheck
-const { deleteFile } = require('@hubspot/local-dev-lib/api/fileMapper');
-const { logger } = require('@hubspot/local-dev-lib/logger');
-const { logError, ApiErrorContext } = require('../lib/errorHandlers/index');
-const { addConfigOptions, addAccountOptions, addUseEnvironmentOptions, addGlobalOptions, } = require('../lib/commonOpts');
-const { trackCommandUsage } = require('../lib/usageTracking');
-const { i18n } = require('../lib/lang');
+exports.describe = exports.command = void 0;
+exports.handler = handler;
+exports.builder = builder;
+const fileMapper_1 = require("@hubspot/local-dev-lib/api/fileMapper");
+const logger_1 = require("@hubspot/local-dev-lib/logger");
+const index_1 = require("../lib/errorHandlers/index");
+const commonOpts_1 = require("../lib/commonOpts");
+const usageTracking_1 = require("../lib/usageTracking");
+const lang_1 = require("../lib/lang");
 const i18nKey = 'commands.remove';
 exports.command = 'remove <path>';
-exports.describe = i18n(`${i18nKey}.describe`);
-exports.handler = async (options) => {
-    const { path: hsPath, derivedAccountId } = options;
-    trackCommandUsage('remove', null, derivedAccountId);
+exports.describe = (0, lang_1.i18n)(`${i18nKey}.describe`);
+async function handler(args) {
+    const { path: hsPath, derivedAccountId } = args;
+    (0, usageTracking_1.trackCommandUsage)('remove', undefined, derivedAccountId);
     try {
-        await deleteFile(derivedAccountId, hsPath);
-        logger.log(i18n(`${i18nKey}.deleted`, { accountId: derivedAccountId, path: hsPath }));
+        await (0, fileMapper_1.deleteFile)(derivedAccountId, hsPath);
+        logger_1.logger.log((0, lang_1.i18n)(`${i18nKey}.deleted`, { accountId: derivedAccountId, path: hsPath }));
     }
     catch (error) {
-        logger.error(i18n(`${i18nKey}.errors.deleteFailed`, {
+        logger_1.logger.error((0, lang_1.i18n)(`${i18nKey}.errors.deleteFailed`, {
             accountId: derivedAccountId,
             path: hsPath,
         }));
-        logError(error, new ApiErrorContext({
+        (0, index_1.logError)(error, new index_1.ApiErrorContext({
             accountId: derivedAccountId,
             request: hsPath,
         }));
     }
-};
-exports.builder = yargs => {
+}
+function builder(yargs) {
+    (0, commonOpts_1.addConfigOptions)(yargs);
+    (0, commonOpts_1.addAccountOptions)(yargs);
+    (0, commonOpts_1.addUseEnvironmentOptions)(yargs);
+    (0, commonOpts_1.addGlobalOptions)(yargs);
     yargs.positional('path', {
-        describe: i18n(`${i18nKey}.positionals.path.describe`),
+        describe: (0, lang_1.i18n)(`${i18nKey}.positionals.path.describe`),
         type: 'string',
     });
-    addConfigOptions(yargs);
-    addAccountOptions(yargs);
-    addUseEnvironmentOptions(yargs);
-    addGlobalOptions(yargs);
     return yargs;
-};
+}

package/lang/en.lyaml

@@ -72,6 +72,9 @@ en:
           describe: "Print information about the default account, or about the account specified with the \"account\" option."
           errors:
             notUsingPersonalAccessKey: "This command currently only supports fetching scopes for the personal access key auth type."
+          options:
+            account:
+              describe: "Account name or id to show info for"
           examples:
             default: "Print information for the default account"
             idBased: "Print information for the account with accountId equal to \"1234567\""
@@ -91,14 +94,14 @@ en:
             other: "Remove {{ count }} inactive accounts from the CLI config?"
           removeSuccess: "Removed {{ accountName }} from the CLI config."
     auth:
-      describe: "Configure authentication for your HubSpot account. This will update the {{ configName }} file that stores your account information."
+      describe: "Configure authentication for your HubSpot account."
+      verboseDescribe: "Configure authentication for a HubSpot account. This will update the {{ configName }} file that stores your account information.\n\nThe recommended authentication method is {{#bold}}{{ authMethod }}{{/bold}}, which uses an access token tied to a specific user account."
       errors:
         noConfigFileFound: "No config file was found. To create a new config file, use the \"hs init\" command."
         unsupportedAuthType: "Unsupported auth type: {{ type }}. The only supported authentication protocols are {{ supportedProtocols }}."
       options:
         authType:
-          describe: "Authentication mechanism"
-          defaultDescription: "\"{{ authMethod }}\": An access token tied to a specific user account. This is the recommended way of authenticating with local development tools."
+          describe: "Authentication method"
         account:
           describe: "HubSpot account to authenticate"
       success:
@@ -446,11 +449,11 @@ en:
           success:
             fetch: "Downloaded HubDB table {{ tableId }} to {{ path }}"
     init:
-      describe: "Configure authentication for your HubSpot account. This will create a {{ configName }} file to store your account information."
+      describe: "Create a CLI config file and configure authentication for your HubSpot account."
+      verboseDescribe: "Configure authentication for a HubSpot account. This will create a {{ configName }} file to store your account information. To configure authentication for additional accounts, run {{ command }}.\n\nThe recommended authentication method is {{#bold}}{{ authMethod }}{{/bold}}, which uses an access token tied to a specific user account."
       options:
         authType:
-          describe: "Authentication mechanism"
-          defaultDescription: "\"{{ authMethod }}\":  An access token tied to a specific user account. This is the recommended way of authenticating with local development tools."
+          describe: "Authentication method"
         account:
           describe: "HubSpot account to authenticate"
         useHiddenConfig:

package/lib/commonOpts.d.ts

@@ -13,6 +13,7 @@ export declare function addCmsPublishModeOptions(yargs: Argv, { read, write }: {
 }): Argv;
 export declare function addTestingOptions(yargs: Argv): Argv;
 export declare function addUseEnvironmentOptions(yargs: Argv): Argv;
+export declare function addCustomHelpOutput(yargs: Argv, command: string, describe: string): Promise<void>;
 export declare function setLogLevel(options: Arguments<{
     debug?: boolean;
 }>): void;

package/lib/commonOpts.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addGlobalOptions = addGlobalOptions;
 exports.addAccountOptions = addAccountOptions;
@@ -7,13 +10,19 @@ exports.addOverwriteOptions = addOverwriteOptions;
 exports.addCmsPublishModeOptions = addCmsPublishModeOptions;
 exports.addTestingOptions = addTestingOptions;
 exports.addUseEnvironmentOptions = addUseEnvironmentOptions;
+exports.addCustomHelpOutput = addCustomHelpOutput;
 exports.setLogLevel = setLogLevel;
 exports.getCommandName = getCommandName;
 exports.getCmsPublishMode = getCmsPublishMode;
+const chalk_1 = __importDefault(require("chalk"));
+const yargs_parser_1 = __importDefault(require("yargs-parser"));
 const logger_1 = require("@hubspot/local-dev-lib/logger");
 const files_1 = require("@hubspot/local-dev-lib/constants/files");
 const config_1 = require("@hubspot/local-dev-lib/config");
 const lang_1 = require("./lang");
+const errorHandlers_1 = require("./errorHandlers");
+const exitCodes_1 = require("./enums/exitCodes");
+const ui_1 = require("./ui");
 const i18nKey = 'lib.commonOpts';
 function addGlobalOptions(yargs) {
     yargs.version(false);
@@ -70,6 +79,27 @@ function addUseEnvironmentOptions(yargs) {
     })
         .conflicts('use-env', 'account');
 }
+async function addCustomHelpOutput(yargs, command, describe) {
+    try {
+        const parsedArgv = (0, yargs_parser_1.default)(process.argv.slice(2));
+        if (parsedArgv && parsedArgv.help) {
+            // Construct the full command, including positional arguments
+            const commandBase = `hs ${parsedArgv._.slice(0, -1).join(' ')}`;
+            const fullCommand = `${commandBase.trim()} ${command}`;
+            // Format the original help output to be more readable
+            let commandHelp = await yargs.getHelp();
+            ['Options:', 'Examples:', 'Positionals:'].forEach(header => {
+                commandHelp = commandHelp.replace(header, chalk_1.default.bold(header));
+            });
+            logger_1.logger.log(`${(0, ui_1.uiCommandReference)(fullCommand, false)}\n\n${describe}\n\n${commandHelp}`);
+            process.exit(exitCodes_1.EXIT_CODES.SUCCESS);
+        }
+    }
+    catch (e) {
+        // Ignore error to allow yargs to show the default help output using the command description
+        (0, errorHandlers_1.debugError)(e);
+    }
+}
 function setLogLevel(options) {
     const { debug } = options;
     if (debug) {

package/lib/prompts/accountNamePrompt.d.ts

@@ -1,12 +1,11 @@
 import { PromptConfig } from '../../types/Prompts';
 import { AccountType } from '@hubspot/local-dev-lib/types/Accounts';
-type AccountNamePromptResponse = {
+export type AccountNamePromptResponse = {
     name: string;
 };
 export declare function getCliAccountNamePromptConfig(defaultName?: string): PromptConfig<AccountNamePromptResponse>;
-export declare function cliAccountNamePrompt(defaultName: string): Promise<AccountNamePromptResponse>;
+export declare function cliAccountNamePrompt(defaultName?: string): Promise<AccountNamePromptResponse>;
 export declare function hubspotAccountNamePrompt({ accountType, currentPortalCount, }: {
     accountType: AccountType;
     currentPortalCount?: number;
 }): Promise<AccountNamePromptResponse>;
-export {};

package/lib/prompts/personalAccessKeyPrompt.d.ts

@@ -1,5 +1,6 @@
+import { AccountNamePromptResponse } from './accountNamePrompt';
 import { PromptConfig } from '../../types/Prompts';
-type PersonalAccessKeyPromptResponse = {
+export type PersonalAccessKeyPromptResponse = {
     personalAccessKey: string;
     env: string;
 };
@@ -15,6 +16,7 @@ type ClientSecretPromptResponse = {
 type ScopesPromptResponse = {
     scopes: string[];
 };
+export type OauthPromptResponse = AccountNamePromptResponse & AccountIdPromptResponse & ClientIdPromptResponse & ClientSecretPromptResponse & ScopesPromptResponse;
 /**
  * Displays notification to user that we are about to open the browser,
  * then opens their browser to the personal-access-key shortlink
@@ -23,7 +25,5 @@ export declare function personalAccessKeyPrompt({ env, account, }: {
     env: string;
     account?: number;
 }): Promise<PersonalAccessKeyPromptResponse>;
-export declare const OAUTH_FLOW: (PromptConfig<{
-    name: string;
-}> | PromptConfig<AccountIdPromptResponse> | PromptConfig<ClientIdPromptResponse> | PromptConfig<ClientSecretPromptResponse> | PromptConfig<ScopesPromptResponse>)[];
+export declare const OAUTH_FLOW: (PromptConfig<AccountNamePromptResponse> | PromptConfig<AccountIdPromptResponse> | PromptConfig<ClientIdPromptResponse> | PromptConfig<ClientSecretPromptResponse> | PromptConfig<ScopesPromptResponse>)[];
 export {};

package/lib/ui/index.d.ts

@@ -7,7 +7,7 @@ export declare function uiLine(): void;
 export declare function uiLink(linkText: string, url: string): string;
 export declare function uiAccountDescription(accountId?: number | null, bold?: boolean): string;
 export declare function uiInfoSection(title: string, logContent: () => void): void;
-export declare function uiCommandReference(command: string): string;
+export declare function uiCommandReference(command: string, withQuotes?: boolean): string;
 export declare function uiFeatureHighlight(commands: string[], title?: string): void;
 export declare function uiBetaTag(message: string, log?: boolean): string | undefined;
 export declare function uiDeprecatedTag(message: string): void;

package/lib/ui/index.js

@@ -70,9 +70,9 @@ function uiInfoSection(title, logContent) {
     logger_1.logger.log('');
     uiLine();
 }
-function uiCommandReference(command) {
+function uiCommandReference(command, withQuotes = true) {
     const terminalUISupport = getTerminalUISupport();
-    const commandReference = `\`${command}\``;
+    const commandReference = withQuotes ? `\`${command}\`` : command;
     return chalk_1.default.bold(terminalUISupport.color
         ? chalk_1.default.hex(exports.UI_COLORS.MARIGOLD_DARK)(commandReference)
         : commandReference);

package/lib/ui/supportHyperlinks.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.supportsHyperlinkModule = void 0;
-const hasFlag_1 = require("../hasFlag");
+const yargsUtils_1 = require("../yargsUtils");
 //See https://github.com/jamestalmage/supports-hyperlinks (License: https://github.com/jamestalmage/supports-hyperlinks/blob/master/license)
 function parseVersion(versionString) {
     if (/^\d{3,4}$/.test(versionString)) {
@@ -22,7 +22,7 @@ function parseVersion(versionString) {
 }
 function supportsHyperlink(stream) {
     const { env } = process;
-    if ((0, hasFlag_1.hasFlag)('noHyperlinks')) {
+    if ((0, yargsUtils_1.hasFlag)('noHyperlinks')) {
         return false;
     }
     if (stream && !stream.isTTY) {