Visual Studio Extension Development | Code Analyzer - A Complete Guide

-

 Isn't it really cool if we could customize the Intellisense/Analyzer rule so that we can add our own analyzer rules and code fixes for the same? Yes, its possible with the help of Visual Studio Extension development toolkit. Lets walk through the steps involved for creating your own code analyzer with code fixes as visual studio extension project and then let us see the analyzer in action.

Installing Necessary Toolset for Visual Studio Extension Development

First step is to install the necessary tool set from the Visual Studio Installer. For this demo I am using Visual Studio 2022. Launch the Visual Studio Installer from the programs and Select the Visual Studio Extension Development from other Toolsets if not already checked as shown in the figure below and click on Modify

 

Visual Studio Extension Development

Creating New Analyzer Project with Code Fix in Visual Studio

Once its successfully installed and updated, Project templates would be available from the Extension. Create a new project with the "Analyzer with Code Fix" Template as shown in the figure below:

Creating a new Analyzer with Code Fix Project

Give a suitable name for the analyzer project, I have given the name as "MyFirstAnalyzer". Once the project is created it will create a set of projects as shown in the figure below:

Analyzer Projects

As shown in the figure around five projects are created out of which First one "MyFirstAnalyzer" is used to add custom analyzer rule, second one "MyFirstAnalyzer.CodeFixes" is used to add the code fixes for the rules described in the first project, rest of them are mainly used for packaging and testing the analyzer code.

Our Analyzer in Action

Lets us try to test our analyzer, For this set the Startup Project as "MyFirstAnalyzer.Vsix" and click on Execute from the Visual Studio. This would launch a new instance of the Visual Studio with our extension pre-installed. We can verify our extension is installed from Extensions->Manage Extensions from the newly created visual studio instance as shown in the figure below:

Custom Visual Studio Extension

Lets us try to create a new Console Application in the new instance of the Visual Studio to test out our Analyzer, Write some sample code, After some time you will observe squiggly line in the code. This is coming from "MyFirstAnalyzer" project if we try to hover our the code we can see the warning from our Analyzer as shown in the figure below:

Custom Analyzer in Action

If you click on the light bulb you will observe the suggested fix for the warning which is coming from the "MyFirstAnalyzer.CodeFixes" project as shown in the below figure:

Code Fix Suggestion

Default Analyzer rule is to make all the words upper case, if we go through the code we can see how its done, it can be a topic for the next post.

 

Comments

Post a Comment

Popular posts from this blog

Creating RESTful Minimal WebAPI in .Net 6 in an Easy Manner! | FastEndpoints

-
Image
  We might have developed Web APIs using MVC Controllers where we used to give Route Path Attributes to the Controller and  to identify individual methods we used to provide Actions in the Route. With the Controller approach we need to write boiler plate code in separate files which deals with the Configuration of the Web Service. Those who have worked in Node js would be aware of how easy it is to create a Web API and expose different Endpoints without the need of so much boiler plate code. Here we are going to discuss of similar approach for creating a Web API in .Net6 using FastEndpoints. Under the hood it uses Minimal API concept which tries to reduce the dependencies required to achieve a particular task. This approach is more suitable in the case of Microservice Architecture where we want to keep the dependencies to minimum. Must Read : Fluent API and Data Annotations What are FastEndpoints? FastEndpoints is a Framework compatible with .Net 6 which allows to build a RESTful Web A
Read more

Mastering Concurrency with Latches and Barriers in C++20: A Practical Guide for Students

-
Image
Introduction Picture yourself as a student tasked with organizing a surprise party for a friend. You have a team of friends helping you, each with a specific role: one decorating, another cooking, and yet another taking care of entertainment. As you plan and coordinate, you quickly realize the importance of timing and synchronization. Just as in party planning, in the world of programming and computing, we often have multiple tasks running concurrently, similar to your friends handling different aspects of the party all at once. However, ensuring that these concurrent tasks harmonize can be a significant challenge. If decorations go up before the food is ready or the entertainment starts before guests arrive, it could lead to chaos. This is where the world of programming comes in, and in this blog, we'll explore powerful tools called "latches" and "barriers" to manage these concurrent scenarios efficiently. Learning about latches and barriers isn't just abou
Read more

Graph Visualization using MSAGL with Examples

-
Image
 Graph visualization is a great way to get a better understanding of complex relationships and structures in data. Whether you work as a software developer, a data scientist, or just want to explore networks, seeing graphs at runtime can be really helpful. In this blog, we'll look at how to make graphs at runtime with MSAGL. We'll cover the basics of creating, customizing, and visualizing graphs with MSAGL, as well as practical examples of how it can be used to create a social network and workflow. What is MSAGL? MSAGL, developed by Microsoft Research, is an open-source library designed for graph and diagram visualization. It offers a wide range of features and layout algorithms to create clear and aesthetically pleasing representations of complex graph structures. Installing MSAGL: To begin, you'll need to install the MSAGL library. You can download the latest version from the official MSAGL GitHub repository or conveniently install it using the NuGet package manager in Vi
Read more