Roslyn Analyzer

-

Roslyn analyzers provide a live static analysis of you code. They can detect wrong usages of APIs, security issues, performance issues etc..

Many of the code editor functionalities are implemented using Roslyn public APIs such as automatic code formatting and coloring, IntelliSense, code navigation, and refactoring. Microsoft wanted to make the C# and VB compiler useful in other scenarios such as diagnostics, static analysis, source code transformation, etc. To achieve that, Microsoft created a compiler that not only converts source code into binaries but also acts as a service, that provides a public API for understanding the code.

In this post, we will understand what is Roslyn Analyzer and how it set it up in your system.

Table of Contents

  1. What is Roslyn Analyzer?
  2. Roslyn public API
  3. Setting up Roslyn
  4. Wrapping Up

WHAT IS ROSLYN ANALYZER?

Project Roslyn is a part of the .NET Foundation along with other projects like .NET Runtime. Roslyn is an open-source provider of C# and Visual Basic compilers developed by Microsoft, with rich code analysis APIs.. Roslyn is just the code name provided to the .NET Compiler Platform. Roslyn can produce warnings in your code even before you have finished the line, thus it is aptly termed an analyzer. Roslyn can also suggest automatic error fixation.

Roslyn Analyzers are used to inspect your C# or Visual Basic code for style, quality, design, maintainability, and other aspects. Processing of source code consists of three main phases: syntax analysis, semantic analysis, and code generation. The output of each phase acts as the input for the next phase, but these intermediate results and internal data structures are not visible/accessible to the user. Thus, developers consider the compiler as a Black box.

ROSLYN PUBLIC API

Roslyn APIs use the pipeline architecture of a traditional compiler, providing access to each step of the compiler’s source code analysis and processing:

  • Syntax tree API shows the lexical and syntactic structure of your code, including formatting and comments. The latter two are important since they help to manipulate the code and keep the formatting and code comments intact.
  • Symbol API shows you the symbol table containing names declared in your source code, as well as those originating from referenced assemblies without corresponding source code.
  • Binding and Flow Analysis APIs expose the complete semantic model of your code that then becomes available after the binding phase. These APIs possess all the information about the code that is required for generating the binaries. This includes any errors and warnings that were detected in the code.
  • Emit API provides access to services for forming the IL byte code.

The scope of Roslyn goes further than just being only a compiler API. Roslyn codebase is now being used in two scenarios with almost contrasting requirements. Considering the compiler, high throughput and correctness are the most important factors whereas while considering the interactive editor, responsiveness and error detection are of higher priority. Roslyn has managed to achieve comparable, if not better performance than Visual Studio 2013, in both of the aforementioned fields. However, this also comes with some downsides viz. all of the data structures are immutable i.e. they cannot be modified.

Fig.: Roslyn’s spellcheck analyzer that is built into Visual Studio


SETTING UP ROSLYN

  • Download the NuGet command line exe from here - https://www.nuget.org/downloads .
  • Download the Roslyn Compiler Platform SDK Templates from here. The important thing is that the templates do not come with Visual Studio 2015. To install them go to: Tools > Extensions and Updates > Online.
  • Now just search for “Roslyn SDK”. This will help you to find the templates that correspond to your version.
  • After installing the templates, you have to restart Visual Studio.
  • Now that you have installed the .NET Compiler Platform SDK, you can effortlessly start using the built-in templates to create a new analyzer project. Navigate to File->New->Project. Now select Extensibility under Templates->Visual C#.

Now, just make sure that version 4.6.2 of the.NET framework is selected. 


Comments

Post a Comment

Popular posts from this blog

Email Sending through O365 using OAuth Protocol

-
  Microsoft Office365 EWS servers have been extended to support authorization via the industry-standard OAuth 2.0 protocol. Using OAUTH protocol, user can do authentication by Microsoft Web OAuth instead of inputting user and password directly in application Microsoft / Office 365 OAuth + EWS We can use the OAuth authentication service provided by Azure Active Directory to enable our application to connect with IMAP, POP or SMTP protocols to access Exchange Online in Office 365. To use OAuth with our application we need to register application on Azure Active directory and other steps also we need to do to get the access token back. Below are the steps   To use Microsoft/Office365 OAUTH in your application, you must create an application in  https://portal.azure.com . Sign into the Azure portal using either a work or school account or a personal Microsoft account. If your account gives you access to more than one tenant, select your account in the top right corn
Read more

IISRESET vs App Pool Recycling ?

-
Image
 I think most IIS administrators know IISRESET command, and why they use it. One of possible reasons can be to restart IIS services to initialize web applications, or to apply some changes of applications & IIS settings .There’re just a few conditions those need your IISRESET command. In most situations, you don’t need this. I have a concern if you always run this command for applying any changes, or release system resource – memory – regularly, or frequently. Because it’s much more cost than what you really need to take – there’re side effects Recycling App Pool’ has been introduced from IIS6 in Windows2003. It’s designed to restart only application pools(=worker processes). It can be done in a command prompt(run ‘IISAPP /?’ in a command prompt for details), as well as in the IIS manager What IISRESET does? When you run IISRESET, many things will happen. In order to understand them, I think I need to show you how IIS looks like – about IIS core components. The below shows you role
Read more

Deploy .Net6.0 Web api with docker

-
Image
  What is Docker? Docker is a containerization platform, meaning that it enables you to package your applications into images and run them as “containers” on any platform that can run Docker. It negates the classic: “It works on my computer” argument as Docker images contain everything needed for the app to run. Are Containers the same as Virtual Machines? They are similar, but not the same. In short: Virtual Machines provide OS Level Virtualization Containers provide App Level Virtualization This concept is depicted below: Why Would You Use it? In short you would use Docker, (and hence containers), for the following reasons: Portability.  As containers are self- contained  they can run on any platform that runs Docker, making them easy to stand up and run on a wide variety of platforms. Scalability.  With the use of additional “orchestration” you can spin up multiple container instances to support increased load. Performance.  Containers generally perform better than their VM counterp
Read more