Mads Kristensen madskristensen

Tools for VS extension authors

Here is a list of tools that makes Visual Studio extension development easier.

Checklist

Visual Studio Extensibility Checklist

Here is a list of things to make sure to remember before publishing your Visual Studio extension.

Adhere to threading rules

Add the Microsoft.VisualStudio.SDK.Analyzers NuGet package to your VSIX project, which will help you discover and fix common violations of best practices regarding threading.

Add high-quality icon

All extensions should have an icon associated with it. Make sure the icon is a high-quality .png file with the size 90x90 pixels in 96 DPI or more. After adding the icon to your VSIX project, register it in the .vsixmanifest file as both the Icon and Preview image.

Name and description

Visual Studio API samples

The numbers in paranthesis is the version of Visual Studio where the API was introduced.

MISC

gundermanc/vs-xplat-extensibility-samples

Async QuickInfo (15.6)

	{
	"id": "017794d6-b8b4-48ab-88a5-eb696ac07322",
	"name": "My Visual Studio extensions",
	"description": "A collection of my Visual Studio extensions",
	"version": "1.0",
	"extensions": [
	{
	"name": "Add New File",
	"vsixId": "2E78AA18-E864-4FBB-B8C8-6186FC865DB3"
	},

	function RemoveBadge {
	param ($path)

	Write-Host "Looking for PreviewBadge.pkgdef in $path"

	$file = Get-ChildItem -Path $path -Include *previewbadge.pkgdef -Recurse

	if ($file){
	Remove-Item $file
	Write-Host "PreviewBadge.pkgdef deleted"

	using Microsoft.AspNetCore.Builder;
	using Microsoft.AspNetCore.Http;
	using Microsoft.AspNetCore.WebUtilities;
	using Microsoft.Net.Http.Headers;
	using System.IO;
	using System.Security.Cryptography;
	using System.Threading.Tasks;

	public class ETagMiddleware
	{

	using System.ComponentModel.Composition;
	using Microsoft.VisualStudio.Text.Editor;
	using Microsoft.VisualStudio.Utilities;

	namespace YamlSpacesFix
	{
	[Export(typeof(IWpfTextViewCreationListener))]
	[ContentType(ContentType)]
	[TextViewRole(PredefinedTextViewRoles.PrimaryDocument)]
	public class YamlCreationListener : IWpfTextViewCreationListener

	On the package

	[ProvideAutoLoad(UIContexts.LoadContext)]
	[ProvideUIContextRule(UIContexts.LoadContext,
	"RightFileTypeOpen",
	"(CSharpFileOpen \| VBFileOpen)",
	new[] { "CSharpFileOpen", "VBFileOpen" },
	new[] { "ActiveEditorContentType:CSharp", "ActiveEditorContentType:Basic" })]

	In the VSCT

	<!-- Render the partial -->
	@{await Html.RenderPartialAsync("_SocialSharing", ViewData["Title"]);}