Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Newsletter Hub
Free Learning
Arrow right icon
timer SALE ENDS IN
0 Days
:
00 Hours
:
00 Minutes
:
00 Seconds
Roslyn Cookbook
Roslyn Cookbook

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

Arrow left icon
Profile Icon Manish Vasani
Arrow right icon
€18.99 per month
Paperback Jul 2017 350 pages 1st Edition
eBook
€20.98 €29.99
Paperback
€36.99
Subscription
Free Trial
Renews at €18.99p/m
Arrow left icon
Profile Icon Manish Vasani
Arrow right icon
€18.99 per month
Paperback Jul 2017 350 pages 1st Edition
eBook
€20.98 €29.99
Paperback
€36.99
Subscription
Free Trial
Renews at €18.99p/m
eBook
€20.98 €29.99
Paperback
€36.99
Subscription
Free Trial
Renews at €18.99p/m

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing
Table of content icon View table of contents Preview book icon Preview Book

Roslyn Cookbook

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

Introduction

Diagnostic analyzers are extensions to the Roslyn C# compiler and Visual Studio IDE to analyze user code and report diagnostics. The user will see these diagnostics in the error list after building the project from Visual Studio and even when building the project on the command line. They will also see the diagnostics live while editing the source code in the Visual Studio IDE. Analyzers can report diagnostics to enforce specific code styles, improve code quality and maintenance, recommend design guidelines, or even report very domain-specific issues, which cannot be covered by the core compiler.

Analyzers can be installed in a .NET project either as a NuGet package or as a VSIX. To get a better understanding of these packaging schemes and learn about the differences in the analyzer experience when installed as a NuGet package versus a VSIX, it is recommended that...

Searching and installing analyzers through the NuGet package manager

In this recipe, we will show you how to search and install analyzer NuGet packages in the NuGet package manager in Visual Studio, and see the analyzer diagnostics from an installed NuGet package shown in project build and as live diagnostics during code editing in Visual Studio.

Getting ready

How to do it...

...

Searching and installing VSIX analyzers through the VS extension gallery

In this recipe, we will show you how to search and install analyzer VSIX packages in the Visual Studio extension manager and see how the analyzer diagnostics from an installed VSIX light up as live diagnostics during code editing in Visual Studio.

Getting ready

How to do it...

...

Viewing and configuring analyzers in solution explorer in Visual Studio

In this recipe, we will show you how to use the Solution explorer in Visual Studio 2017 to view the different analyzers installed in a project, view the implemented analyzer rules in these assemblies, as well as the rule properties (or the descriptor metadata), and configure the rule severity and persist the new severity settings.

Getting ready

You will need to have created and opened a .NET project in Visual Studio 2017 with NuGet-based analyzers installed in the project. Refer to the first recipe in this chapter for installing analyzers in a .NET project.

...

Using the ruleset file and Rule Set editor to configure analyzers

In this recipe, we will show you how to use the ruleset file and the Rule Set editor in Visual Studio to configure the per-project severity of analyzer rules, and illustrate how the severity changes are reflected in the live diagnostics in Visual Studio, as well as command-line builds.

Getting ready

You will need to have created and opened a .NET project in Visual Studio 2017 with NuGet-based analyzers installed in the project. Refer to the first recipe in this chapter for installing analyzers in a .NET project.

How to do it...

...
Left arrow icon Right arrow icon
Download code icon Download Code

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.

Who is this book for?

.NET Developers and architects, who are interested in taking full advantage of the Roslyn based extensions and tools to improve the development processes, will find this book useful. Roslyn contributors, i.e. the producers and C# community developers, will also find this book useful

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.

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Jul 31, 2017
Length: 350 pages
Edition : 1st
Language : English
ISBN-13 : 9781787286832
Vendor :
Microsoft
Category :
Languages :

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing

Product Details

Publication date : Jul 31, 2017
Length: 350 pages
Edition : 1st
Language : English
ISBN-13 : 9781787286832
Vendor :
Microsoft
Category :
Languages :

Packt Subscriptions

See our plans and pricing
Modal Close icon
€18.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
€189.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just €5 each
Feature tick icon Exclusive print discounts
€264.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just €5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total 138.97
ASP.NET Core 2 High Performance
€41.99
C# 7.1 and .NET Core 2.0 ??? Modern Cross-Platform Development
€59.99
Roslyn Cookbook
€36.99
Total 138.97 Stars icon

Table of Contents

