Roslyn Cookbook: Compiler as a Service, Code Analysis, Code Quality and more

What do you get with eBook?

Instant access to your Digital eBook purchase

Download this book in EPUB and PDF formats

Access this title in our online reader with advanced features

DRM FREE - Read whenever, wherever and however you want

Consuming Diagnostic Analyzers in .NET Projects

In the previous chapter, we showed you how to write diagnostic analyzers to analyze and report issues about the .NET source code and contribute them to the .NET developer community. In this chapter, we will show you how to search, install, view, and configure the analyzers that have already been published by various analyzer authors on NuGet and the VS extension gallery. We will cover the following recipes:

Searching and installing analyzers through the NuGet package manager
Searching and installing VSIX analyzers through the VS extension gallery
Viewing and configuring analyzers in the solution explorer in Visual Studio
Using the ruleset file and Rule Set editor to configure analyzers

Key benefits

1. Use Roslyn extensions and tools in Visual Studio to enforce "house rules" on code and fix security and performance vulnerabilities in your code.

2. Write Roslyn extensions using the Roslyn service API to help developers enforce conventions and design idioms.

3. Improve developer productivity by using Roslyn-based agile development features in Visual Studio, such as live unit testing, C# interactive and scripting.

4. Contribute to the C# language and compiler tool chain to analyze and edit code.

Description

Open-sourcing the C# and Visual Basic compilers is one of the most appreciated things by the .NET community, especially as it exposes rich code analysis APIs to analyze and edit code. If you want to use Roslyn API to write powerful extensions and contribute to the C# developer tool chain, then this book is for you. Additionally, if you are just a .NET developer and want to use this rich Roslyn-based functionality in Visual Studio to improve the code quality and maintenance of your code base, then this book is also for you. This book is divided into the following broad modules: 1. Writing and consuming analyzers/fixers (Chapters 1 - 5): You will learn to write different categories of Roslyn analyzers and harness and configure analyzers in your C# projects to catch quality, security and performance issues. Moving ahead, you will learn how to improve code maintenance and readability by using code fixes and refactorings and also learn how to write them. 2. Using Roslyn-based agile development features (Chapters 6 and 7): You will learn how to improve developer productivity in Visual Studio by using features such as live unit testing, C# interactive and scripting. 3. Contributing to the C# language and compiler tool chain (Chapters 8 - 10): You will see the power of open-sourcing the Roslyn compiler via the simple steps this book provides; thus, you will contribute a completely new C# language feature and implement it in the Roslyn compiler codebase. Finally, you will write simple command line tools based on the Roslyn service API to analyze and edit C# code.

What you will learn

• Write extensions to analyze source code and report warnings and errors.

• Edit C# source code to fix compiler/analyzer diagnostics or refactor source code.

• Improve code maintenance and readability by using analyzers and code fixes.

• Catch security and performance issues by using PUMA scan analyzers and FxCop analyzers.

• Perform Live Unit tests in Visual Studio.

• Use C# interactive and scripting in Visual Studio.

• Design a new C# language feature and implement various compiler phases for a new language feature.

• Write command line tools to analyze and edit C# code.

What do you get with eBook?