almaraubel / roslynator

Roslynator is a set of code analysis tools for C#, powered by Roslyn.

Roslynator

Roslynator is a set of code analysis tools for C#, powered by Roslyn.

Tools

• IDE extensions for:
  • Visual Studio
  • VS Code
  • Open VSX
• NuGet packages that contain collection of analyzers
  • Roslynator.Analyzers
  • Roslynator.CodeAnalysis.Analyzers
  • Roslynator.Formatting.Analyzers
• Testing framework that allows unit testing of analyzers, refactoring and code fixes
• .NET client libraries that extend Roslyn API
• Command line tool

Documentation

• Configuration
• Guides
• Roslynator CLI
• Roslynator Client Libraries

Contributions

Contributions are welcome! If you are interested please see:

• documentation for developers
• available issues

TIP: Bugfixes or small improvements can be implemented right away. Larger task like adding new analyzer or refactoring should be discussed first.

.NET Foundation

This project is supported by the .NET Foundation.

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

Command Line Tool

Run following command to install Roslynator command line tool:

dotnet tool install -g roslynator.dotnet.cli

See documentation for further information.

Testing Framework

• Roslynator Testing Framework can be used for unit testing of analyzers, refactorings and code fixes.
• Framework is distributed as NuGet package.  
• Learn how to use the framework from actual usages in Roslynator repo:
  • Tests of analyzers are here, here and here
  • Tests of refactorings are here
  • Tests of fixes of compiler diagnostics are here

Client Libraries

• Roslynator client libraries are meant be used for development of your own analyzers/refactorings.
• It does not contain any analyzers/refactorings itself.
• See reference.

Package	Version	Extends
Roslynator.Core		Microsoft.CodeAnalysis.Common
Roslynator.Workspaces.Core		Microsoft.CodeAnalysis.Workspaces.Common
Roslynator.CSharp		Microsoft.CodeAnalysis.CSharp
Roslynator.CSharp.Workspaces		Microsoft.CodeAnalysis.CSharp.Workspaces