Skip to content

Commit 94fa430

Browse files
authored
Update readme files (#1366)
1 parent 2bc998b commit 94fa430

File tree

3 files changed

+18
-2
lines changed

3 files changed

+18
-2
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,15 @@
22

33
Roslynator is a set of code analysis tools for C#, powered by [Roslyn](https://github.com/dotnet/roslyn).
44

5+
IMPORTANT: Analyzers will be removed from Roslynator IDE extensions in the next major release.
6+
It's recommended to use Roslynator NuGet packages (e.g. [Roslynator.Analyzers](https://www.nuget.org/packages/roslynator.analyzers)) instead.
7+
58
## Tools
69

710
- IDE extensions for:
811
- [Visual Studio](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022)
912
- [VS Code](https://marketplace.visualstudio.com/items?itemName=josefpihrt-vscode.roslynator)
13+
- Prerequisite is to use OmniSharp. Otherwise (i.e. C# Dev Kit), use NuGet packages with analyzers, refactorings and code fixes.
1014
- [Open VSX](https://open-vsx.org/extension/josefpihrt-vscode/roslynator)
1115
- [NuGet packages](#nuget-packages) that contain collection of analyzers
1216
- [Roslynator.Analyzers](https://www.nuget.org/packages/Roslynator.Analyzers)

src/VisualStudio/Overview.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
* [List of code fixes for CS diagnostics](https://josefpihrt.github.io/docs/roslynator/fixes)
88
* [Release notes](https://github.com/dotnet/roslynator/blob/main/ChangeLog.md)
99

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

1215
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.

src/VisualStudioCode/package/README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,25 @@
22

33
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).
44

5-
## Instructions After First Installation
5+
IMPORTANT: Analyzers will be removed from Roslynator for VS Code in the next major release.
6+
It's recommended to use Roslynator NuGet packages (e.g. [Roslynator.Analyzers](https://www.nuget.org/packages/roslynator.analyzers)) instead.
7+
8+
## Prerequsities
9+
10+
Prerequisite for this extension is to use OmniSharp:
611

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

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

17+
[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.
18+
As an alternative, it's possible to use NuGet packages that provide [refactorings](https://www.nuget.org/packages/roslynator.refactorings)
19+
and [code fixes for compiler diagnostics](https://www.nuget.org/packages/roslynator.codefixes).
20+
1221
## Configuration
1322

14-
Use EditorConfig file to configure analyzers, refactoring and compiler diagnostic fixes.
23+
Use EditorConfig file to configure analyzers, refactorings and compiler diagnostic fixes.
1524

1625
```editorconfig
1726
# 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)

0 commit comments

Comments
 (0)