@hubspot/cli 7.8.0-experimental.0 → 7.8.0

package/lib/ui/SpinniesManager.js

@@ -7,8 +7,10 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 **/
+import readline from 'readline';
 import chalk from 'chalk';
-import { colorOptions, purgeSpinnerOptions, purgeSpinnersOptions, SPINNERS, terminalSupportsUnicode, } from './spinniesUtils.js';
+import cliCursor from 'cli-cursor';
+import { breakText, cleanStream, colorOptions, getLinesLength, purgeSpinnerOptions, purgeSpinnersOptions, SPINNERS, terminalSupportsUnicode, writeStream, prefixOptions, } from './spinniesUtils.js';
 function safeColor(text, color) {
     const chalkFn = chalk[color];
     if (typeof chalkFn === 'function') {
@@ -17,6 +19,7 @@ function safeColor(text, color) {
     return text;
 }
 class SpinniesManager {
+    disableOutput = false;
     options;
     spinners = {};
     isCursorHidden = false;
@@ -34,10 +37,14 @@ class SpinniesManager {
             succeedColor: 'green',
             failColor: 'red',
             spinner: terminalSupportsUnicode() ? SPINNERS.dots : SPINNERS.dashes,
-            disableSpins: true,
+            disableSpins: false,
             ...purgeSpinnersOptions(options),
         };
-        this.spin = false;
+        this.spin =
+            !this.options.disableSpins &&
+                !process.env.CI &&
+                process.stderr &&
+                process.stderr.isTTY;
         if (!this.hasAnySpinners()) {
             this.resetState();
         }
@@ -55,6 +62,9 @@ class SpinniesManager {
         this.lineCount = 0;
         this.currentFrameIndex = 0;
     }
+    setDisableOutput(disableOutput) {
+        this.disableOutput = disableOutput;
+    }
     pick(name) {
         return this.spinners?.[name];
     }
@@ -135,7 +145,25 @@ class SpinniesManager {
         status = status || 'spinning';
         this.spinners[name] = { ...this.spinners[name], ...options, status };
     }
-    updateSpinnerState() { }
+    updateSpinnerState() {
+        if (this.disableOutput) {
+            return;
+        }
+        if (this.spin) {
+            if (this.currentInterval) {
+                clearInterval(this.currentInterval);
+            }
+            this.currentInterval = this.loopStream();
+            if (!this.isCursorHidden) {
+                cliCursor.hide();
+            }
+            this.isCursorHidden = true;
+            this.checkIfActiveSpinners();
+        }
+        else {
+            this.setRawStreamOutput();
+        }
+    }
     loopStream() {
         const frames = this.options.spinner?.frames || SPINNERS.dots.frames;
         const interval = this.options.spinner?.interval || SPINNERS.dots.interval;
@@ -147,10 +175,86 @@ class SpinniesManager {
                     : ++this.currentFrameIndex;
         }, interval);
     }
-    setStreamOutput(frame = '') { }
-    setRawStreamOutput() { }
-    checkIfActiveSpinners() { }
-    bindSigint() { }
+    setStreamOutput(frame = '') {
+        let output = '';
+        const linesLength = [];
+        const hasActiveSpinners = this.hasActiveSpinners();
+        Object.values(this.spinners).forEach(spinner => {
+            let { text } = spinner;
+            const { status, color, spinnerColor, succeedColor, failColor, indent = 0, succeedPrefix = prefixOptions(this.options).succeedPrefix, failPrefix = prefixOptions(this.options).failPrefix, } = spinner;
+            let line;
+            let prefixLength = indent;
+            text = text ?? '';
+            if (status === 'spinning') {
+                prefixLength += frame.length + 1;
+                text = breakText(text, prefixLength);
+                const colorizedFrame = safeColor(frame, spinnerColor);
+                const colorizedText = safeColor(text, color);
+                line = `${colorizedFrame} ${colorizedText}`;
+            }
+            else {
+                if (status === 'succeed') {
+                    prefixLength += succeedPrefix.length + 1;
+                    if (hasActiveSpinners) {
+                        text = breakText(text, prefixLength);
+                    }
+                    const colorizedText = safeColor(text, succeedColor);
+                    line = `${chalk.green(succeedPrefix)} ${colorizedText}`;
+                }
+                else if (status === 'fail') {
+                    prefixLength += failPrefix.length + 1;
+                    if (hasActiveSpinners) {
+                        text = breakText(text, prefixLength);
+                    }
+                    const colorizedText = safeColor(text, failColor);
+                    line = `${chalk.red(failPrefix)} ${colorizedText}`;
+                }
+                else {
+                    if (hasActiveSpinners) {
+                        text = breakText(text, prefixLength);
+                    }
+                    line = safeColor(text, color);
+                }
+            }
+            linesLength.push(...getLinesLength(text, prefixLength));
+            output += indent ? `${' '.repeat(indent)}${line}\n` : `${line}\n`;
+        });
+        if (!hasActiveSpinners) {
+            readline.clearScreenDown(this.stream);
+        }
+        writeStream(this.stream, output, linesLength);
+        if (hasActiveSpinners) {
+            cleanStream(this.stream, linesLength);
+        }
+        this.lineCount = linesLength.length;
+    }
+    setRawStreamOutput() {
+        Object.values(this.spinners).forEach(i => {
+            process.stderr.write(`- ${i.text}\n`);
+        });
+    }
+    checkIfActiveSpinners() {
+        if (!this.hasActiveSpinners()) {
+            if (this.spin) {
+                this.setStreamOutput();
+                readline.moveCursor(this.stream, 0, this.lineCount);
+                if (this.currentInterval) {
+                    clearInterval(this.currentInterval);
+                }
+                this.isCursorHidden = false;
+                cliCursor.show();
+            }
+            this.spinners = {};
+        }
+    }
+    bindSigint() {
+        process.removeAllListeners('SIGINT');
+        process.on('SIGINT', () => {
+            cliCursor.show();
+            readline.moveCursor(process.stderr, 0, this.lineCount);
+            process.exit(0);
+        });
+    }
 }
 const toExport = new SpinniesManager();
 export default toExport;

package/lib/ui/boxen.js

@@ -1,6 +1,5 @@
 import { uiLogger } from './logger.js';
 import { UI_COLORS } from './index.js';
-import { logger } from '@hubspot/local-dev-lib/logger';
 import { lib } from '../../lang/en.js';
 const defaultOptions = {
     titleAlignment: 'left',
@@ -17,7 +16,7 @@ export async function logInBox({ contents, options, }) {
         return;
     }
     catch (error) {
-        logger.debug(lib.boxen.failedToLoad);
+        uiLogger.debug(lib.boxen.failedToLoad);
         if (options?.title) {
             uiLogger.log(options.title);
             uiLogger.log('');

package/lib/ui/git.js

@@ -1,22 +1,25 @@
 import os from 'os';
 import { checkGitInclusion } from '@hubspot/local-dev-lib/gitignore';
-import { logger } from '@hubspot/local-dev-lib/logger';
-import { i18n } from '../lang.js';
+import { uiLogger } from './logger.js';
+import { lib } from '../../lang/en.js';
+import { uiLine } from './index.js';
 export function checkAndWarnGitInclusion(configPath) {
     try {
         const { inGit, configIgnored } = checkGitInclusion(configPath);
         if (!inGit || configIgnored)
             return;
-        logger.warn(i18n(`lib.ui.git.securityIssue`));
-        logger.warn(i18n(`lib.ui.git.configFileTracked`));
-        logger.warn(i18n(`lib.ui.git.fileName`, { configPath }));
-        logger.warn(i18n(`lib.ui.git.remediate`));
-        logger.warn(i18n(`lib.ui.git.moveConfig`, { homeDir: os.homedir() }));
-        logger.warn(i18n(`lib.ui.git.addGitignore`, { configPath }));
-        logger.warn(i18n(`lib.ui.git.noRemote`));
+        uiLine();
+        uiLogger.warn(lib.ui.git.securityIssue);
+        uiLogger.log(lib.ui.git.configFileTracked);
+        uiLogger.log(lib.ui.git.fileName(configPath));
+        uiLogger.log('');
+        uiLogger.log(lib.ui.git.moveConfig(os.homedir()));
+        uiLogger.log(lib.ui.git.addGitignore(configPath));
+        uiLogger.log(lib.ui.git.noRemote);
+        uiLine();
     }
     catch (e) {
         // fail silently
-        logger.debug(i18n(`lib.ui.git.checkFailed`));
+        uiLogger.debug(lib.ui.git.checkFailed);
     }
 }

package/lib/ui/index.d.ts

@@ -13,6 +13,10 @@ 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, withQuotes?: boolean): string;
+export declare function uiAuthCommandReference({ accountId, qa, }?: {
+    accountId?: number | string;
+    qa?: boolean;
+}): string;
 export declare function uiFeatureHighlight(features: string[], title?: string): void;
 export declare function uiBetaTag(message: string, log?: true): undefined;
 export declare function uiBetaTag(message: string, log: false): string;

package/lib/ui/index.js

@@ -1,9 +1,9 @@
 import chalk from 'chalk';
-import { getAccountConfig } from '@hubspot/local-dev-lib/config';
-import { logger } from '@hubspot/local-dev-lib/logger';
+import { getAccountConfig, configFileExists, } from '@hubspot/local-dev-lib/config';
+import { uiLogger } from './logger.js';
 import { supportsHyperlinkModule } from './supportHyperlinks.js';
 import { supportsColor } from './supportsColor.js';
-import { i18n } from '../lang.js';
+import { uiMessages } from './uiMessages.js';
 import { HUBSPOT_ACCOUNT_TYPE_STRINGS } from '@hubspot/local-dev-lib/constants/config';
 export const UI_COLORS = {
     SORBET: '#FF8F59',
@@ -11,7 +11,7 @@ export const UI_COLORS = {
     MARIGOLD_DARK: '#dbae60',
 };
 export function uiLine() {
-    logger.log('-'.repeat(50));
+    uiLogger.log('-'.repeat(50));
 }
 export function getTerminalUISupport() {
     return {
@@ -50,10 +50,10 @@ export function uiAccountDescription(accountId, bold = true) {
 }
 export function uiInfoSection(title, logContent) {
     uiLine();
-    logger.log(chalk.bold(title));
-    logger.log('');
+    uiLogger.log(chalk.bold(title));
+    uiLogger.log('');
     logContent();
-    logger.log('');
+    uiLogger.log('');
     uiLine();
 }
 export function uiCommandReference(command, withQuotes = true) {
@@ -63,66 +63,75 @@ export function uiCommandReference(command, withQuotes = true) {
         ? chalk.hex(UI_COLORS.MARIGOLD_DARK)(commandReference)
         : commandReference);
 }
+export function uiAuthCommandReference({ accountId, qa, } = {}) {
+    const userIsUsingGlobalConfig = configFileExists(true);
+    let command = 'hs auth';
+    if (userIsUsingGlobalConfig) {
+        command = 'hs account auth';
+    }
+    return uiCommandReference(`${command}${accountId ? ` --account=${accountId}` : ''}${qa ? ' --qa' : ''}`);
+}
 export function uiFeatureHighlight(features, title) {
-    uiInfoSection(title ? title : i18n(`lib.ui.featureHighlight.defaultTitle`), () => {
+    uiInfoSection(title ? title : uiMessages.featureHighlight.defaultTitle, () => {
         features.forEach(feature => {
-            const featureKey = `lib.ui.featureHighlight.featureKeys.${feature}`;
-            const message = i18n(`${featureKey}.message`, {
-                command: uiCommandReference(i18n(`${featureKey}.command`)),
-                link: uiLink(i18n(`${featureKey}.linkText`), i18n(`${featureKey}.url`)),
-            });
-            logger.log(`  - ${message}`);
+            const featureConfig = uiMessages.featureHighlight.featureKeys[feature];
+            if (!featureConfig) {
+                uiLogger.debug(`Feature config not found for: ${feature}`);
+                return;
+            }
+            let message;
+            if ('linkText' in featureConfig && 'url' in featureConfig) {
+                // linkText + url (for sampleProjects)
+                message = featureConfig.message(uiLink(featureConfig.linkText, featureConfig.url));
+            }
+            else if ('command' in featureConfig && 'message' in featureConfig) {
+                // Command + Message function (most cases)
+                message = featureConfig.message(uiCommandReference(featureConfig.command));
+            }
+            else {
+                // Message only (for projectCommandTip)
+                message = featureConfig.message;
+            }
+            uiLogger.log(`  - ${message}`);
         });
     });
 }
 export function uiBetaTag(message, log = true) {
-    const tag = i18n(`lib.ui.betaTag`);
+    const tag = uiMessages.betaTag;
     const result = `${tag} ${message}`;
     if (log) {
-        logger.log(result);
+        uiLogger.log(result);
         return;
     }
     return result;
 }
 export function uiDeprecatedTag(message, log = true) {
-    const tag = i18n(`lib.ui.deprecatedTag`);
+    const tag = uiMessages.deprecatedTag;
     const result = `${tag} ${message}`;
     if (log) {
-        logger.log(result);
+        uiLogger.log(result);
         return;
     }
     return result;
 }
 export function uiCommandDisabledBanner(command, url, message) {
     const tag = message ||
-        i18n(`lib.ui.disabledMessage`, {
-            command: uiCommandReference(command),
-            url: url ? uiLink(i18n(`lib.ui.disabledUrlText`), url) : '',
-            npmCommand: uiCommandReference('npm i -g @hubspot/cli@latest'),
-        });
-    logger.log();
+        `The ${uiCommandReference(command)} command is disabled. Run ${uiCommandReference('npm i -g @hubspot/cli@latest')} to update to the latest HubSpot CLI version. ${url ? uiLink('See all HubSpot CLI commands here.', url) : ''}`;
+    uiLogger.log('');
     uiLine();
-    logger.error(tag);
+    uiLogger.error(tag);
     uiLine();
-    logger.log();
+    uiLogger.log('');
 }
 export function uiDeprecatedDescription(message, command, url) {
-    const tag = i18n(`lib.ui.deprecatedDescription`, {
-        message,
-        command: uiCommandReference(command),
-        url: url ? uiLink(i18n(`lib.ui.deprecatedUrlText`), url) : '',
-    });
+    const tag = message || uiMessages.disabledMessage(command, url);
     return uiDeprecatedTag(tag);
 }
 export function uiDeprecatedMessage(command, url, message) {
-    const tag = message ||
-        i18n(`lib.ui.deprecatedMessage`, {
-            command: uiCommandReference(command),
-            url: url ? uiLink(i18n(`lib.ui.deprecatedUrlText`), url) : '',
-        });
-    logger.log();
+    const tag = uiMessages.deprecatedDescription(message || '', command, url);
+    uiLogger.log('');
     uiDeprecatedTag(tag);
-    logger.log();
+    uiLogger.log('');
 }
 export function indent(level) {
     const indentation = '  ';

package/lib/ui/serverlessFunctionLogs.js

@@ -1,7 +1,8 @@
 import moment from 'moment';
 import chalk from 'chalk';
-import { logger, Styles } from '@hubspot/local-dev-lib/logger';
-import { i18n } from '../lang.js';
+import { Styles } from '@hubspot/local-dev-lib/logger';
+import { uiLogger } from './logger.js';
+import { lib } from '../../lang/en.js';
 const SEPARATOR = ' - ';
 const LOG_STATUS_COLORS = {
     SUCCESS: Styles.success,
@@ -56,9 +57,7 @@ function processLog(log, options) {
         return logHandler[log.status](log, options);
     }
     catch (e) {
-        logger.error(i18n(`lib.ui.serverlessFunctionLogs.unableToProcessLog`, {
-            log: JSON.stringify(log),
-        }));
+        uiLogger.error(lib.ui.serverlessFunctionLogs.unableToProcessLog(JSON.stringify(log)));
     }
 }
 function isLogsResponse(logsResp) {
@@ -70,7 +69,7 @@ function isLogsResponse(logsResp) {
 function processLogs(logsResp, options) {
     const isLogsResp = isLogsResponse(logsResp);
     if (!logsResp || (isLogsResp && logsResp.results.length === 0)) {
-        return i18n(`lib.ui.serverlessFunctionLogs.noLogsFound`);
+        return lib.ui.serverlessFunctionLogs.noLogsFound;
     }
     else if (isLogsResp) {
         return logsResp
@@ -82,5 +81,8 @@ function processLogs(logsResp, options) {
     return processLog(logsResp, options);
 }
 export function outputLogs(logsResp, options) {
-    logger.log(processLogs(logsResp, options));
+    const result = processLogs(logsResp, options);
+    if (result) {
+        uiLogger.log(result);
+    }
 }

package/lib/ui/uiMessages.d.ts

@@ -0,0 +1,72 @@
+export declare const uiMessages: {
+    betaTag: string;
+    deprecatedTag: string;
+    deprecatedDescription: (message: string, command: string, url?: string) => string;
+    disabledMessage: (command: string, url?: string) => string;
+    disabledUrlText: string;
+    featureHighlight: {
+        defaultTitle: string;
+        featureKeys: {
+            accountOption: {
+                command: string;
+                message: (command: string) => string;
+            };
+            accountsListCommand: {
+                command: string;
+                message: (command: string) => string;
+            };
+            accountsUseCommand: {
+                command: string;
+                message: (command: string) => string;
+            };
+            authCommand: {
+                command: string;
+                message: (command: string) => string;
+            };
+            feedbackCommand: {
+                command: string;
+                message: (command: string) => string;
+            };
+            getStartedCommand: {
+                command: string;
+                message: (command: string) => string;
+            };
+            helpCommand: {
+                command: string;
+                message: (command: string) => string;
+            };
+            projectCreateCommand: {
+                command: string;
+                message: (command: string) => string;
+            };
+            projectDeployCommand: {
+                command: string;
+                message: (command: string) => string;
+            };
+            projectHelpCommand: {
+                command: string;
+                message: (command: string) => string;
+            };
+            projectUploadCommand: {
+                command: string;
+                message: (command: string) => string;
+            };
+            projectDevCommand: {
+                command: string;
+                message: (command: string) => string;
+            };
+            projectInstallDepsCommand: {
+                command: string;
+                message: (command: string) => string;
+            };
+            projectCommandTip: {
+                message: string;
+            };
+            sampleProjects: {
+                linkText: string;
+                url: string;
+                message: (link: string) => string;
+            };
+        };
+    };
+};

package/lib/ui/uiMessages.js

@@ -0,0 +1,75 @@
+// UI messages for the UI module - separate file to avoid circular imports with lang/en.ts
+// This contains the same strings that would be in lib.ui.* from lang/en.ts
+import { uiCommandReference, uiLink } from './index.js';
+export const uiMessages = {
+    betaTag: '[BETA]',
+    deprecatedTag: '[DEPRECATED]',
+    deprecatedDescription: (message, command, url) => `${message}. The ${uiCommandReference(command)} command is deprecated and will be disabled soon. ${url ? uiLink('Learn more', url) : ''}`,
+    disabledMessage: (command, url) => `The ${uiCommandReference(command)} command is disabled. Run ${uiCommandReference('npm i -g @hubspot/cli@latest')} to update to the latest HubSpot CLI version. ${url ? uiLink('Learn more', url) : ''}`,
+    disabledUrlText: 'See all HubSpot CLI commands here.',
+    featureHighlight: {
+        defaultTitle: "What's next?",
+        featureKeys: {
+            accountOption: {
+                command: '--account',
+                message: (command) => `Use the ${command} option with any command to override the default account`,
+            },
+            accountsListCommand: {
+                command: 'hs accounts list',
+                message: (command) => `${command} - See a list of configured HubSpot accounts`,
+            },
+            accountsUseCommand: {
+                command: 'hs accounts use',
+                message: (command) => `${command} - Set the Hubspot account that the CLI will target by default`,
+            },
+            authCommand: {
+                command: 'hs auth',
+                message: (command) => `${command} - Connect the CLI to additional HubSpot accounts`,
+            },
+            feedbackCommand: {
+                command: 'hs feedback',
+                message: (command) => `${command} - Report a bug or leave feedback`,
+            },
+            getStartedCommand: {
+                command: 'hs get-started',
+                message: (command) => `${command} - Get started with HubSpot development`,
+            },
+            helpCommand: {
+                command: 'hs help',
+                message: (command) => `${command} - See a list of available commands`,
+            },
+            projectCreateCommand: {
+                command: 'hs project create',
+                message: (command) => `${command} - Create a new project`,
+            },
+            projectDeployCommand: {
+                command: 'hs project deploy',
+                message: (command) => `Ready to take your project live? Run ${command}`,
+            },
+            projectHelpCommand: {
+                command: 'hs project --help',
+                message: (command) => `${command} - Learn more about available project commands`,
+            },
+            projectUploadCommand: {
+                command: 'hs project upload',
+                message: (command) => `${command} - Upload your project to HubSpot and trigger builds`,
+            },
+            projectDevCommand: {
+                command: 'hs project dev',
+                message: (command) => `${command} - Set up a test environment and start local development`,
+            },
+            projectInstallDepsCommand: {
+                command: 'hs project install-deps',
+                message: (command) => `${command} - Install all project dependencies`,
+            },
+            projectCommandTip: {
+                message: 'Tip: All project commands must be run from within a project directory',
+            },
+            sampleProjects: {
+                linkText: "HubSpot's sample projects",
+                url: 'https://developers.hubspot.com/docs/platform/sample-projects?utm_source=cli&utm_content=project_create_whats_next',
+                message: (link) => `See ${link}`,
+            },
+        },
+    },
+};

package/lib/usageTracking.js

@@ -1,7 +1,7 @@
 import { trackUsage } from '@hubspot/local-dev-lib/trackUsage';
 import { isTrackingAllowed, getAccountConfig, } from '@hubspot/local-dev-lib/config';
 import { API_KEY_AUTH_METHOD } from '@hubspot/local-dev-lib/constants/auth';
-import { logger } from '@hubspot/local-dev-lib/logger';
+import { uiLogger } from './ui/logger.js';
 import packageJson from '../package.json' with { type: 'json' };
 const version = packageJson.version;
 import { debugError } from './errorHandlers/index.js';
@@ -31,7 +31,7 @@ export async function trackCommandUsage(command, meta = {}, accountId) {
     if (!isTrackingAllowed()) {
         return;
     }
-    logger.debug('Attempting to track usage of "%s" command', command);
+    uiLogger.debug(`Attempting to track usage of "${command}" command`);
     let authType = 'unknown';
     if (accountId) {
         const accountConfig = getAccountConfig(accountId);
@@ -44,7 +44,7 @@ export async function trackCommandUsage(command, meta = {}, accountId) {
         action: 'cli-command',
         command,
         authType,
-        ...meta,
+        meta,
         accountId,
     });
 }
@@ -53,10 +53,10 @@ export async function trackHelpUsage(command) {
         return;
     }
     if (command) {
-        logger.debug('Tracking help usage of "%s" sub-command', command);
+        uiLogger.debug(`Tracking help usage of "${command}" sub-command`);
     }
     else {
-        logger.debug('Tracking help usage of main command');
+        uiLogger.debug('Tracking help usage of main command');
     }
     return trackCliInteraction({
         action: 'cli-help',
@@ -84,7 +84,7 @@ export async function trackCommandMetadataUsage(command, meta = {}, accountId) {
     if (!isTrackingAllowed()) {
         return;
     }
-    logger.debug('Attempting to track metadata usage of "%s" command', command);
+    uiLogger.debug(`Attempting to track metadata usage of "${command}" command`);
     let authType = 'unknown';
     if (accountId) {
         const accountConfig = getAccountConfig(accountId);
@@ -122,7 +122,7 @@ async function trackCliInteraction({ action, accountId, command, authType, meta
                     action: 'cli-mcp-server',
                     type: process.env.HUBSPOT_MCP_AI_AGENT,
                 }, accountId);
-                logger.debug('Sent AI usage tracking command event: %o', {
+                uiLogger.debug('Sent AI usage tracking command event:', {
                     ...usageTrackingEvent,
                     action: 'cli-mcp-server',
                     type: process.env.HUBSPOT_MCP_AI_AGENT,
@@ -133,12 +133,12 @@ async function trackCliInteraction({ action, accountId, command, authType, meta
             }
         }
         try {
+            uiLogger.debug('Sent usage tracking command event:', usageTrackingEvent);
             return trackUsage('cli-interaction', EventClass.INTERACTION, usageTrackingEvent, accountId);
         }
         catch (error) {
             debugError(error);
         }
-        logger.debug('Sent usage tracking command event: %o', usageTrackingEvent);
     }
     catch (e) {
         debugError(e);