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

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

import { getNextDeprecationDate } from '../../../private/node/context/deprecations-store.js';
import { renderWarning } from '../ui.js';
/**
 * After a successful command run, renders an upgrade warning if `nextDeprecationDate` is present.
 *
 * @param Command - The class of the command that was run.
 */
export const postrun = (Command) => {
    const nextDeprecationDate = getNextDeprecationDate();
    if (nextDeprecationDate) {
        const forThemes = Command.id.includes('theme');
        renderUpgradeWarning(nextDeprecationDate, forThemes);
    }
};
/**
 * Renders a warning to upgrade to avoid using deprecated features
 * that will no longer be supported after the specified date.
 *
 * @param upgradeByDate - The earliest future date when deprecated features will no longer be supported.
 * @param forThemes - If true, references the upgrade link for themes, else for apps.
 */
function renderUpgradeWarning(upgradeByDate, forThemes) {
    const dateFormat = new Intl.DateTimeFormat('default', {
        year: 'numeric',
        month: 'long',
        day: 'numeric',
    });
    const formattedDate = dateFormat.format(upgradeByDate);
    const headline = `Upgrade to the latest CLI version by ${formattedDate}.`;
    const body = 'This command requires an upgrade to continue working as intended.';
    const upgradeLink = {
        link: {
            label: 'upgrade Shopify CLI',
            url: forThemes
                ? `https://shopify.dev/docs/themes/tools/cli#upgrade-shopify-cli`
                : `https://shopify.dev/docs/apps/tools/cli#upgrade-shopify-cli`,
        },
    };
    const nextSteps = [['Run', { command: 'upgrade' }, 'to', upgradeLink]];
    renderWarning({
        headline,
        body,
        nextSteps,
    });
}
//# sourceMappingURL=deprecations.js.map