Skip to content

Commit

Permalink
Update readme files (#1366)
Browse files Browse the repository at this point in the history
  • Loading branch information
josefpihrt committed Jan 24, 2024
1 parent 2bc998b commit 94fa430
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 2 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,15 @@

Roslynator is a set of code analysis tools for C#, powered by [Roslyn](https://github.com/dotnet/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](https://www.nuget.org/packages/roslynator.analyzers)) instead.

## Tools

- IDE extensions for:
- [Visual Studio](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022)
- [VS Code](https://marketplace.visualstudio.com/items?itemName=josefpihrt-vscode.roslynator)
- Prerequisite is to use OmniSharp. Otherwise (i.e. C# Dev Kit), use NuGet packages with analyzers, refactorings and code fixes.
- [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)
Expand Down
3 changes: 3 additions & 0 deletions src/VisualStudio/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
* [List of code fixes for CS diagnostics](https://josefpihrt.github.io/docs/roslynator/fixes)
* [Release notes](https://github.com/dotnet/roslynator/blob/main/ChangeLog.md)

IMPORTANT: Analyzers will be removed from Roslynator extension in the next major release.
As a replacement, use Roslynator NuGet packages (e.g. [Roslynator.Analyzers](https://www.nuget.org/packages/roslynator.analyzers)).

## Donation

Although Roslynator is 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.
Expand Down
13 changes: 11 additions & 2 deletions src/VisualStudioCode/package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,25 @@

A collection of 500+ [analyzers](https://josefpihrt.github.io/docs/roslynator/analyzers), [refactorings](https://josefpihrt.github.io/docs/roslynator/refactorings) and [fixes](https://josefpihrt.github.io/docs/roslynator/fixes) for C#, powered by [Roslyn](https://github.com/dotnet/roslyn).

## Instructions After First Installation
IMPORTANT: Analyzers will be removed from Roslynator for VS Code in the next major release.
It's recommended to use Roslynator NuGet packages (e.g. [Roslynator.Analyzers](https://www.nuget.org/packages/roslynator.analyzers)) instead.

## Prerequsities

Prerequisite for this extension is to use OmniSharp:

- Set VS Code setting `dotnet.server.useOmnisharp` to `true`
- Disable extension **C# Dev Kit** (if installed)

NOTE: After each installation, Roslynator updates `omnisharp.json` to include references to Roslynator DLLs.

[C# Dev Kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) currently does not support loading Roslyn features from an extension (see related [issue](https://github.com/dotnet/vscode-csharp/issues/6790)), which means that this extension won't work with C# Dev Kit.
As an alternative, it's possible to use NuGet packages that provide [refactorings](https://www.nuget.org/packages/roslynator.refactorings)
and [code fixes for compiler diagnostics](https://www.nuget.org/packages/roslynator.codefixes).

## Configuration

Use EditorConfig file to configure analyzers, refactoring and compiler diagnostic fixes.
Use EditorConfig file to configure analyzers, refactorings and compiler diagnostic fixes.

```editorconfig
# Set severity for all analyzers that are enabled by default (https://docs.microsoft.com/en-us/visualstudio/code-quality/use-roslyn-analyzers?view=vs-2022#set-rule-severity-of-multiple-analyzer-rules-at-once-in-an-editorconfig-file)
Expand Down

0 comments on commit 94fa430

Please sign in to comment.