README.md

Roslynator

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

IMPORTANT: Analyzers will be removed from Roslynator IDE extensions in the next major release. It's recommended to use Roslynator NuGet packages (e.g. Roslynator.Analyzers) instead.

Tools

• IDE extensions for:
  • Visual Studio
  • VS Code
    • Prerequisite is to use OmniSharp. Otherwise (i.e. C# Dev Kit), use NuGet packages with analyzers, refactorings and code fixes.
  • 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 Testing Framework
• 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.

Donations

Special thanks to:

• .NET on AWS Open Source Software Fund for donating $6000.00 USD ($500.00 for 12 months starting November 2024).
• Microsoft for donating $1000.00 USD.
• @IanKemp for donating $13.00 USD / month starting July 2021.
• @Genbox for donating $5.00 USD / month starting October 2024.

.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.
• See documentation for further information.

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