diff --git a/Content/proget/feeds/openvsx/#.md b/Content/proget/feeds/openvsx/#.md new file mode 100644 index 00000000..da84b6fb --- /dev/null +++ b/Content/proget/feeds/openvsx/#.md @@ -0,0 +1,63 @@ +--- +title: "Open VSX Extension (vscode)" +order: 7 +--- + +An Open VSX feed in ProGet stores Open VSX compatible extensions, typically used with Visual Studio Code and compatible IDEs. Extensions stored in this feed can be installed directly from compatible IDEs/code editors like VSCodium. + +Note that this feed type is for VS Code style extensions only, **not** for Visual Studio extensions. See [Visual Studio Extension feeds](vsix) if you need a feed for Visual Studio extensions. + +## Prerequisite Configuration + +## Using With Visual Studio Code + +The official Microsoft-produced build of Visual Studio code is not currently supported by this feed type. While it is technically possible to configure it to install extensions from an Open VSX feed, this requires hand-editing a file that is part of its distribution and gets overwritten on upgrades. Further, changing the URL to a non-Microsoft private extension repository in this way may violate Microsoft's license. + +### Adding the Feed to VSCodium + +These instructions are specifically for VSCodium, but should also apply to other open source forks of Visual Studio Code. + +To use an Open VSX feed in VSCodium, you need to create or edit a `product.json` file with the following content: + +```json +{ + "extensionsGallery": { + "serviceUrl": "https://proget.example.com/endpoints/FeedName/vscode/gallery", + "itemUrl": "https://proget.example.com/endpoints/FeedName/vscode/item", + "extensionUrlTemplate": "https://proget.example.com/endpoints/FeedName/gallery/{publisher}/{name}/latest", + "resourceUrlTemplate": "https://proget.example.com/endpoints/FeedName/unpkg/{publisher}/{name}/{version}/{path}", + "cacheUrl": "", + "controlUrl": "" + } +} +``` + +The `product.json` file location will vary based on your operating system. Normally, the location is: + + * Windows: `%APPDATA%\VSCodium` or `%USERPROFILE%\AppData\Roaming\VSCodium` + * macOS: `~/Library/Application Support/VSCodium` + * Linux: `$XDG_CONFIG_HOME/VSCodium` or `~/.config/VSCodium` + +After updating the file, restart VSCodium and the Extensions tab should now show the contents of your feed. + +## Uploading Extensions + +To upload a `.vsix` extension, you can use Inedo's [pgutil](/docs/proget/api/pgutil) and run this command: + +```bash +pgutil packages upload --feed=«vsix-feed-name» --input-file=«path-to-extension» +``` +You can also use the UI or [bulk upload](/docs/proget/feeds/feed-overview/proget-bulk-import). + +::: (internal) (Create New HOTO) + +Read more about uploading `.vsix` extensions in our [HOWTO: Create a Private Extension Gallery for Visual Studio and Visual Studio Code](/docs/proget/feeds/vsix/howto-vsix-consume) +::: + +## Installing Extensions + +Navigate to the Extensions tab and search for the desired extension, then click Install. + +## Limitations + * Not supported in official builds of VS Code (see above) + * Connectors to the official Visual Studio Marketplace are not permitted due to licensing. However, connectors to [open-vsx.org](https://open-vsx.org) are permitted. diff --git a/Content/proget/feeds/other-types.md b/Content/proget/feeds/other-types.md index 31268a3a..2337f4e6 100644 --- a/Content/proget/feeds/other-types.md +++ b/Content/proget/feeds/other-types.md @@ -32,6 +32,7 @@ By partnering with our users, we were able to add a lot of feed types: * [✔ Cargo (Rust) Feeds](/docs/proget/feeds/cargo) were added in ProGet 2024.20 * [✔ Composer (PHP) Feeds](/docs/proget/feeds/composer) were added in ProGet 2024.22 * [✔ Conan (C++) Feeds](/docs/proget/feeds/conan) were added in ProGet 2024.22 +* [✔ Open VSX Extensions (vscode)](/docs/proget/feeds/openvsx) were added in ProGet 2026.12 Without a user partnership, it's hard to support a new feed type. So this page will mainly serve as a place where we discuss the status of various requested third-party feed types. @@ -39,11 +40,6 @@ Without a user partnership, it's hard to support a new feed type. So this page w Feel free to submit pull requests for this page or participate in the linked Q&A discussions if you have more information. -### 🧑‍💻 Open VSIX Gallery: In Development - -Given the growing popularity of VSCode forks like VSCodium, Cursor, etc., we will be adding a new feed type called "Open VSIX" that will allow for connectors to both Open VSIX and Microsoft's Gallery. See the [discussion on the forums](https://forums.inedo.com/topic/4054) to learn more. - - ### 📉 WinGet: very limited demand This is brand new from Microsoft, so there's not much demand for private feeds—but there is a [discussion on the forums](https://forums.inedo.com/topic/3257), so please contribute if you're interested. diff --git a/Content/proget/feeds/vsix/#.md b/Content/proget/feeds/vsix/#.md index 97e41f87..2e4c293e 100644 --- a/Content/proget/feeds/vsix/#.md +++ b/Content/proget/feeds/vsix/#.md @@ -7,6 +7,9 @@ A VSIX feed in ProGet stores Visual Studio extensions, which can then be install The Visual Studio gallery uses an internal API that is different from the documented Atom VSIX feed that ProGet provides, so no connector to the Visual Studio Gallery can currently be created in ProGet. However, connectors to other Atom VSIX feeds are supported. +Note that this feed type for Visual Studio only, **not** for VS Code extensions. See [Open VSX feeds](openvsix) if you need a feed for VS Code extensions. + + ## Prerequisite Configuration ### Adding the Feed to Visual Studio