You can start with watching this 2-minute overview video where Matt Ellis shows how ReSharper helps you to maintain the entire configuration of formatting rules using EditorConfig.
What is EditorConfig and how does ReSharper extend it?
EditorConfig is a configuration file convention that is used to define and maintain consistent code styles between team members working on the same code as well as between different editors and IDEs that they might use. The styles are saved in INI-like files named .editorconfig, where section names are file masks and properties inside a section define code styles for files matching that masks.
As EditorConfig convention suggests, ReSharper will apply code styles defined in files named .editorconfig in the directory of the current file and in all its parent directories until it reaches the root filepath or finds an EditorConfig file with
root=true. File masks specified in .editorconfig files, for example
*Test.cs are also taken into account.
ReSharper understands standard EditorConfig properties, most frequently used .NET-coding-convention EditorConfig properties, and provides a set of custom EditorConfig properties, which allow for much more granular configuration of formatting, syntax, and code inspection rules — in fact, each code style preference that you can configure in the ReSharper options dialog has ist own EditorConfig property. This means that you can maintain the entire configuration of code style and inspection rules in EditorConfig files. Below is an example of EditorConfig properties supported by ReSharper:
EditorConfig in your solution
By default, EditorConfig properties are enabled for code formatting styles and code syntax styles, and disabled for code inspection severity levels; they will override preferences defined in ReSharper and Visual Studio options. If you want ReSharper to ignore EditorConfig styles for code formatting and code syntax, clear the corresponding checkbox on the page of ReSharper options.
When EditorConfig support is enabled and there are .editorconfig files that affect the current file, ReSharper will help you understand which EditorConfig styles are applied and where these settings come from:
On ReSharper code style and formatting options pages, you will see a yellow warning if at least one preference on the page is overridden by EditorConfig styles for the current file, each overridden preference will also be highlighted with yellow. For example:
In the File Formatting Info window, you can see and study all .editorconfig files that affect the current file:
Exporting code style settings to EditorConfig
If you are going to share code style settings via EditorConfig, you may want to export the styles already configured in ReSharper to an .editorconfig file.
To export code style settings to EditorConfig
In the Code style configuration files section, click Write current style to .editorconfig. This will open the .editorconfig dialog.
By default, ReSharper writes the settings to the .editorconfig file in the root directory of the current solution. If necessary, you can change the destination file using the path selector at the top of the dialog.
In the Section (file mask) field, specify a wildcard pattern to use for the section with generated properties. Note that if you choose to export standard EditorConfig properties, they will be placed in other sections according to language conventions.
For more detailed configuration, you can expand Show additional options and choose the following options:
Export settings that have default values
By default, ReSharper only saves properties for settings that you have changed. So only these settings will apply and override other settings when the resulting .editorconfig is read by ReSharper or Rider. All other settings will take values specified in the IDE.
If you enable this option, ReSharper will save all settings in their current state, regardless whether they were changed or not. This way you will get a stricter .editorconfig that will override all code style and formatting settings when read by ReSharper or Rider.
Remove existing properties with ambiguous values
Some EditorConfig properties could correspond to multiple ReSharper-specific properties, which allow for a more precise configuration. So there could be situations when a more general property agrees with some related ReSharper-specific properties and contradicts to others, which makes this more general property ambiguous.
As more detailed properties have higher priority, such a situation is not a problem and there is no need to remove properties with ambiguous values.
The only case when you may want to remove properties with ambiguous values is when the project EditorConfig styles are going to be read only by ReSharper and Rider, and you want to remove redundancies from the .editorconfig file.
Export standard .editorconfig properties — whether to save standard .editorconfig properties These properties will also apply if the generated EditorConfig is read by other editors and IDEs.
Export cross-editor language-specific properties — whether to save .NET-coding-convention properties. These properties will also apply if the generated EditorConfig is read by other editors and IDEs.
Export JetBrains Rider/ReSharper-specific inspection severities — whether to save severity levels for ReSharper's configurable code inspections.
If there is an existing .editorconfig file in the specified location, there could be conflicts between values of properties that exist there and the ones that ReSharper is about to generate. Such properties will be shown in red, and if you proceed with exporting the conflicts will be resolved in favor of the newly generated ones.
Click Export. ReSharper will create or update the .editorconfig file in the specified location.
You can also save formatting styles to EditorConfig after contextual configuration of formatting rules.
Disabling ReSharper formatter with EditorConfig
Standard EditorConfig properties support note
ReSharper will apply the following standard EditorConfig properties:
indent_size property with csharp_indent_size and js_indent_size properties.
.NET-coding-convention properties support note
As of version 2019.2, ReSharper supports most frequently used EditorConfig properties for the .NET coding conventions:
The following properties for the formatting conventions:
The following properties for the language conventions:
This feature is supported in the following languages and technologies:
The instructions and examples given here address the use of the feature in C#. For details specific to other languages, see corresponding topics in the ReSharper by Language section.