semantic-release-vsce 3.4.1 → 5.0.0

package/.github/dependabot.yml

@@ -5,6 +5,7 @@ updates:
     schedule:
       interval: daily
     open-pull-requests-limit: 100
+    target-branch: next
   - package-ecosystem: github-actions
     directory: /
     schedule:

package/.github/workflows/ci.yaml

@@ -4,9 +4,11 @@ on:
   push:
     branches:
       - master
+      - next
   pull_request:
     branches:
       - master
+      - next
 
 jobs:
   test:
@@ -15,9 +17,8 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - 10
-          - 12
           - 14
+          - 16
 
     steps:
       - uses: actions/checkout@v2

package/README.md

@@ -45,7 +45,15 @@ Use `semantic-release-vsce` as part of `verifyConditions` and `publish`.
 If `packageVsix` is set, will also generate a .vsix file at the set file path after publishing. If is a string, it will be used as value for `--out` of `vsce package`.
 It is recommended to upload this to your GitHub release page so your users can easily rollback to an earlier version if a version ever introduces a bad bug. 
 
-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
 

package/index.js

@@ -16,7 +16,7 @@ async function prepare (pluginConfig, { nextRelease: { version }, logger }) {
     await verifyVsce(logger);
     verified = true;
   }
-  packagePath = await vscePrepare(version, pluginConfig.packageVsix, pluginConfig.yarn, logger);
+  packagePath = await vscePrepare(version, pluginConfig.packageVsix, logger);
   prepared = true;
 }
 
@@ -28,9 +28,9 @@ async function publish (pluginConfig, { nextRelease: { version }, logger }) {
 
   if (!prepared) {
     // BC: prior to semantic-release v15 prepare was part of publish
-    packagePath = await vscePrepare(version, pluginConfig.packageVsix, pluginConfig.yarn, logger);
+    packagePath = await vscePrepare(version, pluginConfig.packageVsix, logger);
   }
-  return vscePublish(version, packagePath, pluginConfig.yarn, logger);
+  return vscePublish(version, packagePath, logger);
 }
 
 module.exports = {

package/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, logger) => {
+  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.');
+    }
 
