feat: support publishing to Open VSX (#169)

Fixes #62

Author: felipecrs

README.md

@@ -47,6 +47,16 @@ It is recommended to upload this to your GitHub release page so your users can e
 
 If `yarn` is set to `true`, will use `--yarn`option for `vsce package` and `vsce publish`.
 
+#### Publishing to OpenVSX
+
+Publishing extensions to OpenVSX using this plugin is easy:
+
+1. Get a valid personal access token with the correct privileges to the publisher namespace in OpenVSX. In order to get the personal access token, check this [page](https://github.com/eclipse/openvsx/wiki).
+
+2. Configure the `OVSX_PAT` environment variable in your CI with the token that you created.
+
+3. Enjoy! The plugin will automatically detect the environment variable and it will publish to OpenVSX, no additional configuration is needed.
+
 #### Working with older versions
 
 This example is for `semantic-release` v15.  

lib/prepare.js

@@ -1,8 +1,14 @@
 const execa = require('execa');
 const { readJson } = require('fs-extra');
+const { isOvsxEnabled } = require('./verify-ovsx-auth');
 
 module.exports = async (version, packageVsix, yarn, logger) => {
-  if (packageVsix) {
+  const ovsxEnabled = isOvsxEnabled();
+  if (packageVsix || ovsxEnabled) {
+    if (!packageVsix && ovsxEnabled) {
+      logger.log('Packaging to VSIX even though `packageVsix` is not set as publish to OpenVSX is enabled.');
+    }
+
     let packagePath;
 
     if (typeof packageVsix === 'string') {

lib/publish.js

@@ -1,5 +1,6 @@
 const execa = require('execa');
 const { readJson } = require('fs-extra');
+const { isOvsxEnabled } = require('./verify-ovsx-auth');
 
 module.exports = async (version, packagePath, yarn, logger) => {
   const { publisher, name } = await readJson('./package.json');
@@ -20,10 +21,30 @@ module.exports = async (version, packagePath, yarn, logger) => {
 
   await execa('vsce', options, { stdio: 'inherit' });
 
-  const url = `https://marketplace.visualstudio.com/items?itemName=${publisher}.${name}`;
-  logger.log(`The new version is available at ${url}`);
-  return {
+  const vsceUrl = `https://marketplace.visualstudio.com/items?itemName=${publisher}.${name}`;
+  logger.log(`The new version is available at ${vsceUrl}.`);
+
+  const vsceRelease = {
     name: 'Visual Studio Marketplace',
-    url
+    url: vsceUrl
   };
+
+  if (isOvsxEnabled()) {
+    logger.log('Now publishing to OpenVSX');
+
+    await execa('ovsx', ['publish', packagePath], { stdio: 'inherit' });
+
+    // TODO: uncomment after https://github.com/semantic-release/semantic-release/issues/2123
+    // const ovsxUrl = `https://open-vsx.org/extension/${publisher}/${name}/${version}`;
+    // const ovsxRelease = {
+    //   name: 'Open VSX Registry',
+    //   url: ovsxUrl
+    // };
+
+    // const releases = [vsceRelease, ovsxRelease];
+
+    // return releases;
+  }
+
+  return vsceRelease;
 };

lib/verify-ovsx-auth.js

@@ -0,0 +1,27 @@
+const SemanticReleaseError = require('@semantic-release/error');
+
+const isOvsxEnabled = () => {
+  return 'OVSX_PAT' in process.env;
+};
+
+module.exports = async (logger) => {
+  logger.log('Verifying authentication for ovsx');
+
+  if (!isOvsxEnabled()) {
+    logger.log('Skipping verification of ovsx personal token because the `OVSX_PAT` environment variable is not set.\n\nDid you know you can easily start publishing to OpenVSX with `semantic-release-vsce`?\nLearn more at https://github.com/felipecrs/semantic-release-vsce#publishing-to-openvsx');
+    return;
+  }
+
+  if (!process.env.OVSX_PAT) {
+    throw new SemanticReleaseError('Empty ovsx personal access token specified.', 'EINVALIDOVSXPAT');
+  }
+
+  // TODO: waiting for https://github.com/eclipse/openvsx/issues/313
+  // try {
+  //   await execa('ovsx', ['verify-pat']);
+  // } catch (e) {
+  //   throw new SemanticReleaseError(`Invalid ovsx personal access token. Additional information:\n\n${e}`, 'EINVALIDOVSXPAT');
+  // }
+};
+
+module.exports.isOvsxEnabled = isOvsxEnabled;

lib/verify.js

@@ -1,8 +1,11 @@
 const verifyPkg = require('./verify-pkg');
 const verifyAuth = require('./verify-auth');
+const verifyOvsxAuth = require('./verify-ovsx-auth');
 
 module.exports = async logger => {
   await verifyPkg();
 
   await verifyAuth(logger);
+
+  await verifyOvsxAuth(logger);
 };

package-lock.json

@@ -48,13 +48,14 @@
     "preset": "conventionalcommits"
   },
   "volta": {
-    "node": "14.17.4",
-    "npm": "7.20.3"
+    "node": "14.17.6",
+    "npm": "7.23.0"
   },
   "dependencies": {
     "@semantic-release/error": "^2.2.0",
     "execa": "^5.0.0",
     "fs-extra": "^10.0.0",
+    "ovsx": "^0.2.0",
     "vsce": "^1.96.1"
   },
   "peerDependencies": {

package.json

@@ -102,3 +102,30 @@ test('packageVsix is true and yarn is true', async t => {
   t.deepEqual(result, packagePath);
   t.deepEqual(execaStub.getCall(0).args, ['vsce', ['package', version, '--no-git-tag-version', '--out', packagePath, '--yarn'], { stdio: 'inherit' }]);
 });
+
+test('packageVsix is not set but OVSX_PAT is', async t => {
+  const { execaStub } = t.context.stubs;
+  const name = 'test';
+
+  const prepare = proxyquire('../lib/prepare', {
+    execa: execaStub,
+    'fs-extra': {
+      readJson: sinon.stub().returns({
+        name
+      })
+    }
+  });
+
+  sinon.stub(process, 'env').value({
+    OVSX_PAT: 'abc123'
+  });
+
+  const version = '1.0.0';
+  const packageVsix = undefined;
+  const packagePath = `${name}-${version}.vsix`;
+
+  const result = await prepare(version, packageVsix, undefined, logger);
+
+  t.deepEqual(result, packagePath);
+  t.deepEqual(execaStub.getCall(0).args, ['vsce', ['package', version, '--no-git-tag-version', '--out', packagePath], { stdio: 'inherit' }]);
+});

test/prepare.test.js

@@ -32,7 +32,9 @@ test('publish', async t => {
 
   const version = '1.0.0';
   const token = 'abc123';
-  process.env.VSCE_TOKEN = token;
+  sinon.stub(process, 'env').value({
+    VSCE_PAT: token
+  });
   const result = await publish(version, undefined, undefined, logger);
 
   t.deepEqual(result, {
@@ -59,7 +61,9 @@ test('publish with packagePath', async t => {
   const version = '1.0.0';
   const packagePath = 'test.vsix';
   const token = 'abc123';
-  process.env.VSCE_TOKEN = token;
+  sinon.stub(process, 'env').value({
+    VSCE_PAT: token
+  });
   const result = await publish(version, packagePath, undefined, logger);
 
   t.deepEqual(result, {
@@ -85,7 +89,9 @@ test('publish when yarn is true', async t => {
 
   const version = '1.0.0';
   const token = 'abc123';
-  process.env.VSCE_TOKEN = token;
+  sinon.stub(process, 'env').value({
+    VSCE_PAT: token
+  });
   const yarn = true;
   const result = await publish(version, undefined, yarn, logger);
 
@@ -112,8 +118,10 @@ test('publish with VSCE_PAT and VSCE_TOKEN should prefer VSCE_PAT', async t => {
 
   const version = '1.0.0';
   const token = 'abc123';
-  process.env.VSCE_TOKEN = token;
-  process.env.VSCE_PAT = token;
+  sinon.stub(process, 'env').value({
+    VSCE_PAT: token,
+    VSCE_TOKEN: token
+  });
   const result = await publish(version, undefined, undefined, logger);
 
   t.deepEqual(result, {
@@ -122,3 +130,39 @@ test('publish with VSCE_PAT and VSCE_TOKEN should prefer VSCE_PAT', async t => {
   });
   t.deepEqual(execaStub.getCall(0).args, ['vsce', ['publish', version, '--no-git-tag-version'], { stdio: 'inherit' }]);
 });
+
+test('publish to OpenVSX', async t => {
+  const { execaStub } = t.context.stubs;
+  const publisher = 'semantic-release-vsce';
+  const name = 'Semantice Release VSCE';
+  const publish = proxyquire('../lib/publish', {
+    execa: execaStub,
+    'fs-extra': {
+      readJson: sinon.stub().returns({
+        publisher,
+        name
+      })
+    }
+  });
+
+  const version = '1.0.0';
+  const packagePath = 'test.vsix';
+  const token = 'abc123';
+  sinon.stub(process, 'env').value({
+    OVSX_PAT: token,
+    VSCE_TOKEN: token
+  });
+  const result = await publish(version, packagePath, undefined, logger);
+
+  t.deepEqual(result, {
+    name: 'Visual Studio Marketplace',
+    url: `https://marketplace.visualstudio.com/items?itemName=${publisher}.${name}`
+  });
+  t.deepEqual(execaStub.getCall(0).args, ['vsce', ['publish', '--packagePath', packagePath], { stdio: 'inherit' }]);
+
+  // t.deepEqual(result[1], {
+  //   name: 'Open VSX Registry',
+  //   url: `https://open-vsx.org/extension/${publisher}/${name}/${version}`
+  // });
+  t.deepEqual(execaStub.getCall(1).args, ['ovsx', ['publish', packagePath], { stdio: 'inherit' }]);
+});

test/publish.test.js

@@ -0,0 +1,27 @@
+const test = require('ava');
+const sinon = require('sinon');
+const SemanticReleaseError = require('@semantic-release/error');
+
+const logger = {
+  log: sinon.fake()
+};
+
+test('OVSX_PAT is set', async t => {
+  sinon.stub(process, 'env').value({
+    OVSX_PAT: 'abc123'
+  });
+
+  const verifyOvsxAuth = require('../lib/verify-ovsx-auth');
+
+  await t.notThrowsAsync(() => verifyOvsxAuth(logger));
+});
+
+test('OVSX_PAT is invalid', async t => {
+  sinon.stub(process, 'env').value({
+    OVSX_PAT: ''
+  });
+
+  const verifyOvsxAuth = require('../lib/verify-ovsx-auth');
+
+  await t.throwsAsync(() => verifyOvsxAuth(logger), { instanceOf: SemanticReleaseError, code: 'EINVALIDOVSXPAT' });
+});