-
-
Notifications
You must be signed in to change notification settings - Fork 256
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
41b4247
commit 12824d5
Showing
2,020 changed files
with
3,149 additions
and
68,868 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,96 +1,63 @@ | ||
| # Roslynator <img align="left" width="48px" height="48px" src="http://pihrt.net/images/Roslynator.ico"> | ||
| # Roslynator <img align="left" width="48px" height="48px" src="http://pihrt.net/images/Roslynator.ico" /> | ||
|
|
||
| A collection of 500+ [analyzers](docs/analyzers/README.md), [refactorings](docs/refactorings/README.md) and [fixes](docs/cs/README.md) for C#, powered by [Roslyn](https://github.com/dotnet/roslyn). | ||
| Roslynator is a set of code analysis tools for C#, powered by [Roslyn](https://github.com/dotnet/roslyn). | ||
|
|
||
| ### Features | ||
| ## Tools | ||
|
|
||
| * [Extensions for Visual Studio](#extensions-for-visual-studio) | ||
| * [NuGet Packages](#nuget-packages) | ||
| * [Roslynator Client Libraries](#roslynator-client-libraries) | ||
| * [Roslynator Command Line Tool](#roslynator-command-line-tool) | ||
| * [Roslynator for VS Code](#extensions-for-vs-code) | ||
| * [Release notes](ChangeLog.md) | ||
| * Follow on [Twitter](https://twitter.com/roslynator) | ||
| - IDE extensions for: | ||
| - [Visual Studio](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022) | ||
| - [VS Code](https://marketplace.visualstudio.com/items?itemName=josefpihrt-vscode.roslynator) | ||
| - [Open VSX](https://open-vsx.org/extension/josefpihrt-vscode/roslynator) | ||
| - [NuGet packages](#nuget-packages) that contain collection of analyzers | ||
| - [Roslynator.Analyzers](https://www.nuget.org/packages/Roslynator.Analyzers) | ||
| - [Roslynator.CodeAnalysis.Analyzers](https://www.nuget.org/packages/Roslynator.CodeAnalysis.Analyzers) | ||
| - [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers) | ||
| - [Testing framework](testing-framework) that allows unit testing of analyzers, refactoring and code fixes | ||
| - [.NET client libraries](ref) that extend Roslyn API | ||
| - [Command line tool](#command-line-tool) | ||
|
|
||
| ### Donation | ||
|
|
||
| * Although Roslynator products are free of charge, any [donation](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BX85UA346VTN6) is welcome and supports further development. | ||
| * [List of donations](Donations.md) | ||
| ## Documentation | ||
|
|
||
| ## Extensions for Visual Studio | ||
| - [Configuration](https://josefpihrt.github.io/docs/roslynator/configuration) | ||
| - [Guides](https://josefpihrt.github.io/docs/roslynator/guides) | ||
| - [Roslynator CLI](https://josefpihrt.github.io/docs/roslynator/cli) | ||
| - [Roslynator Client Libraries](https://josefpihrt.github.io/docs/roslynator/ref) | ||
|
|
||
| | Extension | Comment | | ||
| | --- | --- | | ||
| | [Roslynator 2022](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022) | contains analyzers, refactorings and fixes for C# compiler diagnostics. | | ||
| | [Roslynator 2019](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2019) | contains analyzers, refactorings and fixes for C# compiler diagnostics. | | ||
| ## Contributions | ||
|
|
||
| ## Extensions for VS Code | ||
| Contributions are welcome! If you are interested please see: | ||
| - documentation for [developers](https://josefpihrt.github.io/docs/roslynator/developers) | ||
| - available [issues](https://github.com/JosefPihrt/Roslynator/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Aup-for-grabs) | ||
|
|
||
| | Extension | Comment | | ||
| | --- | --- | | ||
| | [Roslynator](https://marketplace.visualstudio.com/items?itemName=josefpihrt-vscode.roslynator) | contains analyzers, refactorings and fixes for C# compiler diagnostics. | | ||
| TIP: Bugfixes or small improvements can be implemented right away. Larger task like adding new analyzer or refactoring should be discussed first. | ||
|
|
||
| ## Extensions for VS Code Compatible Editors | ||
| ## Command Line Tool | ||
|
|
||
| | Extension | Comment | | ||
| | --- | --- | | ||
| | [Roslynator](https://open-vsx.org/extension/josefpihrt-vscode/roslynator) | contains analyzers, refactorings and fixes for C# compiler diagnostics. | | ||
| Run following command to install Roslynator command line tool: | ||
| ```sh | ||
| dotnet tool install -g roslynator.dotnet.cli | ||
| ``` | ||
|
|
||
| ## NuGet Packages | ||
| See [documentation](https://josefpihrt.github.io/docs/roslynator/cli) for further information. | ||
|
|
||
| | Package | Version | Comment | | ||
| | --- | --- | --- | | ||
| | [Roslynator.Analyzers](https://www.nuget.org/packages/Roslynator.Analyzers) | [](https://www.nuget.org/packages/Roslynator.Analyzers) | common analyzers (RCS1xxx) ([list](http://pihrt.net/Roslynator/Analyzers?Query=RCS1)) | | ||
| | [Roslynator.CodeAnalysis.Analyzers](https://www.nuget.org/packages/Roslynator.CodeAnalysis.Analyzers) | [](https://www.nuget.org/packages/Roslynator.CodeAnalysis.Analyzers) | analyzers for Roslyn API (RCS9xxx) ([list](http://pihrt.net/Roslynator/Analyzers?Query=RCS9)) | | ||
| | [Roslynator.Formatting.Analyzers](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers) | [](https://www.nuget.org/packages/Roslynator.Formatting.Analyzers) | formatting analyzers (RCS0xxx) ([list](http://pihrt.net/Roslynator/Analyzers?Query=RCS0)) | | ||
| ## Testing Framework | ||
|
|
||
| *Note: All analyzers in package Roslynator.Formatting.Analyzers are disabled by default.* | ||
| - Roslynator Testing Framework can be used for unit testing of analyzers, refactorings and code fixes. | ||
| - Framework is distributed as NuGet [package](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit).  [](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit) | ||
| - Learn how to use the framework from actual usages in Roslynator repo: | ||
| - Tests of analyzers are [here](https://github.com/JosefPihrt/Roslynator/tree/main/src/Tests/Analyzers.Tests), [here](https://github.com/JosefPihrt/Roslynator/tree/main/src/Tests/CodeAnalysis.Analyzers.Tests) and [here](https://github.com/JosefPihrt/Roslynator/tree/main/src/Tests/Formatting.Analyzers.Tests) | ||
| - Tests of refactorings are [here](https://github.com/JosefPihrt/Roslynator/tree/main/src/Tests/Refactorings.Tests) | ||
| - Tests of fixes of compiler diagnostics are [here](https://github.com/JosefPihrt/Roslynator/tree/main/src/Tests/CodeFixes.Tests) | ||
|
|
||
| ## Roslynator Client Libraries | ||
| ## 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](docs/api/README.md). | ||
| - Roslynator client libraries are meant be used for development of your own analyzers/refactorings. | ||
| - It does not contain any analyzers/refactorings itself. | ||
| - See [reference](https://josefpihrt.github.io/docs/roslynator/ref). | ||
|
|
||
| | Package | Version | Built on top of | | ||
| | Package | Version | Extends | | ||
| | --- | --- | --- | | ||
| | [Roslynator.Core](https://www.nuget.org/packages/Roslynator.Core) | [](https://www.nuget.org/packages/Roslynator.Core) | [Microsoft.CodeAnalysis.Common](https://www.nuget.org/packages/Microsoft.CodeAnalysis.Common) | | ||
| | [Roslynator.Workspaces.Core](https://www.nuget.org/packages/Roslynator.Workspaces.Core) | [](https://www.nuget.org/packages/Roslynator.Workspaces.Core) | [Microsoft.CodeAnalysis.Workspaces.Common](https://www.nuget.org/packages/Microsoft.CodeAnalysis.Workspaces.Common) | | ||
| | [Roslynator.CSharp](https://www.nuget.org/packages/Roslynator.CSharp) | [](https://www.nuget.org/packages/Roslynator.CSharp) | [Microsoft.CodeAnalysis.CSharp](https://www.nuget.org/packages/Microsoft.CodeAnalysis.CSharp) | | ||
| | [Roslynator.CSharp.Workspaces](https://www.nuget.org/packages/Roslynator.CSharp.Workspaces) | [](https://www.nuget.org/packages/Roslynator.CSharp.Workspaces) | [Microsoft.CodeAnalysis.CSharp.Workspaces](https://www.nuget.org/packages/Microsoft.CodeAnalysis.CSharp.Workspaces) | | ||
|
|
||
| ## Roslynator Command Line Tool  [](https://www.nuget.org/packages/Roslynator.DotNet.Cli) | ||
|
|
||
| Run following command to install Roslynator command line tool: | ||
| ``` | ||
| dotnet tool install -g roslynator.dotnet.cli | ||
| ``` | ||
|
|
||
| * [Documentation](docs/cli/README.md) | ||
| * [Change log](src/CommandLine/ChangeLog.md) | ||
|
|
||
| ## Roslynator Testing Framework | ||
|
|
||
| * Roslynator Testing Framework can be used for unit testing of analyzers, refactorings and code fixes. | ||
| * Framework is distributed as NuGet [package](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit).  [](https://www.nuget.org/packages/Roslynator.Testing.CSharp.Xunit) | ||
| * Learn how to use the framework from actual usages in Roslynator repo: | ||
| * Tests of analyzers are [here](src/Tests/Analyzers.Tests), [here](src/Tests/CodeAnalysis.Analyzers.Tests) and [here](src/Tests/Formatting.Analyzers.Tests) | ||
| * Tests of refactorings are [here](src/Tests/Refactorings.Tests) | ||
| * Tests of fixes of compiler diagnostics are [here](src/Tests/CodeFixes.Tests) | ||
|
|
||
| ## Documentation | ||
|
|
||
| * [How to Configure Roslynator](docs/Configuration.md) | ||
| * [Analyzers vs. Refactorings](docs/AnalyzersVsRefactorings.md) | ||
| * [How to Fix All Diagnostics in a Solution](docs/HowToFixAllDiagnostics.md) | ||
| * [How to Generate API Documentation](docs/HowToGenerateDocumentation.md) | ||
|
|
||
| Would you like to improve Roslynator documentation? Please see [how to update documentation](docs/HowToUpdateDocumentation.md). | ||
|
|
||
| ## Other Projects | ||
|
|
||
| * [Snippetica](https://github.com/JosefPihrt/Snippetica) - A collection of snippets for C++, C#, HTML, JSON, Markdown, VB, XAML and XML | ||
| * [DotMarkdown](https://github.com/JosefPihrt/DotMarkdown) - Markdown framework for .NET | ||
| * [LINQ to Regex](https://github.com/JosefPihrt/LinqToRegex) - A library that provides language integrated access to .NET regular expressions | ||
| * [Snippet Manager](https://github.com/JosefPihrt/SnippetManager) - A library that enables to work with Visual Studio snippets | ||
| * [Regexator](http://pihrt.net/Regexator) - A comprehensive development environment for .NET regular expressions |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.