Configure C# code style with EditorConfig

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 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 those masks.

As EditorConfig convention suggests, JetBrains Fleet 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.

JetBrains Fleet 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 . Below is an example of EditorConfig properties supported by JetBrains Fleet:

root = true
[*]
# Most of the standard properties are supported
indent_size=2
max_line_length=100

# Most frequently used .NET-coding-convention properties are supported
csharp_space_between_parentheses=expressions, type_casts, control_flow_statements
csharp_style_var_for_built_in_types=true

# dotnet_diagnostic rules are supported
dotnet_diagnostic.CS1058.severity = hint

# JetBrains Fleet custom properties for code formatting styles
resharper_csharp_brace_style=next_line
resharper_csharp_blank_lines_around_invocable=2

# JetBrains Fleet custom properties for code syntax styles
csharp_default_private_modifier=explicit
braces_for_ifelse=not_required

# JetBrains Fleet custom properties for code inspections
resharper_possible_null_reference_exception_highlighting=error
resharper_replace_with_string_is_null_or_empty_highlighting=none

In C#, you can disable the JetBrains Fleet formatter using EditorConfig masks that have disable_formatter=true.

JetBrains Fleet will apply the following standard EditorConfig properties:

• indent_size

• indent_style

• tab_width

• max_line_length

• insert_final_newline

Note that among JetBrains Fleet's custom EditorConfig properties, there are properties that will override the standard properties for specific languages. For example, you can set a default indent size for all languages with indent_size property, and at the same set a different indent size for C# files with csharp_indent_size property.

Custom EditorConfig properties that JetBrains Fleet provides, allow configuring code style and code inspection settings. Properties for code inspections can be found in the List of code inspections in C#. Properties for code style and formatting settings are listed in the child pages of the Reformat C# code topic.

As of version 1.8, JetBrains Fleet supports most frequently used EditorConfig properties for the .NET coding conventions:

• csharp_indent_braces

• csharp_indent_switch_labels

• csharp_new_line_before_catch

• csharp_new_line_before_else

• csharp_new_line_before_finally

• csharp_new_line_before_members_in_object_initializers

• csharp_new_line_before_open_brace

• csharp_new_line_between_query_expression_clauses

• csharp_preferred_modifier_order

• csharp_preserve_single_line_blocks

• csharp_space_after_cast

• csharp_space_after_colon_in_inheritance_clause

• csharp_space_after_comma

• csharp_space_after_dot

• csharp_space_after_keywords_in_control_flow_statements

• csharp_space_after_semicolon_in_for_statement

• csharp_space_around_binary_operators

• csharp_space_before_colon_in_inheritance_clause

• csharp_space_before_comma

• csharp_space_before_dot

• csharp_space_before_open_square_brackets

• csharp_space_before_semicolon_in_for_statement

• csharp_space_between_empty_square_brackets

• csharp_space_between_method_call_empty_parameter_list_parentheses

• csharp_space_between_method_call_name_and_opening_parenthesis

• csharp_space_between_method_call_parameter_list_parentheses

• csharp_space_between_method_declaration_empty_parameter_list_parentheses

• csharp_space_between_method_declaration_name_and_open_parenthesis

• csharp_space_between_method_declaration_parameter_list_parentheses

• csharp_space_between_parentheses

• csharp_space_between_square_brackets

• csharp_style_var_elsewhere

• csharp_style_var_for_built_in_types

• csharp_style_var_when_type_is_apparent

• csharp_using_directive_placement

• dotnet_style_parentheses_in_arithmetic_binary_operators

• dotnet_style_parentheses_in_other_binary_operators

• dotnet_style_parentheses_in_relational_binary_operators

• dotnet_style_predefined_type_for_locals_parameters_members

• dotnet_style_predefined_type_for_member_access

• dotnet_style_qualification_for_event

• dotnet_style_qualification_for_field

• dotnet_style_qualification_for_method

• dotnet_style_qualification_for_property

• dotnet_style_require_accessibility_modifiers

• file_header_template

• csharp_prefer_braces

• csharp_style_expression_bodied_methods

• csharp_style_expression_bodied_constructors

• csharp_style_expression_bodied_properties

• csharp_style_expression_bodied_accessors

• dotnet_separate_import_directive_groups

• dotnet_sort_system_directives_first

• dotnet_diagnostic.* — supported for all compiler warnings.

• dotnet_naming_rule.*, dotnet_naming_style.*, dotnet_naming_symbols.* — will work if the specified kinds of symbols can be matched by kinds of symbols available in JetBrains Fleet naming settings.