use vsce --pre-release to publish pre-release builds

Author: znck

.github/workflows-source/ci.yaml

@@ -30,13 +30,13 @@ on:
   - name: Setup Node
     uses: actions/setup-node@v2
     with:
-      node-version: '14'
+      node-version: "14"
 
 .pnpm: &pnpm
   - name: Setup PNPM
     uses: pnpm/[email protected]
     with:
-      version: '6.2.5'
+      version: "6.2.5"
       run_install: |
         - recursive: true
           args: [--frozen-lockfile]
@@ -52,7 +52,7 @@ on:
     uses: actions/download-artifact@v2
     with:
       name: build-artefact
-      path: '.'
+      path: "."
 
 concurrency:
   group: build-${{ github.ref }}
@@ -81,11 +81,11 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
-        node_version: ['12', '14']
+        node_version: ["12", "14"]
         include:
           - os: ubuntu-latest
-            node: '14'
-            command: 'coverage'
+            node: "14"
+            command: "coverage"
     runs-on: ${{ matrix.os }}
     name: Node ${{ matrix.node_version }} on ${{ matrix.os }}
     continue-on-error: ${{ startsWith(github.event.head_commit.message, 'release:') }}
@@ -106,41 +106,30 @@ jobs:
         with:
           file: ./coverage/coverage-final.json
 
-  insiders:
-    name: Insiders Release
+  pre-release:
+    name: Pre-release
     runs-on: ubuntu-latest
-    environment:
-      name: Insiders
-      url: https://marketplace.visualstudio.com/items?itemName=znck.preview-insiders
     needs: unit
     concurrency:
-      group: insiders
+      group: pre-release
       cancel-in-progress: true
     steps:
       - *setup
       - *download
-      - name: Publish Insiders Extension
+      - name: Publish Pre-release Extension
         run: |
-          pnpm recursive --filter ./extension run release
+          pnpm recursive --filter ./extension run build
+          pnpm recursive --filter ./extension run pre-release
         env:
-          RELEASE_CHANNEL: insiders
+          RELEASE_CHANNEL: pre-release
           VSCODE_MARKETPLACE_TOKEN: ${{ secrets.VSCODE_MARKETPLACE_TOKEN }}
-      - name: Publish Insiders Packages
+      - name: Publish Pre-release Packages
         run: |
           echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > .npmrc
-          pnpm recursive --filter ./packages exec -- npm version prerelease --preid=insiders-$(date +%s)
-          pnpm recursive --filter ./packages publish --tag insiders --access public --no-git-checks
+          pnpm recursive --filter ./packages exec -- npm version prerelease --preid=next-$(date +%s)
+          pnpm recursive --filter ./packages publish --tag next --access public --no-git-checks
         env:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - uses: 'marvinpinto/action-automatic-releases@latest'
-        with:
-          repo_token: '${{ secrets.GITHUB_TOKEN }}'
-          automatic_release_tag: 'insiders'
-          prerelease: true
-          files: |
-            extension/CHANGELOG.md
-            extension/preview.vsix
-            packages/*/CHANGELOG.md
 
   check_release:
     name: Check Release
@@ -175,13 +164,12 @@ jobs:
         env:
           VSCODE_MARKETPLACE_TOKEN: ${{ secrets.VSCODE_MARKETPLACE_TOKEN }}
         continue-on-error: true
-      - uses: 'marvinpinto/action-automatic-releases@latest'
+      - uses: "marvinpinto/action-automatic-releases@latest"
         with:
-          repo_token: '${{ secrets.GITHUB_TOKEN }}'
-          automatic_release_tag: 'latest'
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          automatic_release_tag: "latest"
           prerelease: false
           files: |
             extension/CHANGELOG.md
             extension/preview.vsix
             packages/*/CHANGELOG.md
-

extension/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Rahul Kadyan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

extension/package.json

@@ -1,9 +1,10 @@
 {
   "private": true,
-  "version": "0.4.0",
+  "version": "0.4.1",
   "name": "preview",
   "publisher": "znck",
-  "displayName": "Preview - VueDX",
+  "displayName": "Preview",
+  "description": "A storyboarding and prototyping tool for Vue.",
   "main": "dist/extension.js",
   "icon": "logo.png",
   "buildConfig": {
@@ -135,22 +136,21 @@
     "znck.vue"
   ],
   "engines": {
-    "vscode": "^1.52.0"
+    "vscode": "^1.63.0"
   },
   "devDependencies": {
     "@types/node": "^14.14.22",
     "@types/node-fetch": "^2.5.8",
-    "@types/vscode": "^1.52.0",
+    "@types/vscode": "^1.63.0",
     "@vuedx/preview": "workspace:*",
     "get-port": "^5.1.1",
-    "node-fetch": "^2.6.1",
-    "vsce": "^1.84.0"
+    "node-fetch": "^3.2.0",
+    "semver": "^7.3.5",
+    "vsce": "^2.6.7"
   },
   "scripts": {
-    "prerelease": "npm run bundle",
+    "build": "node scripts/build.mjs",
     "release": "vsce publish -p ${VSCODE_MARKETPLACE_TOKEN} --packagePath ./preview.vsix",
-    "prebundle": "node scripts/prepare",
-    "bundle": "vsce package --out preview.vsix",
-    "postbundle": "node scripts/revert"
+    "pre-release": "vsce publish --pre-release -p ${VSCODE_MARKETPLACE_TOKEN} --packagePath ./preview.vsix"
   }
 }

