semantic-release-vsce 5.6.3 → 5.7.0

package/.github/workflows/ci.yaml

@@ -17,13 +17,13 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - 14
           - 16
           - 18
+          - 20
 
     steps:
       - uses: actions/checkout@v4
-      - uses: volta-cli/action@v4.0.1
+      - uses: volta-cli/action@v4
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm ci
@@ -36,7 +36,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - uses: volta-cli/action@v4.0.1
+      - uses: volta-cli/action@v4
       - run: npm ci
       - run: npm run release
         env:

package/.github/workflows/validate-pr-title.yaml

@@ -11,6 +11,6 @@ jobs:
   validate-pr-title:
     runs-on: ubuntu-latest
     steps:
-      - uses: amannn/action-semantic-pull-request@v5.3.0
+      - uses: amannn/action-semantic-pull-request@v5
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.husky/pre-commit

@@ -1,5 +1,4 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
+# shellcheck shell=sh
 
 npx lint-staged
 npm test

package/README.md

@@ -88,6 +88,10 @@ Which `.vsix` file (or files) to publish. This controls what value will be used
 | `false`            | do not use a `.vsix` file to publish, which causes `vsce` to package the extension as part of the publish process |
 | a `string`         | publish the specified `.vsix` file(s). This can be a glob pattern, or a comma-separated list of files             |
 
+### `packageRoot`
+
+The directory of the extension relative to the current working directory. Defaults to `cwd`.
+
 ### Environment variables
 
 The following environment variables are supported by this plugin:
@@ -102,8 +106,7 @@ The following environment variables are supported by this plugin:
 
 You can set `vsce` options in the `package.json`, like:
 
