Confused over ruleset files vs editorconfig files

user_981831 0
Viewed 5415

Our organisation uses a ruleset file containing our organisation's StyleCop.Analyzers settings. This lives in source control, and all projects in all solutions in our organisation reference this file. If I edit the ruleset (via project properties -> Code Analysis tab), I see a message prompting me to migrate the ruleset to an editorconfig file. Can someone explain why I would want to do this, and what the difference is between the two?

I've also noticed in VS Tools->Options->Text Editor->C#->Code Style, there are a number of settings eerily similar to many of the StyleCop.Analyzers rules (e.g. several settings relating to the use of "this", vs StyleCop SA1101 "prefix local calls with this"). There is also a button here to create an editorconfig file from these settings, so how would these settings co-exist with the StyleCop.Analyzer settings, and which would take precedence?

Also, our Azure DevOps automated builds report warnings where any code "violates" the StyleCop rules. Will the builds still do this if we replaced the ruleset with an editorconfig file?

Lastly, there is a GUI for editing the StyleCop.Analyzer settings (project properties -> Code Analysis tab -> "Configure" button), whereas editorconfig files seem to be edited using the VS text editor. Given that there are hundreds of rules to manage, where would you get a complete list of rules that needed to be typed in? And wouldn't this be very tedious?

roslyn-code-analysis editorconfig visual-studio-2019 visual-studio
3 Answers

Quotes and pictures are taken from https://docs.microsoft.com/de-de/visualstudio/code-quality/use-roslYn-analyzers?view=vs-2019#rule-severity

Setting a rule's severity in an EditorConfig file takes precedence over any severity that's set in a rule set or in Solution Explorer.

The settings in Visual Studio (VS Tools->Options->Text Editor->C#->Code Style) are used when no .editorconfig file is given or a rule is not configured in it.

In my experience it is best to choose only one way of configuring. Also I experienced that the following describte configuration of the .editorconfig file did not work / or edited the .ruleset as long as any .ruleset file is available.

Configure rule via light bulb Configure rule via light bulb

Configure rule via error window Configure rule via error window

Configure rule via Solution Explorer. This is also a place where you find a list of all available rules. Configure rule via Solution Explorer

Commandline tools respect the .editorconfig file:

When you build your project at the command line, rule violations appear in the build output if the following conditions are met:

  • The analyzers are installed as a NuGet package and not as a VSIX extension.
  • One or more rules are violated in the project's code.
  • The severity of a violated rule is set to either warning, in which case violations on't cause build to fail, or error, in which case violations cause build to fail.
user_20101570
user_12581110

More info about difference between ruleset and editorconfig here : https://docs.microsoft.com/en-us/visualstudio/code-quality/analyzers-faq?view=vs-2019

Rule sets and EditorConfig files can coexist and can both be used to configure analyzers. Both EditorConfig files and rule sets let you enable and disable rules and set their severity.

However, EditorConfig files offer additional ways to configure rules too:

For the .NET code-quality analyzers, EditorConfig files let you define which types of code to analyze. For the .NET code-style analyzers that are built into Visual Studio, EditorConfig files let you define the preferred code styles for a codebase. In addition to rule sets and EditorConfig files, some analyzers are configured through the use of text files marked as additional files for the C# and VB compilers.

user_2449160
Related