extension/scripts/build.mjs

@@ -0,0 +1,160 @@
+import { execSync } from 'child_process';
+import fetch, { Headers } from 'node-fetch';
+import FS from 'node:fs';
+import Path from 'node:path';
+import semver from 'semver';
+import { fileURLToPath } from 'url';
+
+/**
+ * @param {string} itemName
+ */
+async function findLatestVersion(itemName) {
+  const response = await fetch(
+    'https://marketplace.visualstudio.com/_apis/public/gallery/extensionquery',
+    {
+      method: 'POST',
+      headers: new Headers({
+        Accept: 'application/json;api-version=7.1-preview.1;excludeUrls=true',
+        'Content-Type': 'application/json',
+      }),
+      body: JSON.stringify({
+        assetTypes: null,
+        filters: [
+          {
+            criteria: [{ filterType: 7, value: itemName }],
+            direction: 2,
+            pageSize: 100,
+            pageNumber: 1,
+            sortBy: 0,
+            sortOrder: 0,
+            pagingToken: null,
+          },
+        ],
+        flags: 2151,
+      }),
+    }
+  );
+
+  const body =
+    /** @type {{results: Array<{extensions: Array<{versions: Array<{version: string}>}>}>}} */ (
+      await response.json()
+    );
+
+  const extension = body.results
+    .flatMap((result) => result.extensions)
+    .find((extension) => extension != null);
+
+  if (extension != null) return extension.versions[0]?.version;
+
+  return undefined;
+}
+
+const fileNames = ['package.json'];
+export function getDir() {
+  const arg = process.argv[2] ?? process.cwd();
+  const dir = Path.isAbsolute(arg) ? arg : Path.resolve(process.cwd(), arg);
+  return dir;
+}
+
+/**
+ * @param {string} dir
+ */
+function backup(dir) {
+  for (const fileName of fileNames) {
+    const file = Path.resolve(dir, fileName);
+    const fileBak = Path.resolve(dir, `${fileName}.bak`);
+
+    FS.writeFileSync(fileBak, FS.readFileSync(file, 'utf-8'));
+  }
+}
+
+/**
+ * @param {string} dir
+ */
+function revert(dir) {
+  for (const fileName of fileNames) {
+    const file = Path.resolve(dir, fileName);
+    const fileBak = Path.resolve(dir, `${fileName}.bak`);
+
+    if (FS.existsSync(fileBak)) {
+      FS.writeFileSync(file, FS.readFileSync(fileBak, 'utf-8'));
+      FS.unlinkSync(fileBak);
+    }
+  }
+}
+
+/**
+ * @param {string} current
+ * @param {string} [latest]
+ */
+function getNextPreReleaseVersion(current, latest) {
+  let target = current;
+  const v1 = semver.parse(current);
+  const v2 = semver.parse(latest);
+
+  if (v1 == null) return semver.inc(target, 'minor');
+  if (v2 == null || latest == null) {
+    return semver.inc(target, v1.minor % 2 === 0 ? 'minor' : 'patch');
+  }
+
+  if (v2.compare(v1) > 0) target = latest;
+
+  return semver.inc(target, semver.minor(target) % 2 === 0 ? 'minor' : 'patch');
+}
+
+/**
+ *
+ * @param {string} dir
+ */
+async function transform(dir) {
+  const pkg = JSON.parse(FS.readFileSync(`${dir}/package.json`, 'utf-8'));
+  const RELEASE_CHANNEL = /** @type {'release'|'pre-release'} */ (
+    process.env['RELEASE_CHANNEL'] ?? 'release'
+  );
+
+  delete pkg.dependencies;
+  delete pkg.devDependencies;
+
+  if (RELEASE_CHANNEL === 'pre-release') {
+    pkg['pre-release'] = true;
+    pkg.version = getNextPreReleaseVersion(
+      pkg.version,
+      await findLatestVersion(`${pkg.publisher}.${pkg.name}`)
+    );
+    console.debug('Setting version to', pkg.version);
+  } else {
+    if (Array.isArray(pkg.contributions?.jsonValidation)) {
+      pkg.contributions.jsonValidation[0].url = `https://unpkg.com/@vuedx/projectconfig@${pkg.version}/schema.json`;
+    }
+  }
+
+  const packageFile = Path.resolve(dir, 'package.json');
+
+  FS.writeFileSync(packageFile, JSON.stringify(pkg, null, 2));
+}
+
+/**
+ * @param {string} dir
+ * @param {() => void} fn
+ */
+async function prepareExtensionForPackaging(dir, fn) {
+  try {
+    backup(dir);
+    await transform(dir);
+    fn();
+  } finally {
+    revert(dir);
+  }
+}
+
+const __dirname = Path.dirname(fileURLToPath(import.meta.url));
+const dir = Path.resolve(__dirname, '..');
+prepareExtensionForPackaging(dir, () => {
+  const execArgs = { stdio: [0, 1, 2], cwd: dir };
+  const RELEASE_CHANNEL = /** @type {'release'|'pre-release'} */ (
+    process.env['RELEASE_CHANNEL'] ?? 'release'
+  );
+  const args = RELEASE_CHANNEL === 'pre-release' ? '--pre-release' : '';
+
+  execSync(`$(pnpm bin)/vsce package --no-dependencies ${args} --out preview.vsix`, execArgs);
+});