JetBrains Rider 2018.1 Help

Using .NET Compiler Platform (Roslyn) Analyzers

JetBrains Rider provides over 2000 code inspections in all supported languages, but if this is not enough, JetBrains Rider allows you to additionally use .NET Compiler Platform (Roslyn) Analyzers.

These analyzers may be helpful for code analysis to deeper understand specific frameworks, as many teams are writing their own analyzers to provide additional tooling for the frameworks they build. For example the xUnit.net folks have a set of Roslyn-based analyzers helps with things like making sure xUnit-specific Fact methods do not have parameters.

Roslyn analyzer support is disabled by default. You can enable and configure it on the Editor | Inspection Settings | Roslyn Analyzers page of JetBrains Rider settings (Ctrl+Alt+S). Once enabled and settings are saved, Rider will scan for installed Roslyn analyzers. All code inspections from discovered analysers will be displayed on that settings page and you will be able to change severity levels in the same way as for JetBrains Rider native inspections.

There are two ways to install Roslyn analyzers:

  • If the desired analyzer ships as a NuGet package, you can use JetBrains Rider’s NuGet client to find and install it.
    As of version 2018.1, this way only works for .NET Core projects.
  • You can referencing the analyzer's .dll in the project's .csproj file by adding <Analyzer Include="path\to\analyzers.dll">.

All code inspection features including quick-fixes and solution-wide analysis are also available for inspections from external analyzers.

External analyzers may also run as part of the project build. If an analyzer has a default severity of warning or error, it display the corresponding issues in the build output.

Here is an example of installing and using the DisableDateTimeNow analyzer in a .NET Core web application. DisableDateTimeNow is a simple analyzer that finds usages of DateTime.Now and suggests replacing them with DateTime.UtcNow.

Last modified: 19 April 2018