-module.exports = async (version, packageVsix, yarn, logger) => {
-  if (packageVsix) {
     let packagePath;
 
     if (typeof packageVsix === 'string') {
@@ -16,10 +22,6 @@ module.exports = async (version, packageVsix, yarn, logger) => {
 
     const options = ['package', version, '--no-git-tag-version', '--out', packagePath];
 
-    if (yarn) {
-      options.push('--yarn');
-    }
-
     await execa('vsce', options, { stdio: 'inherit' });
 
     return packagePath;

package/lib/publish.js

@@ -1,7 +1,8 @@
 const execa = require('execa');
 const { readJson } = require('fs-extra');
+const { isOvsxEnabled } = require('./verify-ovsx-auth');
 
-module.exports = async (version, packagePath, yarn, logger) => {
+module.exports = async (version, packagePath, logger) => {
   const { publisher, name } = await readJson('./package.json');
 
   const options = ['publish'];
@@ -14,16 +15,32 @@ module.exports = async (version, packagePath, yarn, logger) => {
     options.push(...[version, '--no-git-tag-version']);
   }
 
-  if (yarn) {
-    options.push('--yarn');
-  }
-
   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;
 };

package/lib/verify-auth.js

@@ -4,11 +4,6 @@ const SemanticReleaseError = require('@semantic-release/error');
 module.exports = async (logger) => {
   logger.log('Verifying authentication for vsce');
 
-  if (!('VSCE_PAT' in process.env) && ('VSCE_TOKEN' in process.env)) {
-    logger.log('VSCE_TOKEN is deprecated and may be removed in the next major release, please use VSCE_PAT instead.');
-    process.env.VSCE_PAT = process.env.VSCE_TOKEN;
-  }
-
   if (!process.env.VSCE_PAT) {
     throw new SemanticReleaseError('No vsce personal access token specified (set the `VSCE_PAT` environment variable).', 'ENOVSCEPAT');
   }

package/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;

package/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/package.json

@@ -1,10 +1,10 @@
 {
   "name": "semantic-release-vsce",
-  "version": "3.4.1",
+  "version": "5.0.0",
   "description": "semantic-release plugin to package and publish VS Code extensions",
   "license": "MIT",
   "engines": {
-    "node": ">=10.18"
+    "node": ">=14"
   },
   "repository": "https://github.com/felipecrs/semantic-release-vsce.git",
   "bugs": "https://github.com/felipecrs/semantic-release-vsce/issues",
@@ -48,33 +48,33 @@
     "preset": "conventionalcommits"
   },
   "volta": {
-    "node": "14.17.0",
-    "npm": "7.17.0"
+    "node": "16.13.2",
+    "npm": "8.3.1"
   },
   "dependencies": {
-    "@semantic-release/error": "^2.2.0",
+    "@semantic-release/error": "^3.0.0",
     "execa": "^5.0.0",
     "fs-extra": "^10.0.0",
-    "vsce": "^1.93.0"
+    "ovsx": "^0.2.0",
+    "vsce": "^2.6.3"
   },
   "peerDependencies": {
-    "semantic-release": ">=16.0.0"
+    "semantic-release": ">=18"
   },
   "devDependencies": {
-    "@commitlint/cli": "^12.0.0",
-    "@commitlint/config-conventional": "^12.0.0",
-    "ava": "^3.9.0",
+    "@commitlint/cli": "^16.0.2",
+    "@commitlint/config-conventional": "^16.0.0",
+    "ava": "^4.0.1",
     "conventional-changelog-conventionalcommits": "^4.2.1",
-    "eslint": "^7.19.0",
-    "eslint-config-standard": "^16.0.2",
+    "eslint": "^8.7.0",
+    "eslint-config-standard": "^17.0.0-0",
     "eslint-plugin-import": "^2.20.1",
-    "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-promise": "^5.1.0",
-    "eslint-plugin-standard": "^5.0.0",
-    "husky": "^6.0.0",
+    "eslint-plugin-n": "^14.0.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "husky": "^7.0.4",
     "nyc": "^15.1.0",
     "proxyquire": "^2.1.3",
-    "semantic-release": "^17.0.3",
-    "sinon": "^10.0.0"
+    "semantic-release": "^19.0.2",
+    "sinon": "^12.0.1"
   }
 }

package/test/index.test.js

@@ -12,8 +12,7 @@ const semanticReleasePayload = {
 };
 
 const pluginConfig = {
-  packageVsix: 'test.vsix',
-  yarn: undefined
+  packageVsix: 'test.vsix'
 };
 
 test.beforeEach(t => {
@@ -58,7 +57,6 @@ test('prepare and unverified', async t => {
   t.deepEqual(vscePrepareStub.getCall(0).args, [
     semanticReleasePayload.nextRelease.version,
     pluginConfig.packageVsix,
-    pluginConfig.yarn,
     semanticReleasePayload.logger
   ]);
 });
@@ -78,7 +76,6 @@ test('prepare and verified', async t => {
   t.deepEqual(vscePrepareStub.getCall(0).args, [
     semanticReleasePayload.nextRelease.version,
     pluginConfig.packageVsix,
-    pluginConfig.yarn,
     semanticReleasePayload.logger
   ]);
 });
@@ -98,7 +95,6 @@ test('publish that is unverified and unprepared', async t => {
   t.deepEqual(vscePublishStub.getCall(0).args, [
     semanticReleasePayload.nextRelease.version,
     undefined,
-    pluginConfig.yarn,
     semanticReleasePayload.logger
   ]);
 });
@@ -119,7 +115,6 @@ test('publish that is verified but unprepared', async t => {
   t.deepEqual(vscePublishStub.getCall(0).args, [
     semanticReleasePayload.nextRelease.version,
     undefined,
-    pluginConfig.yarn,
     semanticReleasePayload.logger
   ]);
 });
@@ -141,7 +136,6 @@ test('publish that is already verified & prepared', async t => {
   t.deepEqual(vscePublishStub.getCall(0).args, [
     semanticReleasePayload.nextRelease.version,
     packagePath,
-    pluginConfig.yarn,
     semanticReleasePayload.logger
   ]);
 });

package/test/prepare.test.js

@@ -23,20 +23,7 @@ test('packageVsix is not specified', async t => {
   });
 
   const version = '1.0.0';
-  await prepare(version, undefined, undefined, logger);
-
-  t.true(execaStub.notCalled);
-});
-
-test('packageVsix is not specified but yarn is true', async t => {
-  const { execaStub } = t.context.stubs;
-  const prepare = proxyquire('../lib/prepare', {
-    execa: execaStub
-  });
-
-  const version = '1.0.0';
-  const yarn = true;
-  await prepare(version, undefined, yarn, logger);
+  await prepare(version, undefined, logger);
 
   t.true(execaStub.notCalled);
 });
@@ -50,7 +37,7 @@ test('packageVsix is a string', async t => {
   const version = '1.0.0';
   const packageVsix = 'test.vsix';
   const packagePath = packageVsix;
-  const result = await prepare(version, packageVsix, undefined, logger);
+  const result = await prepare(version, packageVsix, logger);
 
   t.deepEqual(result, packagePath);
   t.deepEqual(execaStub.getCall(0).args, ['vsce', ['package', version, '--no-git-tag-version', '--out', packagePath], { stdio: 'inherit' }]);
@@ -73,13 +60,13 @@ test('packageVsix is true', async t => {
   const packageVsix = true;
   const packagePath = `${name}-${version}.vsix`;
 
-  const result = await prepare(version, packageVsix, undefined, logger);
+  const result = await prepare(version, packageVsix, logger);
 
   t.deepEqual(result, packagePath);
   t.deepEqual(execaStub.getCall(0).args, ['vsce', ['package', version, '--no-git-tag-version', '--out', packagePath], { stdio: 'inherit' }]);
 });
 
-test('packageVsix is true and yarn is true', async t => {
+test('packageVsix is not set but OVSX_PAT is', async t => {
   const { execaStub } = t.context.stubs;
   const name = 'test';
 
@@ -92,13 +79,16 @@ test('packageVsix is true and yarn is true', async t => {
     }
   });
 
+  sinon.stub(process, 'env').value({
+    OVSX_PAT: 'abc123'
+  });
+
   const version = '1.0.0';
-  const packageVsix = true;
-  const yarn = true;
+  const packageVsix = undefined;
   const packagePath = `${name}-${version}.vsix`;
 
-  const result = await prepare(version, packageVsix, yarn, logger);
+  const result = await prepare(version, packageVsix, logger);
 
   t.deepEqual(result, packagePath);
-  t.deepEqual(execaStub.getCall(0).args, ['vsce', ['package', version, '--no-git-tag-version', '--out', packagePath, '--yarn'], { stdio: 'inherit' }]);
+  t.deepEqual(execaStub.getCall(0).args, ['vsce', ['package', version, '--no-git-tag-version', '--out', packagePath], { stdio: 'inherit' }]);
 });

package/test/publish.test.js

@@ -32,8 +32,10 @@ test('publish', async t => {
 
   const version = '1.0.0';
   const token = 'abc123';
-  process.env.VSCE_TOKEN = token;
-  const result = await publish(version, undefined, undefined, logger);
+  sinon.stub(process, 'env').value({
+    VSCE_PAT: token
+  });
+  const result = await publish(version, undefined, logger);
 
   t.deepEqual(result, {
     name: 'Visual Studio Marketplace',
@@ -59,8 +61,10 @@ test('publish with packagePath', async t => {
   const version = '1.0.0';
   const packagePath = 'test.vsix';
   const token = 'abc123';
-  process.env.VSCE_TOKEN = token;
-  const result = await publish(version, packagePath, undefined, logger);
+  sinon.stub(process, 'env').value({
+    VSCE_PAT: token
+  });
+  const result = await publish(version, packagePath, logger);
 
   t.deepEqual(result, {
     name: 'Visual Studio Marketplace',
@@ -69,7 +73,7 @@ test('publish with packagePath', async t => {
   t.deepEqual(execaStub.getCall(0).args, ['vsce', ['publish', '--packagePath', packagePath], { stdio: 'inherit' }]);
 });
 
-test('publish when yarn is true', async t => {
+test('publish to OpenVSX', async t => {
   const { execaStub } = t.context.stubs;
   const publisher = 'semantic-release-vsce';
   const name = 'Semantice Release VSCE';
@@ -84,41 +88,23 @@ test('publish when yarn is true', async t => {
   });
 
   const version = '1.0.0';
+  const packagePath = 'test.vsix';
   const token = 'abc123';
-  process.env.VSCE_TOKEN = token;
-  const yarn = true;
-  const result = await publish(version, undefined, yarn, logger);
-
-  t.deepEqual(result, {
-    name: 'Visual Studio Marketplace',
-    url: `https://marketplace.visualstudio.com/items?itemName=${publisher}.${name}`
+  sinon.stub(process, 'env').value({
+    OVSX_PAT: token,
+    VSCE_PAT: token
   });
-  t.deepEqual(execaStub.getCall(0).args, ['vsce', ['publish', version, '--no-git-tag-version', '--yarn'], { stdio: 'inherit' }]);
-});
-
-test('publish with VSCE_PAT and VSCE_TOKEN should prefer VSCE_PAT', 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 token = 'abc123';
-  process.env.VSCE_TOKEN = token;
-  process.env.VSCE_PAT = token;
-  const result = await publish(version, undefined, undefined, logger);
+  const result = await publish(version, packagePath, 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', version, '--no-git-tag-version'], { stdio: 'inherit' }]);
+  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' }]);
 });

package/test/verify-auth.test.js

@@ -7,28 +7,6 @@ const logger = {
   log: sinon.fake()
 };
 
-test('VSCE_TOKEN is set', async t => {
-  sinon.stub(process, 'env').value({
-    VSCE_TOKEN: 'abc123'
-  });
-
-  const verifyAuth = proxyquire('../lib/verify-auth', {
-    execa: sinon.stub().withArgs('vsce', ['verify-pat']).resolves()
-  });
-
-  await t.notThrowsAsync(() => verifyAuth(logger));
-});
-
-test('VSCE_TOKEN is not set', async t => {
-  sinon.stub(process, 'env').value({});
-
-  const verifyAuth = proxyquire('../lib/verify-auth', {
-    execa: sinon.stub().withArgs('vsce', ['verify-pat']).resolves()
-  });
-
-  await t.throwsAsync(() => verifyAuth(logger), { instanceOf: SemanticReleaseError, code: 'ENOVSCEPAT' });
-});
-
 test('VSCE_PAT is set', async t => {
   sinon.stub(process, 'env').value({
     VSCE_PAT: 'abc123'
@@ -51,30 +29,6 @@ test('VSCE_PAT is not set', async t => {
   await t.throwsAsync(() => verifyAuth(logger), { instanceOf: SemanticReleaseError, code: 'ENOVSCEPAT' });
 });
 
-test('VSCE_TOKEN is valid', async t => {
-  sinon.stub(process, 'env').value({
-    VSCE_TOKEN: 'abc123'
-  });
-
-  const verifyAuth = proxyquire('../lib/verify-auth', {
-    execa: sinon.stub().withArgs('vsce', ['verify-pat']).resolves()
-  });
-
-  await t.notThrowsAsync(() => verifyAuth(logger));
-});
-
-test('VSCE_TOKEN is invalid', async t => {
-  sinon.stub(process, 'env').value({
-    VSCE_TOKEN: 'abc123'
-  });
-
-  const verifyAuth = proxyquire('../lib/verify-auth', {
-    execa: sinon.stub().withArgs('vsce', ['verify-pat']).rejects()
-  });
-
-  await t.throwsAsync(() => verifyAuth(logger), { instanceOf: SemanticReleaseError, code: 'EINVALIDVSCETOKEN' });
-});
-
 test('VSCE_PAT is valid', async t => {
   sinon.stub(process, 'env').value({
     VSCE_PAT: 'abc123'

package/test/verify-ovsx-auth.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' });
+});