@shopify/cli-kit/dist/public/node/custom-oclif-loader.js

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

import { fileExistsSync } from './fs.js';
import { cwd, joinPath, sniffForPath } from './path.js';
import { isDevelopment } from './context/local.js';
import { execaSync } from 'execa';
import { Config } from '@oclif/core';
export class ShopifyConfig extends Config {
    constructor(options) {
        if (isDevelopment()) {
            const currentPath = cwd();
            let path = sniffForPath() ?? currentPath;
            // Hydrogen CI uses `hydrogen/hydrogen` path, while local dev uses `shopify/hydrogen`.
            const currentPathMightBeHydrogenMonorepo = /(shopify|hydrogen)\/hydrogen/i.test(currentPath);
            const ignoreHydrogenMonorepo = process.env.IGNORE_HYDROGEN_MONOREPO;
            if (currentPathMightBeHydrogenMonorepo && !ignoreHydrogenMonorepo) {
                path = execaSync('npm', ['prefix']).stdout.trim();
            }
            if (fileExistsSync(joinPath(path, 'package.json'))) {
                // Hydrogen is bundled, but we still want to support loading it as an external plugin for two reasons:
                // 1. To allow users to use an older version of Hydrogen. (to not force upgrades)
                // 2. To allow the Hydrogen team to load a local version for testing.
                options.pluginAdditions = {
                    core: ['@shopify/cli-hydrogen'],
                    path,
                };
            }
        }
        super(options);
        if (isDevelopment()) {
            // @ts-expect-error: This is a private method that we are overriding. OCLIF doesn't provide a way to extend it.
            // eslint-disable-next-line @typescript-eslint/unbound-method
            this.determinePriority = this.customPriority;
        }
    }
    customPriority(commands) {
        const oclifPlugins = this.pjson.oclif.plugins ?? [];
        const commandPlugins = commands.sort((aCommand, bCommand) => {
            // eslint-disable-next-line no-restricted-syntax
            const pluginAliasA = aCommand.pluginAlias ?? 'A-Cannot-Find-This';
            // eslint-disable-next-line no-restricted-syntax
            const pluginAliasB = bCommand.pluginAlias ?? 'B-Cannot-Find-This';
            const aIndex = oclifPlugins.indexOf(pluginAliasA);
            const bIndex = oclifPlugins.indexOf(pluginAliasB);
            // If there is an external cli-hydrogen plugin, its commands should take priority over bundled ('core') commands
            if (aCommand.pluginType === 'core' && bCommand.pluginAlias === '@shopify/cli-hydrogen') {
                // If b is hydrogen and a is core sort b first
                return 1;
            }
            if (aCommand.pluginAlias === '@shopify/cli-hydrogen' && bCommand.pluginType === 'core') {
                // If a is hydrogen and b is core sort a first
                return -1;
            }
            // All other cases are the default implementation from the private `determinePriority` method
            // When both plugin types are 'core' plugins sort based on index
            if (aCommand.pluginType === 'core' && bCommand.pluginType === 'core') {
                // If b appears first in the pjson.plugins sort it first
                return aIndex - bIndex;
            }
            // if b is a core plugin and a is not sort b first
            if (bCommand.pluginType === 'core' && aCommand.pluginType !== 'core') {
                return 1;
            }
            // if a is a core plugin and b is not sort a first
            if (aCommand.pluginType === 'core' && bCommand.pluginType !== 'core') {
                return -1;
            }
            // if a is a jit plugin and b is not sort b first
            if (aCommand.pluginType === 'jit' && bCommand.pluginType !== 'jit') {
                return 1;
            }
            // if b is a jit plugin and a is not sort a first
            if (bCommand.pluginType === 'jit' && aCommand.pluginType !== 'jit') {
                return -1;
            }
            // neither plugin is core, so do not change the order
            return 0;
        });
        return commandPlugins[0];
    }
}
//# sourceMappingURL=custom-oclif-loader.js.map