Use Visual Studio extension to distribute your Code Snippets

Introduction

In a previous post we saw how you can build code snippets to write tests faster empowering your team to follow good practices. https://www.albertocorrales.com/2018/10/writing-unit-tests-faster.html

In this post, we will see how we can distribute our snippets with a Visual Studio extension, which offers different advantages, for example:
  • You encapsulate your snippets in a VS extension, you you don't need to distribute them independently, and developers don't need to add them to VS one by one. 
  • The extension can be updated improving he current snippets or including new snippets.
  • You can add more functionality in your Visual Studio extension. 

Creating a new Visual Studio extension

First of all, if you have never developed a Visual Studio extension, you might need to install Visual Studio extension development kit. To do it, install this option in your Visual Studio Installer



Create a new Visual Studio extensions project. For this example, I will name it "SnippetsExtension":


In the root of the project, create a new folder named "snippets". Here you can store all the snippets you wan to distribute with your Visual Studio Extension. For this example, we will used the unittest.snippet example that we saw in the previous post. You can download it here: https://github.com/albertocorrales/unittestsnippet/blob/master/unittest.snippet. 

For file unittest.snippet, it is important to select the following properties:
  • Build Action: Content
  • Copy to Output Directory: Copy always
  • Include in VSIX


In folder snippets, we will create a new text file and we will name it snippets.pkgdef. This file is used to add certain keys to the registry. As for this example, we are using CSharp, write the following:
-----------------------------------------------------------------
// Csharp
[$RootKey$\Languages\CodeExpansions\Csharp\Paths]
"snippets"="$PackageFolder$"
-----------------------------------------------------------------

For file snippets.pkgdef select the following properties:
  • Build Action: Content
  • Copy to Output Directory: Copy always
  • Include in VSIX

If you followed the previos steps, you should see something like this:



Now add your package definition in your VSIX manifest. To do it, double click on source.extensionvsxmanifest. Go to tab "Assets", and then, select the following options to distribute your snippets with your extension:


Finally, test your extension. If you press F5, an experimental instance of Visual Studio will raise, the changes you make in this instance will not affect your development environment. To test your extension is working fine, create a new test project and type "utest" to see the new snippet you added.


You can download this example from my GitHub repository. https://github.com/albertocorrales/SnippetsExtension

If you want more information about how to develop your own Visual Studio extensions, you can go here: https://docs.microsoft.com/en-us/visualstudio/extensibility/starting-to-develop-visual-studio-extensions?view=vs-2017

I hope you found this post useful,

Happy coding!

Comments

Post a Comment

Popular posts from this blog

Building Micro-Frontends with Single-Spa

Image
Introduction Micro-services architecture is becoming trendy since it is a suitable option many projects, specially those that are complex and we want to be able spilt our business logic into different services that can be built and deliver independently. In spite of the fact that micro-services architectures are more complex, they increase the resilience of your system and increase the time-to-market delivery, which can be crucial for many companies. But it is not all about services and backend. With the introduction of single page applications (SPAs), we can build fully-functional user interfaces that can work independently in the browser. And here we should ask ourselves the same questions as for backend applications: Is my SPA becoming a huge monolith? Would I like to deliver functional modules independently? If you using micro-services, is there a relation between my services and your UI? Do we want to have functional teams that can deliver new features (frontend+backend) independe...
Read more

AWS assuming role + MFA with pulumi (and other applications)

Image
Introduction In AWS, managing your IAM in a centralized account is a good practice, so then you can assume a role to access to other accounts without need of duplicating users. You can find more info about this approach in this article . In addition, for security reasons, it is highly recommended to enable MFA (Multi-factor Authentication), so you need a device to generate a temporary code to get access. In the image below it is showed how assume role with MFA works, but you also have an article about MFA in this link . This approach is really useful and most of the configuration can be automated with pulumi (or other providers like terraform or CloudFormation). And once it is configured, you can switch your role and get access to other accounts with a few clicks.  However, when it comes to external software such us pulumi, getting access assuming a role and using MFA might not be too straightforward. In this article we will see how this can be configured and how we can easily refr...
Read more

Managing snapshots for Amazon ElasticSearch with Dotnet Core Lambdas

Image
Introduction It is awesome to have some useful services like ElasticSearch managed by AWS , so you don't have to care about patching, monitoring, etc.  When it comes to backup management for indexes, Amazon ElasticSearch includes automated snapshots. Automated snapshots are only for cluster recovery. You can use them to restore your domain in the event of red cluster status or other data loss. Amazon ES stores automated snapshots in a preconfigured Amazon S3 bucket at no additional charge. In particular, if you are using a higher version than 5.3, Amazon ElasticSearch takes hourly automated snapshots and retains up to 336 of them for 14 days. However, this policy might not be enough if you need to keep your snapshots for a longer 15 days, or you need to take a snapshot to create a new cluster in another region, subnet, etc. If you have different requirements to manage your snapshots, you will have to work with manual snapshots. For this part, AWS does not offer a good managed exper...
Read more