VSExtensibility/README.md

Welcome to the VSExtensibility repository!

This repo is your hub for all announcements and documentation for ongoing and upcoming Visual Studio extensibility projects. Documentation is currently available for the following:

• Out-of-Proc Extensibility SDK (see below)
• Extensions to Language Server Protocol (LSP)

Visual Studio Out-Of-Process Extensibility SDK

While the existing model loads extensions in-process, the new extensibility model brings Visual Studio extensions out-of-process. This out-of-proc model gives you the opportunity to create more reliable, secure, and easier-to-write extensions while still providing the in-depth functionality the old model provides. The following documentation describes:

• The general architecture of the new extensibility model
• How to take advantage of the new extensibility model’s APIs
• How to compile and F5 debug an extension with the new model
• Resources and code samples to get started writing an extension with the new model

For future updates please bookmark our announcements page

Prerequisites

• Visual Studio 2022.4 Preview 3 or higher with .Net desktop development workload.
• Install VisualStudio.Extensibility Project System: This extension will allow you to debug extension projects using F5. There is currently no other deployment mechanism supported.

Getting Started

• Introduction to new out-of-process extensibility
• Create your first extension
• Create an in-proc extension

Extension Guides

• Parts of a new Visual Studio extension
• Parts of the SDK
• Commands
• Tool Windows
• Output Window
• User Prompts
• Editor components
• Rule based conditions
• Remote UI
• Advanced Remote UI concepts

Samples and walkthroughs

A Visual Studio solution containing all samples can be found at Samples.sln.

• Simple command handler (Source)
• Markdown Linter
• Output Window sample
• Insert guid extension sample
• Command registration, localization sample
• Comment Remover, in-proc extension sample
• Tool Window sample
• User Prompt sample
• Document Selector sample

API Docs

The following two namespaces are primary extensibility surface provided by the SDK:

• Microsoft.VisualStudio.Extensibility
• Microsoft.VisualStudio.Extensibility.Editor

The following assemblies contain classes related to infrastructure and underlying implementation for the wrappers in the SDK:

• Microsoft.VisualStudio.Extensibility.Framework
• Microsoft.VisualStudio.Extensibility.Contracts
• Microsoft.VisualStudio.Extensibility.EditorHostService
• Microsoft.VisualStudio.ProjectSystem.Query

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.