semantic-release-vsce/lib/publish.js

semantic-release plugin to package and publish VS Code extensions

// @ts-check

import { readJson } from 'fs-extra/esm';
import path from 'node:path';
import process from 'node:process';
import {
  isAzureCredentialEnabled,
  isOvsxPublishEnabled,
  isPreReleaseEnabled,
  isTargetEnabled,
  isVscePublishEnabled,
} from './utilities.js';
import { publish as vscePublish } from '@vscode/vsce';
import { publish as ovsxPublish } from 'ovsx';

export async function publish(version, packagePath, logger, cwd) {
  const { publisher, name } = await readJson(path.join(cwd, './package.json'));

  /** @type {{ -readonly [K in keyof import('@vscode/vsce').IPublishOptions]: import('@vscode/vsce').IPublishOptions[K] }} */
  const vsceOptions = {
    cwd,
    pat: process.env.VSCE_PAT,
    azureCredential: isAzureCredentialEnabled(),
  };
  /** @type {import('ovsx').PublishOptions} */
  const ovsxOptions = {
    // cwd is not relevant for ovsx as we always provide packagePath
    pat: process.env.OVSX_PAT,
  };

  let message = `Publishing version ${version}`;
  if (packagePath) {
    // Ensure packagePath is a list
    if (typeof packagePath === 'string') {
      packagePath = [packagePath];
    }

    vsceOptions.packagePath = packagePath;
    ovsxOptions.packagePath = packagePath;
    message += ` from ${packagePath.join(', ')}`;
  } else {
    vsceOptions.version = version;
    vsceOptions.gitTagVersion = false;

    if (isPreReleaseEnabled()) {
      vsceOptions.preRelease = true;
    }

    if (isTargetEnabled()) {
      const target = /** @type {string} */ (process.env.VSCE_TARGET);
      vsceOptions.targets = [target];
      ovsxOptions.targets = [target];
      message += ` for target ${target}`;
    }
  }

  const releases = [];
  if (isVscePublishEnabled()) {
    logger.log(message + ' to Visual Studio Marketplace');

    await vscePublish(vsceOptions);
    const vsceUrl = `https://marketplace.visualstudio.com/items?itemName=${publisher}.${name}`;

    logger.log(`The new version is available at ${vsceUrl}.`);
    releases.push({
      name: 'Visual Studio Marketplace',
      url: vsceUrl,
    });
  }

  if (isOvsxPublishEnabled()) {
    logger.log(message + ' to Open VSX Registry');

    // When publishing to OpenVSX, packagePath will be always set
    await ovsxPublish(ovsxOptions);
    const ovsxUrl = `https://open-vsx.org/extension/${publisher}/${name}/${version}`;

    logger.log(`The new ovsx version is available at ${ovsxUrl}`);
    releases.push({
      name: 'Open VSX Registry',
      url: ovsxUrl,
    });
  }

  // TODO: uncomment after https://github.com/semantic-release/semantic-release/issues/2123
  // return releases;
  return releases.shift();
}