sql server - How to Create an Extension for SSMS 2019 (v18)

Question

SQL Server Management Studio 18 RC1 became available March 28, 2018

This question has already been asked for SSMS 17, but there are slight variations when authoring extensions for different releases of SQL Server Management Studio.

What are the steps to getting a Hello World application up an running in SSMS 2019?

Answer 1

Here are the complete steps, adapted from Stefan Timovski's article on How to Create SQL Server Management Studio 18 (SSMS) Extension

1. Install Visual Studio 2017 with Extensions Toolkit

   If you're not sure you have the extensions toolkit, you can open the Visual Studio Installer and modify your current install to make sure you have extensions installed

   
   

2. Create New Extension Project

   Go to File New Project (Ctrl + Shift + N)

   

   Choose Extensibility > VIX Project

   

   If you don't have these options, go make sure you did step 1

3. Add a New Command Item

   Add a new item (Ctrl + Shift + A)

   

   Select Extensibility and just for demo purposes grab a custom command

   

4. Debug in Visual Studio

   The command file will add a menu item to Tools > Invoke Command1. If you hit debug, Visual Studio will launch a Debuggable instance, fully loaded with your current extension. Hit play or hit F5

   The first time may take a minute to boot-up, but it should go faster thereafter

   

   The click event handled in located in Command1.cs > Execute, and you can add breakpoints.

   

   Here's the working message box

   

5. Get filepath for SSMS

   The default installation path for SSMS 18 should be:

   C:Program Files (x86)Microsoft SQL Server Management Studio 18Common7IDESsms.exe
   

   If it's not there, to identify the startup location of any app, you can Shift + Right Clicking on the app icon and select "Open file location"

   

6. Set Launch to SSMS

   Open up the project properties in VS (Alt + Enter)

   

   Go to Debug > Start External Program and paste in the path

   

   Remove the command line args as they're no longer applicable to SSMS

7. Set Deploy VSIX to SSMS

   The "Extensions" subdirectory should be in the same directory as SSMS. Also, add an extra folder with your project name like this

   C:Program Files (x86)Microsoft SQL Server Management Studio 18Common7IDEExtensionsVSIXProject1
   

   Go to VSIX > and select "Copy VSIX content to the following location"

   

8. Set Permissions

   Lastly, in order to programmatically invoke any apps on C Drive, you'll need admin privileges, so you need to open Visual Studio in Admin Mode. You can do that by right clicking on the application like this

   

9. Hit Run & Debug

   Presto! Blamo! Your extension should now be running SSMS

   

Further Reading

Historically, each extension needed to be whitelisted, but according to the release notes for SSMS 18, one big change (for the better) is

Package IDs no longer needed to develop SSMS Extensions
In the past, SSMS was selectively loading only well-known packages, thus requiring developers to register their own package. This is no longer the case.

Since SSMS 18 uses the Visual Studio 2017 Isolated Shell, many of the extension developer documentation is available under the Visual Studio Extension Docs