Book Image

Roslyn Cookbook

Book Image

Roslyn Cookbook

Overview of this book

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.
Table of Contents (19 chapters)
Title Page
Credits
About the Author
Acknowledgments
About the Reviewer
www.PacktPub.com
Customer Feedback
Preface
Dedication

Creating, debugging, and executing a CodeFixProvider to fix a compiler warning


Code fix providers are IDE extensions to fix diagnostics in source code, which are reported by compilers and/or analyzers. These are built on top of Roslyn's Workspaces layer and operate on the current document being edited. When the user invokes a command such as Ctrl + dot in Visual Studio editor, the IDE code fix engine computes all the diagnostics in the current line span and identifies all the code fix providers that have registered to fix one or more of the reported diagnostics. Each of these code fix providers are then invoked with a code fix context containing the current document, diagnostics, and span. Fixers operate on the underlying syntax tree associated with the document by adding, removing, or editing the syntax nodes within the tree, and returning the new document with the fixed code. They might also alter the contents of the containing project or solution to fix the diagnostic. When the user commits...