| title | description | date |
|---|---|---|
VisualStudio.Extensibility |
Welcome to the Visual Studio Extensibility model |
2021-08-19 |
VisualStudio.Extensibility is a new framework for developing Visual Studio extensions. The new framework focuses primarily on extensions that run out-of-process from the IDE for improved performance and reliability, and it features a modern, asynchronous API that has been streamlined and carefully engineered to maximize developer productivity. VisualStudio.Extensibility is in active development and is available as a preview.
With the current preview, you can develop a wide range of extensions to Visual Studio, including creating commands, working with code or text in the editor, displaying prompts or dialogs to the user, creating debugger visualizers, and more!
VisualStudio.Extensibility aims to address many of the problems developers experience when using and writing extensions in Visual Studio:
- Visual Studio remains responsive and won't crash if an extension crashes or hangs
- Simplified architecture, consistent APIs, and clear documentation
- Extensions can be installed without restarting Visual Studio
Eventually, the VisualStudio.Extensibility SDK will ultimately allow you to write any extension you could write using the VSSDK. However, until that time, you might encounter situations where the functionality you need in your extension is not yet available in VisualStudio.Extensibility. In that case, you can develop an in-process extension by leveraging the new VisualStudio.Extensibility APIs while relying on VSSDK to cover any feature gap. To learn more, see In-proc extensions.
Important Documentation for the VisualStudio.Extensibility SDK has moved to a new location: VisualStudio.Extensibility documentation.
Documentation is currently available for the following:
- VisualStudio.Extensibility SDK (see the following sections)
- Extensions to Language Server Protocol (LSP)
| Article | Description |
|---|---|
| Install VisualStudio.Extensibility | Download and install the latest preview of VisualStudio.Extensibility. |
| Get started | Never developed an extension before? Start with beginner quickstarts and introductory tutorials. |
| Concepts | Build your mental model of how the SDK and extensions work. |
| Overviews | Learn more by reading overviews of each major area of functionality. |
| Samples | Explore sample code demonstrating major features. |
| API reference | Browse the VisualStudio.Extensibility API documentation. |
| Advanced topics | Learn implementation details of the VisualStudio.Extensibility SDK. |
The current VisualStudio.Extensibility preview works with Visual Studio 2022 version 17.9 Preview 1 or higher with the Visual Studio extension development workload to be installed. VisualStudio.Extensibility extensions can be installed on Visual Studio 2022 version 17.9 Preview 1 and above.
The following articles will help you get oriented and started.
- Create your first extension shows how to create the equivalent of "Hello, world" as an extension.
- Next, follow a tutorial and create a more interesting extension that adds a GUID to the editor window. See Create a simple extension.
To understand how to work with VisualStudio.Extensibility, we recommend a thorough understanding of asynchronous programming with async and await and dependency injection. In addition, UI in VisualStudio.Extensibility is based on Windows Presentation Foundation (WPF), so you might want to review the WPF documentation.
If you're familiar with the Visual Studio SDK, see Introduction to VisualStudio.Extensibility for VSSDK users.
Build your mental model of how Visual Studio extensions work. See Parts of a new Visual Studio extension.
Learn what's in the SDK at Functional areas of the SDK.
When and where should your extension appear in the IDE? Visual Studio extensions surface in the IDE when certain conditions are met. To control how and when your extension appears in the IDE, see Rule-based activation constraints.
Visual Studio extensions make their features available to Visual Studio through Contributions
Learn about the Remote UI model used in the VisualStudio.Extensibility.
Read an overview of the areas of the SDK that you might need for your extension development projects:
- To learn how to create commands and expose them to users in the IDE, see Commands.
- To learn how to work with contents of files and documents, see Editor.
- To learn how to work with the in-memory representation of those documents themselves, see Documents
- To learn how to use the output window in an extension, see Output window.
- To learn how to work with tool windows, dockable windows within the Visual Studio IDE, see Tool windows.
- To learn how to use prompts with customizable buttons to interact with the user, see User prompts.
- To learn how to use dialogs with custom UI to interact with the user, see Dialogs.
- To learn how to create custom data visualizations when debugging, see Debugger Visualizers.
- To learn how to query or modify information about project sand solutions, see Project Query.
A Visual Studio solution containing all samples can be found at Samples.sln.
| Sample | Description |
|---|---|
| Simple command handler | Demonstrates the basics of working with commands. See also the Create your first extension tutorial. |
| Insert guid extension | Shows how to insert text or code in the code editor. See also the tutorial. |
| Command configuration | Shows how to configure a command with specific activation conditions. This command also uses a resource file for localization. |
| Command parenting | Shows how to author a command that can be parented to different aspects of the IDE. |
| Document selector | Shows how to create an editor extension that is only applicable to files matching a file path pattern. |
| Output window | Shows the most basic use of the Output Window API. |
| Tool window | Shows how to create a tool window and populate it with content. |
| User prompt | Shows how to display a prompt to the user. |
| Dialog | Shows how to display a dialog with custom UI to the user. |
| Word count margin | Shows how to create an editor margin extension that displays the word count in a document. |
| Markdown linter | A complete extension with many moving parts interacting to provide an enhanced experience in the editor for a certain file type. |
| Project Query | Shows several different kinds of project system queries you can make. |
| Comment remover | Shows how to consume Visual Studio SDK services through .NET dependency injection and use VisualStudio.Extensibility APIs for commands, prompts and progress report. |
| Article | Description |
|---|---|
| Advanced Remote UI | In-depth information on the remote UI model. |
| In-proc extensions | Learn how to make extension that run in-process. |
- API Docs are available on learn.microsoft.com.
We're actively seeking feedback and engagement. The preview phase is a great time to get community input to help us identify issues and opportunities. You can provide feedback and report bugs in our issues tracker.
For future updates please bookmark our announcements page.
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 [email protected] with any additional questions or comments.
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.