@rushstack/heft-vscode-extension-plugin 0.1.0 → 0.2.0

package/heft-plugin.json

@@ -1,10 +1,38 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/heft-plugin.schema.json",
-
   "taskPlugins": [
     {
       "pluginName": "vscode-extension-package-plugin",
-      "entryPoint": "./lib/VSCodeExtensionPackagePlugin.js"
+      "entryPoint": "./lib/VSCodeExtensionPackagePlugin.js",
+      "parameterScope": "package"
+    },
+    {
+      "pluginName": "vscode-extension-publish-plugin",
+      "entryPoint": "./lib/VSCodeExtensionPublishPlugin.js",
+      "parameterScope": "publish-vsix",
+      "parameters": [
+        {
+          "longName": "--vsix-path",
+          "parameterKind": "string",
+          "argumentName": "RELATIVE_PATH",
+          "description": "Use this parameter to control which VSIX file will be used for publishing.",
+          "required": true
+        },
+        {
+          "longName": "--manifest-path",
+          "parameterKind": "string",
+          "argumentName": "RELATIVE_PATH",
+          "description": "Use this parameter to control which manifest file will be used for publishing.",
+          "required": true
+        },
+        {
+          "longName": "--signature-path",
+          "parameterKind": "string",
+          "argumentName": "RELATIVE_PATH",
+          "description": "Use this parameter to control which signature file will be used for publishing.",
+          "required": true
+        }
+      ]
     }
   ]
 }

package/lib/VSCodeExtensionPackagePlugin.d.ts

