@shopify/cli-kit/dist/public/node/hooks/prerun.js

A set of utilities, interfaces, and models that are common across all the platform features

import { CLI_KIT_VERSION } from '../../common/version.js';
import { checkForNewVersion, checkForCachedNewVersion } from '../node-package-manager.js';
import { startAnalytics } from '../../../private/node/analytics.js';
import { outputDebug, outputWarn } from '../../../public/node/output.js';
import { getOutputUpdateCLIReminder } from '../../../public/node/upgrade.js';
import { runAtMinimumInterval } from '../../../private/node/conf-store.js';
import { fetchNotificationsInBackground } from '../notifications-system.js';
import { isPreReleaseVersion } from '../version.js';
// This hook is called before each command run. More info: https://oclif.io/docs/hooks
export const hook = async (options) => {
    const commandContent = parseCommandContent({
        id: options.Command.id,
        aliases: options.Command.aliases,
        pluginAlias: options.Command.plugin?.alias,
    });
    const args = options.argv;
    await warnOnAvailableUpgrade();
    outputDebug(`Running command ${commandContent.command}`);
    await startAnalytics({ commandContent, args, commandClass: options.Command });
    fetchNotificationsInBackground(options.Command.id);
};
export function parseCommandContent(cmdInfo) {
    let commandContent = parseCreateCommand(cmdInfo.pluginAlias);
    if (!commandContent) {
        commandContent = parseNormalCommand(cmdInfo.id, cmdInfo.aliases);
    }
    return commandContent;
}
function parseNormalCommand(id, aliases) {
    return {
        command: id.replace(/:/g, ' '),
        topic: parseTopic(id),
        alias: findAlias(aliases),
    };
}
/**
 * Create commands implement Init by default, so the name of the command must be extracted from
 * the plugin/module name. Neither alias or topic are supported
 *
 * @param commandClass - Oclif command configuration
 * @returns Command content with the name of the command or undefined otherwise
 */
function parseCreateCommand(pluginAlias) {
    if (!pluginAlias?.startsWith('@shopify/create-')) {
        return undefined;
    }
    return { command: pluginAlias.substring(pluginAlias.indexOf('/') + 1) };
}
/**
 * Commands use this pattern topic:subtopic1:...:subtopicN:command. This method extract the topic and subtopic
 * information replacing the ':' separator with one space
 *
 * @param cmd - Complete command string to extract the topic information
 * @returns The topic name or undefined otherwise
 */
function parseTopic(cmd) {
    if (cmd.lastIndexOf(':') === -1) {
        return;
    }
    return cmd.slice(0, cmd.lastIndexOf(':')).replace(/:/g, ' ');
}
/**
 * Identifies if the command was launched using an alias instead of the oficial command name
 *
 * @param aliases - List of possible alias a command has
 * @returns The alias used or undefined otherwise
 */
function findAlias(aliases) {
    const existingAlias = aliases.find((alias) => alias.split(':').every((aliasToken) => process.argv.includes(aliasToken)));
    if (existingAlias) {
        return existingAlias.replace(/:/g, ' ');
    }
}
/**
 * Warns the user if there is a new version of the CLI available
 */
export async function warnOnAvailableUpgrade() {
    const cliDependency = '@shopify/cli';
    const currentVersion = CLI_KIT_VERSION;
    if (isPreReleaseVersion(currentVersion)) {
        // This is a nightly/snapshot/experimental version, so we don't want to check for updates
        return;
    }
    // Check in the background, once daily
    // eslint-disable-next-line no-void
    void checkForNewVersion(cliDependency, currentVersion, { cacheExpiryInHours: 24 });
    // Warn if we previously found a new version
    await runAtMinimumInterval('warn-on-available-upgrade', { days: 1 }, async () => {
        const newerVersion = checkForCachedNewVersion(cliDependency, currentVersion);
        if (newerVersion) {
            outputWarn(getOutputUpdateCLIReminder(newerVersion));
        }
    });
}
//# sourceMappingURL=prerun.js.map