10 Chapters
Writing Diagnostic Analyzers Chevron down icon Chevron up icon
Consuming Diagnostic Analyzers in .NET Projects Chevron down icon Chevron up icon
Writing IDE Code Fixes, Refactorings, and Intellisense Completion Providers Chevron down icon Chevron up icon
Improving Code Maintenance of C# Code Base Chevron down icon Chevron up icon
Catch Security Vulnerabilities and Performance Issues in C# Code Chevron down icon Chevron up icon
Live Unit Testing in Visual Studio Enterprise Chevron down icon Chevron up icon
C# Interactive and Scripting Chevron down icon Chevron up icon
Contribute Simple Functionality to Roslyn C# Compiler Open Source Code Chevron down icon Chevron up icon
Design and Implement a New C# Language Feature Chevron down icon Chevron up icon
Command-Line Tools Based on Roslyn API Chevron down icon Chevron up icon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is included in a Packt subscription? Chevron down icon Chevron up icon

A subscription provides you with full access to view all Packt and licnesed content online, this includes exclusive access to Early Access titles. Depending on the tier chosen you can also earn credits and discounts to use for owning content

How can I cancel my subscription? Chevron down icon Chevron up icon

To cancel your subscription with us simply go to the account page - found in the top right of the page or at https://subscription.packtpub.com/my-account/subscription - From here you will see the ‘cancel subscription’ button in the grey box with your subscription information in.

What are credits? Chevron down icon Chevron up icon

Credits can be earned from reading 40 section of any title within the payment cycle - a month starting from the day of subscription payment. You also earn a Credit every month if you subscribe to our annual or 18 month plans. Credits can be used to buy books DRM free, the same way that you would pay for a book. Your credits can be found in the subscription homepage - subscription.packtpub.com - clicking on ‘the my’ library dropdown and selecting ‘credits’.

What happens if an Early Access Course is cancelled? Chevron down icon Chevron up icon

Projects are rarely cancelled, but sometimes it's unavoidable. If an Early Access course is cancelled or excessively delayed, you can exchange your purchase for another course. For further details, please contact us here.

Where can I send feedback about an Early Access title? Chevron down icon Chevron up icon

If you have any feedback about the product you're reading, or Early Access in general, then please fill out a contact form here and we'll make sure the feedback gets to the right team. 

Can I download the code files for Early Access titles? Chevron down icon Chevron up icon

We try to ensure that all books in Early Access have code available to use, download, and fork on GitHub. This helps us be more agile in the development of the book, and helps keep the often changing code base of new versions and new technologies as up to date as possible. Unfortunately, however, there will be rare cases when it is not possible for us to have downloadable code samples available until publication.

When we publish the book, the code files will also be available to download from the Packt website.

How accurate is the publication date? Chevron down icon Chevron up icon

The publication date is as accurate as we can be at any point in the project. Unfortunately, delays can happen. Often those delays are out of our control, such as changes to the technology code base or delays in the tech release. We do our best to give you an accurate estimate of the publication date at any given time, and as more chapters are delivered, the more accurate the delivery date will become.

How will I know when new chapters are ready? Chevron down icon Chevron up icon

We'll let you know every time there has been an update to a course that you've bought in Early Access. You'll get an email to let you know there has been a new chapter, or a change to a previous chapter. The new chapters are automatically added to your account, so you can also check back there any time you're ready and download or read them online.

I am a Packt subscriber, do I get Early Access? Chevron down icon Chevron up icon

Yes, all Early Access content is fully available through your subscription. You will need to have a paid for or active trial subscription in order to access all titles.

How is Early Access delivered? Chevron down icon Chevron up icon

Early Access is currently only available as a PDF or through our online reader. As we make changes or add new chapters, the files in your Packt account will be updated so you can download them again or view them online immediately.

How do I buy Early Access content? Chevron down icon Chevron up icon

Early Access is a way of us getting our content to you quicker, but the method of buying the Early Access course is still the same. Just find the course you want to buy, go through the check-out steps, and you’ll get a confirmation email from us with information and a link to the relevant Early Access courses.

What is Early Access? Chevron down icon Chevron up icon

Keeping up to date with the latest technology is difficult; new versions, new frameworks, new techniques. This feature gives you a head-start to our content, as it's being created. With Early Access you'll receive each chapter as it's written, and get regular updates throughout the product's development, as well as the final course as soon as it's ready.We created Early Access as a means of giving you the information you need, as soon as it's available. As we go through the process of developing a course, 99% of it can be ready but we can't publish until that last 1% falls in to place. Early Access helps to unlock the potential of our content early, to help you start your learning when you need it most. You not only get access to every chapter as it's delivered, edited, and updated, but you'll also get the finalized, DRM-free product to download in any format you want when it's published. As a member of Packt, you'll also be eligible for our exclusive offers, including a free course every day, and discounts on new and popular titles.