@@ -11,6 +11,11 @@ interface IVSCodeExtensionPackagePluginOptions {
      * If a directory is provided, the VSIX file will be named based on the extension's `package.json` name and version.
      */
     vsixPath: string;
+    /**
+     * The path where the generated manifest file will be saved.
+     * This manifest is used for signing the VS Code extension.
+     */
+    manifestPath: string;
 }
 export default class VSCodeExtensionPackagePlugin implements IHeftTaskPlugin<IVSCodeExtensionPackagePluginOptions> {
     apply(heftTaskSession: IHeftTaskSession, heftConfiguration: HeftConfiguration, pluginOptions: IVSCodeExtensionPackagePluginOptions): void;

package/lib/VSCodeExtensionPackagePlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"VSCodeExtensionPackagePlugin.d.ts","sourceRoot":"","sources":["../src/VSCodeExtensionPackagePlugin.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,gBAAgB,EAEjB,MAAM,iBAAiB,CAAC;AAMzB,UAAU,oCAAoC;IAC5C;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAOD,MAAM,CAAC,OAAO,OAAO,4BACnB,YAAW,eAAe,CAAC,oCAAoC,CAAC;IAEzD,KAAK,CACV,eAAe,EAAE,gBAAgB,EACjC,iBAAiB,EAAE,iBAAiB,EACpC,aAAa,EAAE,oCAAoC,GAClD,IAAI;CA4CR"}
+{"version":3,"file":"VSCodeExtensionPackagePlugin.d.ts","sourceRoot":"","sources":["../src/VSCodeExtensionPackagePlugin.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,gBAAgB,EAEjB,MAAM,iBAAiB,CAAC;AAKzB,UAAU,oCAAoC;IAC5C;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAID,MAAM,CAAC,OAAO,OAAO,4BACnB,YAAW,eAAe,CAAC,oCAAoC,CAAC;IAEzD,KAAK,CACV,eAAe,EAAE,gBAAgB,EACjC,iBAAiB,EAAE,iBAAiB,EACpC,aAAa,EAAE,oCAAoC,GAClD,IAAI;CAgDR"}

package/lib/VSCodeExtensionPackagePlugin.js

@@ -35,45 +35,40 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-const node_core_library_1 = require("@rushstack/node-core-library");
 const path = __importStar(require("node:path"));
-const terminal_1 = require("@rushstack/terminal");
+const util_1 = require("./util");
 const PLUGIN_NAME = 'vscode-extension-package-plugin';
-const vsceBasePackagePath = require.resolve('@vscode/vsce/package.json');
-const vsceScript = path.resolve(vsceBasePackagePath, '../vsce');
 class VSCodeExtensionPackagePlugin {
     apply(heftTaskSession, heftConfiguration, pluginOptions) {
         heftTaskSession.hooks.run.tapPromise(PLUGIN_NAME, async (runOptions) => {
-            var _a, _b;
-            const { unpackedFolderPath, vsixPath } = pluginOptions;
+            const { unpackedFolderPath, vsixPath, manifestPath } = pluginOptions;
+            const { buildFolderPath } = heftConfiguration;
             const { logger: { terminal } } = heftTaskSession;
-            terminal.writeLine(`Using VSCE script: ${vsceScript}`);
+            terminal.writeLine(`Using VSCE script: ${util_1.vsceScriptPath}`);
             terminal.writeLine(`Packaging VSIX from ${unpackedFolderPath} to ${vsixPath}`);
-            const terminalOutStream = new terminal_1.TerminalStreamWritable({
-                terminal,
-                severity: terminal_1.TerminalProviderSeverity.log
+            const packageResult = await (0, util_1.executeAndWaitAsync)(terminal, 'node', [util_1.vsceScriptPath, 'package', '--no-dependencies', '--out', path.resolve(vsixPath)], {
+                currentWorkingDirectory: path.resolve(buildFolderPath, unpackedFolderPath)
             });
-            const terminalErrorStream = new terminal_1.TerminalStreamWritable({
-                terminal,
-                severity: terminal_1.TerminalProviderSeverity.error
-            });
-            const childProcess = node_core_library_1.Executable.spawn('node', [vsceScript, 'package', '--no-dependencies', '--out', `${path.resolve(vsixPath)}`], {
-                currentWorkingDirectory: path.resolve(unpackedFolderPath),
-                stdio: [
-                    'ignore', // stdin
-                    'pipe', // stdout
-                    'pipe' // stderr
-                ]
-            });
-            (_a = childProcess.stdout) === null || _a === void 0 ? void 0 : _a.pipe(terminalOutStream);
-            (_b = childProcess.stderr) === null || _b === void 0 ? void 0 : _b.pipe(terminalErrorStream);
-            const result = await node_core_library_1.Executable.waitForExitAsync(childProcess, {
-                encoding: 'utf8'
-            });
-            if (result.exitCode !== 0) {
-                throw new Error(`VSIX packaging failed with exit code ${result.exitCode}`);
+            if (packageResult.exitCode !== 0) {
+                throw new Error(`VSIX packaging failed with exit code ${packageResult.exitCode}`);
             }
             terminal.writeLine('VSIX successfully packaged.');
+            terminal.writeLine(`Generating manifest at ${manifestPath}`);
+            const manifestResult = await (0, util_1.executeAndWaitAsync)(terminal, 'node', [
+                util_1.vsceScriptPath,
+                'generate-manifest',
+                '--packagePath',
+                path.resolve(vsixPath),
+                '--out',
+                path.resolve(manifestPath)
+            ], {
+                currentWorkingDirectory: buildFolderPath
+            });
+            if (manifestResult.exitCode !== 0) {
+                throw new Error(`Manifest generation failed with exit code ${manifestResult.exitCode}`);
+            }
+            terminal.writeLine('Manifest successfully generated.');
+            terminal.writeLine(`VSIX package and manifest generation completed successfully.`);
         });
     }
 }

package/lib/VSCodeExtensionPublishPlugin.d.ts

@@ -0,0 +1,8 @@
+import type { HeftConfiguration, IHeftTaskPlugin, IHeftTaskSession } from '@rushstack/heft';
+interface IVSCodeExtensionPublishPluginOptions {
+}
+export default class VSCodeExtensionPublishPlugin implements IHeftTaskPlugin<IVSCodeExtensionPublishPluginOptions> {
+    apply(heftTaskSession: IHeftTaskSession, heftConfiguration: HeftConfiguration, pluginOptions: IVSCodeExtensionPublishPluginOptions): void;
+}
+export {};
+//# sourceMappingURL=VSCodeExtensionPublishPlugin.d.ts.map

package/lib/VSCodeExtensionPublishPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VSCodeExtensionPublishPlugin.d.ts","sourceRoot":"","sources":["../src/VSCodeExtensionPublishPlugin.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,gBAAgB,EAGjB,MAAM,iBAAiB,CAAC;AAKzB,UAAU,oCAAoC;CAAG;AAQjD,MAAM,CAAC,OAAO,OAAO,4BACnB,YAAW,eAAe,CAAC,oCAAoC,CAAC;IAEzD,KAAK,CACV,eAAe,EAAE,gBAAgB,EACjC,iBAAiB,EAAE,iBAAiB,EACpC,aAAa,EAAE,oCAAoC,GAClD,IAAI;CAgER"}

package/lib/VSCodeExtensionPublishPlugin.js

@@ -0,0 +1,88 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const path = __importStar(require("node:path"));
+const util_1 = require("./util");
+const PLUGIN_NAME = 'vscode-extension-publish-plugin';
+const VSIX_PATH_PARAMETER_NAME = '--vsix-path';
+const MANIFEST_PATH_PARAMETER_NAME = '--manifest-path';
+const SIGNATURE_PATH_PARAMETER_NAME = '--signature-path';
+class VSCodeExtensionPublishPlugin {
+    apply(heftTaskSession, heftConfiguration, pluginOptions) {
+        const vsixPathParameter = heftTaskSession.parameters.getStringParameter(VSIX_PATH_PARAMETER_NAME);
+        const manifestPathParameter = heftTaskSession.parameters.getStringParameter(MANIFEST_PATH_PARAMETER_NAME);
+        const signaturePathParameter = heftTaskSession.parameters.getStringParameter(SIGNATURE_PATH_PARAMETER_NAME);
+        if (!vsixPathParameter.value) {
+            throw new Error(`The parameter "${VSIX_PATH_PARAMETER_NAME}" is required for the VSCodeExtensionPublishPlugin.`);
+        }
+        if (!manifestPathParameter.value) {
+            throw new Error(`The parameter "${MANIFEST_PATH_PARAMETER_NAME}" is required for the VSCodeExtensionPublishPlugin.`);
+        }
+        if (!signaturePathParameter.value) {
+            throw new Error(`The parameter "${SIGNATURE_PATH_PARAMETER_NAME}" is required for the VSCodeExtensionPublishPlugin.`);
+        }
+        const vsixPath = vsixPathParameter.value;
+        const manifestPath = manifestPathParameter.value;
+        const signaturePath = signaturePathParameter.value;
+        heftTaskSession.hooks.run.tapPromise(PLUGIN_NAME, async (runOptions) => {
+            const { buildFolderPath } = heftConfiguration;
+            const { logger: { terminal } } = heftTaskSession;
+            terminal.writeLine(`Using VSCE script: ${util_1.vsceScriptPath}`);
+            terminal.writeLine(`Publishing VSIX ${vsixPath}`);
+            const publishResult = await (0, util_1.executeAndWaitAsync)(terminal, 'node', [
+                util_1.vsceScriptPath,
+                'publish',
+                '--no-dependencies',
+                '--azure-credential',
+                '--packagePath',
+                path.resolve(vsixPath),
+                '--manifestPath',
+                path.resolve(manifestPath),
+                '--signaturePath',
+                path.resolve(signaturePath)
+            ], {
+                currentWorkingDirectory: path.resolve(buildFolderPath)
+            });
+            if (publishResult.exitCode !== 0) {
+                throw new Error(`VSIX publishing failed with exit code ${publishResult.exitCode}`);
+            }
+            terminal.writeLine('VSIX successfully published.');
+        });
+    }
+}
+exports.default = VSCodeExtensionPublishPlugin;
+//# sourceMappingURL=VSCodeExtensionPublishPlugin.js.map

package/lib/util.d.ts

@@ -0,0 +1,5 @@
+import { IExecutableSpawnOptions, IWaitForExitResult } from '@rushstack/node-core-library';
+import { ITerminal } from '@rushstack/terminal';
+export declare function executeAndWaitAsync(terminal: ITerminal, command: string, args: string[], options?: Omit<IExecutableSpawnOptions, 'stdio'>): Promise<IWaitForExitResult<string>>;
+export declare const vsceScriptPath: string;
+//# sourceMappingURL=util.d.ts.map

package/lib/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAGA,OAAO,EAAc,uBAAuB,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAGvG,OAAO,EAAoD,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAElG,wBAAsB,mBAAmB,CACvC,QAAQ,EAAE,SAAS,EACnB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,GAAE,IAAI,CAAC,uBAAuB,EAAE,OAAO,CAAM,GACnD,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAyBrC;AAGD,eAAO,MAAM,cAAc,EAAE,MAAqD,CAAC"}

package/lib/util.js

@@ -0,0 +1,65 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.vsceScriptPath = void 0;
+exports.executeAndWaitAsync = executeAndWaitAsync;
+const node_core_library_1 = require("@rushstack/node-core-library");
+const path = __importStar(require("node:path"));
+const terminal_1 = require("@rushstack/terminal");
+async function executeAndWaitAsync(terminal, command, args, options = {}) {
+    var _a, _b;
+    const childProcess = node_core_library_1.Executable.spawn(command, args, Object.assign(Object.assign({}, options), { stdio: [
+            'ignore', // stdin
+            'pipe', // stdout
+            'pipe' // stderr
+        ] }));
+    (_a = childProcess.stdout) === null || _a === void 0 ? void 0 : _a.pipe(new terminal_1.TerminalStreamWritable({
+        terminal,
+        severity: terminal_1.TerminalProviderSeverity.log
+    }));
+    (_b = childProcess.stderr) === null || _b === void 0 ? void 0 : _b.pipe(new terminal_1.TerminalStreamWritable({
+        terminal,
+        severity: terminal_1.TerminalProviderSeverity.error
+    }));
+    const result = await node_core_library_1.Executable.waitForExitAsync(childProcess, {
+        encoding: 'utf8'
+    });
+    return result;
+}
+const vsceBasePackagePath = require.resolve('@vscode/vsce/package.json');
+exports.vsceScriptPath = path.resolve(vsceBasePackagePath, '../vsce');
+//# sourceMappingURL=util.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/heft-vscode-extension-plugin",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Heft plugin for building vscode extensions.",
   "repository": {
     "type": "git",
@@ -22,8 +22,8 @@
   },
   "dependencies": {
     "@vscode/vsce": "3.3.2",
-    "@rushstack/terminal": "0.15.4",
-    "@rushstack/node-core-library": "5.14.0"
+    "@rushstack/node-core-library": "5.14.0",
+    "@rushstack/terminal": "0.15.4"
   },
   "sideEffects": false,
   "scripts": {