-```jsonc
-// package.json
+```json
 {
   "vsce": {
     "baseImagesUrl": "https://my.custom/base/images/url",

package/index.js

@@ -1,5 +1,6 @@
 // @ts-check
 
+const path = require('path');
 const verifyVsce = require('./lib/verify');
 const vscePublish = require('./lib/publish');
 const vscePrepare = require('./lib/prepare');
@@ -9,6 +10,7 @@ let prepared = false;
 let packagePath;
 
 async function verifyConditions(pluginConfig, { logger, cwd }) {
+  cwd = getPackageRoot(pluginConfig, cwd);
   await verifyVsce(pluginConfig, { logger, cwd });
   verified = true;
 }
@@ -17,6 +19,7 @@ async function prepare(
   pluginConfig,
   { nextRelease: { version }, logger, cwd },
 ) {
+  cwd = getPackageRoot(pluginConfig, cwd);
   if (!verified) {
     await verifyVsce(pluginConfig, { logger, cwd });
     verified = true;
@@ -34,6 +37,7 @@ async function publish(
   pluginConfig,
   { nextRelease: { version }, logger, cwd },
 ) {
+  cwd = getPackageRoot(pluginConfig, cwd);
   if (!verified) {
     await verifyVsce(pluginConfig, { logger, cwd });
     verified = true;
@@ -63,6 +67,12 @@ async function publish(
   return vscePublish(version, packagePath, logger, cwd);
 }
 
+function getPackageRoot(pluginConfig, cwd) {
+  return pluginConfig.packageRoot
+    ? path.join(cwd, pluginConfig.packageRoot)
+    : cwd;
+}
+
 module.exports = {
   verifyConditions,
   prepare,

package/lib/prepare.js

@@ -2,6 +2,7 @@
 
 const execa = require('execa');
 const { readJson } = require('fs-extra');
+const path = require('path');
 const { isOvsxPublishEnabled, isTargetEnabled } = require('./utils');
 
 module.exports = async (version, packageVsix, logger, cwd) => {
@@ -23,7 +24,7 @@ module.exports = async (version, packageVsix, logger, cwd) => {
     if (typeof packageVsix === 'string') {
       packagePath = packageVsix;
     } else {
-      const { name } = await readJson('./package.json');
+      const { name } = await readJson(path.join(cwd, './package.json'));
       if (isTargetEnabled()) {
         packagePath = `${name}-${process.env.VSCE_TARGET}-${version}.vsix`;
       } else {

package/lib/publish.js

@@ -2,6 +2,7 @@
 
 const execa = require('execa');
 const { readJson } = require('fs-extra');
+const path = require('path');
 const {
   isOvsxPublishEnabled,
   isTargetEnabled,
@@ -9,7 +10,7 @@ const {
 } = require('./utils');
 
 module.exports = async (version, packagePath, logger, cwd) => {
-  const { publisher, name } = await readJson('./package.json');
+  const { publisher, name } = await readJson(path.join(cwd, './package.json'));
 
   const options = ['publish'];
 

package/lib/verify-pkg.js

@@ -3,11 +3,14 @@
 const SemanticReleaseError = require('@semantic-release/error');
 const { readJson } = require('fs-extra');
 const fs = require('fs');
+const path = require('path');
 
-module.exports = async () => {
-  if (!fs.existsSync('./package.json')) {
+module.exports = async (cwd) => {
+  const packagePath = path.join(cwd, './package.json');
+
+  if (!fs.existsSync(packagePath)) {
     throw new SemanticReleaseError(
-      'The `package.json` was not found. A `package.json` is required to release with vsce.',
+      `${packagePath} was not found. A \`package.json\` is required to release with vsce.`,
       'ENOPKG',
     );
   }
@@ -15,7 +18,7 @@ module.exports = async () => {
   let packageJson;
 
   try {
-    packageJson = await readJson('./package.json');
+    packageJson = await readJson(packagePath);
   } catch {
     throw new SemanticReleaseError(
       'The `package.json` seems to be invalid.',

package/lib/verify.js

@@ -8,7 +8,7 @@ const verifyTarget = require('./verify-target');
 const { isOvsxPublishEnabled, isVscePublishEnabled } = require('./utils');
 
 module.exports = async (pluginConfig, { logger, cwd }) => {
-  await verifyPkg();
+  await verifyPkg(cwd);
   await verifyTarget();
 
   if (pluginConfig?.publish !== false) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semantic-release-vsce",
-  "version": "5.6.3",
+  "version": "5.7.0",
   "description": "semantic-release plugin to package and publish VS Code extensions",
   "license": "MIT",
   "engines": {
@@ -25,7 +25,7 @@
     "release": "semantic-release",
     "test": "nyc ava",
     "posttest": "npm run lint && installed-check --engine-no-dev",
-    "prepare": "husky install"
+    "prepare": "husky"
   },
   "ava": {
     "files": [
@@ -43,8 +43,8 @@
     ]
   },
   "volta": {
-    "node": "18.18.0",
-    "npm": "9.8.1"
+    "node": "20.11.1",
+    "npm": "10.5.0"
   },
   "dependencies": {
     "@semantic-release/error": "^3.0.0",
@@ -58,22 +58,22 @@
     "semantic-release": ">=18"
   },
   "devDependencies": {
-    "ava": "^5.0.1",
-    "conventional-changelog-conventionalcommits": "^6.0.0",
+    "ava": "^6.1.2",
+    "conventional-changelog-conventionalcommits": "^7.0.2",
     "eslint": "^8.7.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.20.1",
-    "eslint-plugin-n": "^16.0.0",
+    "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-promise": "^6.0.0",
-    "husky": "^8.0.2",
+    "husky": "^9.0.11",
     "installed-check": "^8.0.0",
-    "lint-staged": "^14.0.0",
+    "lint-staged": "^15.0.1",
     "nyc": "^15.1.0",
-    "prettier": "3.0.3",
+    "prettier": "^3.2.5",
     "proxyquire": "^2.1.3",
-    "semantic-release": "^21.0.1",
-    "sinon": "^16.0.0"
+    "semantic-release": "^23.0.2",
+    "sinon": "^17.0.1"
   },
   "lint-staged": {
     "**/*": "prettier --write --ignore-unknown"

package/test/index.test.js

@@ -229,3 +229,33 @@ test('expand globs if publishPackagePath is set', async (t) => {
     semanticReleasePayload.cwd,
   ]);
 });
+
+test('publishes an extension in a non-root folder', async (t) => {
+  const { verifyVsceStub, vscePrepareStub, vscePublishStub } = t.context.stubs;
+  const { publish } = proxyquire('../index.js', {
+    './lib/verify': verifyVsceStub,
+    './lib/publish': vscePublishStub,
+    './lib/prepare': vscePrepareStub,
+    glob: {
+      glob: {
+        sync: sinon.stub().returns(['package1.vsix', 'package2.vsix']),
+      },
+    },
+  });
+
+  const pluginConfig = {
+    packageRoot: './vscode-extension',
+  };
+  const resolvedCwd = `${semanticReleasePayload.cwd}/vscode-extension`;
+
+  await publish(pluginConfig, semanticReleasePayload);
+
+  t.true(verifyVsceStub.calledOnce);
+  t.true(vscePrepareStub.calledOnce);
+  t.deepEqual(vscePublishStub.getCall(0).args, [
+    semanticReleasePayload.nextRelease.version,
+    undefined,
+    semanticReleasePayload.logger,
+    resolvedCwd,
+  ]);
+});

package/test/verify-pkg.test.js

@@ -3,6 +3,8 @@ const test = require('ava');
 const proxyquire = require('proxyquire');
 const SemanticReleaseError = require('@semantic-release/error');
 
+const cwd = process.cwd();
+
 test('package.json is found', async (t) => {
   const name = 'test';
   const publisher = 'tester';
@@ -19,7 +21,7 @@ test('package.json is found', async (t) => {
     },
   });
 
-  await t.notThrowsAsync(() => verifyPkg());
+  await t.notThrowsAsync(() => verifyPkg(cwd));
 });
 
 test('package.json is not found', async (t) => {
@@ -38,7 +40,7 @@ test('package.json is not found', async (t) => {
     },
   });
 
-  await t.throwsAsync(() => verifyPkg(), {
+  await t.throwsAsync(() => verifyPkg(cwd), {
     instanceOf: SemanticReleaseError,
     code: 'ENOPKG',
   });
@@ -59,7 +61,7 @@ test('package is valid', async (t) => {
     },
   });
 
-  await t.notThrowsAsync(() => verifyPkg());
+  await t.notThrowsAsync(() => verifyPkg(cwd));
 });
 
 test('package is invalid', async (t) => {
@@ -72,7 +74,7 @@ test('package is invalid', async (t) => {
     },
   });
 
-  await t.throwsAsync(() => verifyPkg(), {
+  await t.throwsAsync(() => verifyPkg(cwd), {
     instanceOf: SemanticReleaseError,
     code: 'EINVALIDPKG',
   });
@@ -91,7 +93,7 @@ test('package is missing name', async (t) => {
     },
   });
 
-  await t.throwsAsync(() => verifyPkg(), {
+  await t.throwsAsync(() => verifyPkg(cwd), {
     instanceOf: SemanticReleaseError,
     code: 'ENOPKGNAME',
   });
@@ -110,7 +112,7 @@ test('package is missing publisher', async (t) => {
     },
   });
 
-  await t.throwsAsync(() => verifyPkg(), {
+  await t.throwsAsync(() => verifyPkg(cwd), {
     instanceOf: SemanticReleaseError,
     code: 'ENOPUBLISHER',
   });