@rushstack/heft-vscode-extension-plugin 0.1.0

package/LICENSE

@@ -0,0 +1,24 @@
+@rushstack/heft-vscode-extension-plugin
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+MIT License
+
+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.

package/README.md

@@ -0,0 +1,12 @@
+# @rushstack/heft-vscode-extension-plugin
+
+This is a Heft plugin for packaging Visual Studio Code extensions using the `vsce` tool.
+
+## Links
+
+- [CHANGELOG.md](
+  https://github.com/microsoft/rushstack/blob/main/heft-plugins/heft-vscode-extension-plugin/CHANGELOG.md) - Find
+  out what's new in the latest version
+- [@rushstack/heft](https://www.npmjs.com/package/@rushstack/heft) - Heft is a config-driven toolchain that invokes popular tools such as TypeScript, ESLint, Jest, Webpack, and API Extractor.
+
+Heft is part of the [Rush Stack](https://rushstack.io/) family of projects.

package/heft-plugin.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/heft-plugin.schema.json",
+
+  "taskPlugins": [
+    {
+      "pluginName": "vscode-extension-package-plugin",
+      "entryPoint": "./lib/VSCodeExtensionPackagePlugin.js"
+    }
+  ]
+}

package/lib/VSCodeExtensionPackagePlugin.d.ts

@@ -0,0 +1,19 @@
+import type { HeftConfiguration, IHeftTaskPlugin, IHeftTaskSession } from '@rushstack/heft';
+interface IVSCodeExtensionPackagePluginOptions {
+    /**
+     * The folder where the unpacked VSIX files are located.
+     * This is typically the output folder of the VSCode extension build.
+     */
+    unpackedFolderPath: string;
+    /**
+     * The path where the packaged VSIX file will be saved.
+     * This can be a directory or a full vsix file path.
+     * If a directory is provided, the VSIX file will be named based on the extension's `package.json` name and version.
+     */
+    vsixPath: string;
+}
+export default class VSCodeExtensionPackagePlugin implements IHeftTaskPlugin<IVSCodeExtensionPackagePluginOptions> {
+    apply(heftTaskSession: IHeftTaskSession, heftConfiguration: HeftConfiguration, pluginOptions: IVSCodeExtensionPackagePluginOptions): void;
+}
+export {};
+//# sourceMappingURL=VSCodeExtensionPackagePlugin.d.ts.map

package/lib/VSCodeExtensionPackagePlugin.d.ts.map

@@ -0,0 +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"}

package/lib/VSCodeExtensionPackagePlugin.js

@@ -0,0 +1,81 @@
+"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 node_core_library_1 = require("@rushstack/node-core-library");
+const path = __importStar(require("node:path"));
+const terminal_1 = require("@rushstack/terminal");
+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 { logger: { terminal } } = heftTaskSession;
+            terminal.writeLine(`Using VSCE script: ${vsceScript}`);
+            terminal.writeLine(`Packaging VSIX from ${unpackedFolderPath} to ${vsixPath}`);
+            const terminalOutStream = new terminal_1.TerminalStreamWritable({
+                terminal,
+                severity: terminal_1.TerminalProviderSeverity.log
+            });
+            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}`);
+            }
+            terminal.writeLine('VSIX successfully packaged.');
+        });
+    }
+}
+exports.default = VSCodeExtensionPackagePlugin;
+//# sourceMappingURL=VSCodeExtensionPackagePlugin.js.map

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@rushstack/heft-vscode-extension-plugin",
+  "version": "0.1.0",
+  "description": "Heft plugin for building vscode extensions.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/rushstack.git",
+    "directory": "heft-plugins/heft-vscode-extension-plugin"
+  },
+  "homepage": "https://rushstack.io/pages/heft/overview/",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "peerDependencies": {
+    "@rushstack/heft": "^0.74.1"
+  },
+  "devDependencies": {
+    "eslint": "~9.25.1",
+    "@types/node": "20.17.19",
+    "@rushstack/heft": "0.74.1",
+    "@rushstack/heft-node-rig": "2.9.1"
+  },
+  "dependencies": {
+    "@vscode/vsce": "3.3.2",
+    "@rushstack/terminal": "0.15.4",
+    "@rushstack/node-core-library": "5.14.0"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "heft build --clean",
+    "start": "heft test --clean --watch",
+    "_phase:build": "heft run --only build -- --clean",
+    "_phase:test": "heft run --only test -- --clean"
+  }
+}