Roslynator for Visual Studio Code

A collection of 500+ analyzers, refactorings and fixes for C#, powered by Roslyn.

For further information please with Roslynator repo.

Configuration

To make this extension working it is necessary to add following configuration to %USERPROFILE%.omnisharp\omnisharp.json:

{
  "RoslynExtensionsOptions": {
    "EnableAnalyzersSupport": true,
    "LocationPaths": [
      "%USERPROFILE%/.vscode/extensions/josefpihrt-vscode.roslynator-2.2.0/roslyn/common",
      "%USERPROFILE%/.vscode/extensions/josefpihrt-vscode.roslynator-2.2.0/roslyn/analyzers",
      "%USERPROFILE%/.vscode/extensions/josefpihrt-vscode.roslynator-2.2.0/roslyn/refactorings",
      "%USERPROFILE%/.vscode/extensions/josefpihrt-vscode.roslynator-2.2.0/roslyn/fixes"
    ]
  }
}

Replace %USERPROFILE% with an actual path (such as C:/Users/User).

After each update of the extension it is necessary to update paths to libraries (i.e. replace version in the path with a new version).

Location of Configuration Files

Configuration files are located at %LOCALAPPDATA%\JosefPihrt\Roslynator\VisualStudioCode. Location of %LOCALAPPDATA% depends on the operating system:

Configuration of Analyzers

Standard rule sets are used to configure analyzers on a project-wide basis.

If you want to configure analyzers on a user-wide basis you have to create file at %LOCALAPPDATA%\JosefPihrt\Roslynator\VisualStudioCode\roslynator.ruleset with following content:

<?xml version="1.0" encoding="utf-8"?>
<RuleSet Name="roslynator.ruleset" ToolsVersion="16.0">
  <!-- Specify default action that should be applied to all analyzers except those explicitly specified. -->
  <!-- <IncludeAll Action="None,Hidden,Info,Warning,Error" /> -->
  <Rules AnalyzerId="Roslynator.CSharp.Analyzers" RuleNamespace="Roslynator.CSharp.Analyzers">
    <!-- Specify default action that should be applied to a specified analyzer. -->
    <!-- <Rule Id="RCSxxxx" Action="None,Hidden,Info,Warning,Error" /> -->
  </Rules>
</RuleSet>

This rule set can be used to:

1. Enable/disable analyzer(s) by DEFAULT.
2. Change DEFAULT severity (action) of the analyzer(s).

Configuration of Refactorings and Fixes

Create file at %LOCALAPPDATA%\JosefPihrt\Roslynator\VisualStudioCode\roslynator.config with following content:

<?xml version="1.0" encoding="utf-8"?>
<Roslynator>
  <Settings>
    <General>
      <!-- <PrefixFieldIdentifierWithUnderscore>true</PrefixFieldIdentifierWithUnderscore> -->
    </General>
    <Refactorings>
      <!-- <Refactoring Id="RRxxxx" IsEnabled="false" /> -->
    </Refactorings>
    <CodeFixes>
      <!-- <CodeFix Id="CSxxxx.RCFxxxx" IsEnabled="false" /> -->
      <!-- <CodeFix Id="CSxxxx" IsEnabled="false" /> -->
      <!-- <CodeFix Id="RCFxxxx" IsEnabled="false" /> -->
    </CodeFixes>
  </Settings>
</Roslynator>

Full list of refactorings identifiers can be found here. Full list of fixes identifiers can be found here.

Configuration for analyzers/refactorings/fixes is applied once when libraries are loaded. Therefore, it may be neccessary to restart IDE for changes to take effect.

Requirements

This extension requires C# for Visual Studio Code 1.19.0 or higher.

Donation

Although Roslynator products are free of charge, any donation is welcome and supports further development.

Thanks

Thanks to savpek who pioneered the way for Roslyn analyzers on Visual Studio Code.