verifyPluginVersion.ts

/*
 * Copyright (c) 2018, salesforce.com, inc.
 * All rights reserved.
 * Licensed under the BSD 3-Clause license.
 * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
 */

import { Hook } from '@oclif/core';
import { compareVersions, isVersion } from '../versions';

const FORCE_PLUGINS = ['salesforce-alm', 'force-language-services'];
export const BANNED_PLUGINS: Record<string, string> = {
  salesforcedx: `The salesforcedx plugin is deprecated.
    Installing it manually via 'sfdx plugins:install salesforcedx' is no longer supported and can result in duplicate commands and outdated plugins.
    See https://github.com/forcedotcom/cli/issues/1016 for more information about this change.`,
  'sfdx-cli':
    "'sfdx-cli' cannot be installed as a plugin. If you are trying to install an older version of the cli, visit https://sfdc.co/install-older-cli-versions for instructions",
};
const MIN_VERSION = '45.8.0';

/**
 * A CLI plugin preinstall hook that checks that the plugin's version is v7-compatible,
 * if it is recognized as a force namespace plugin.
 */
// eslint-disable-next-line @typescript-eslint/require-await
const hook: Hook.PluginsPreinstall = async function (options): Promise<void> {
  if (options.plugin && options.plugin.type === 'npm') {
    const plugin = options.plugin;
    if (Object.keys(BANNED_PLUGINS).includes(plugin.name)) {
      this.error(BANNED_PLUGINS[plugin.name]);
    }
    if (FORCE_PLUGINS.includes(plugin.name) && isVersion(plugin.tag) && compareVersions(plugin.tag, MIN_VERSION) < 0) {
      this.error(
        `The ${plugin.name} plugin can only be installed using a specific version when ` +
          `the version is greater than or equal to ${MIN_VERSION}.`
      );
    }
  }
};

export default hook;