|
1 | | -; EditorConfig to support per-solution formatting. |
2 | | -; Use the EditorConfig VS add-in to make this work. |
3 | | -; http://editorconfig.org/ |
4 | | - |
5 | | -; This is the default for the codeline. |
6 | | -root = true |
7 | | - |
8 | | -[*] |
9 | | -end_of_line = CRLF |
10 | | - |
11 | | -[*.{config,cs,xml}] |
12 | | -indent_style = space |
13 | | -indent_size = 4 |
14 | | -trim_trailing_whitespace = true |
15 | | - |
16 | | -[*.{proj,props,sln,targets}] |
17 | | -indent_style = tab |
18 | | -trim_trailing_whitespace = true |
19 | | - |
20 | | -[*.{kproj,csproj,json,ps1,psd1,psm1,resx,rst}] |
21 | | -indent_style = space |
22 | | -indent_size = 2 |
23 | | -trim_trailing_whitespace = true |
24 | | - |
25 | | -[NuGet.Config] |
26 | | -indent_style = space |
27 | | -indent_size = 2 |
28 | | -trim_trailing_whitespace = true |
| 1 | +; EditorConfig to support per-solution formatting. |
| 2 | +; Use the EditorConfig VS add-in to make this work. |
| 3 | +; http://editorconfig.org/ |
| 4 | + |
| 5 | +; This is the default for the codeline. |
| 6 | +root = true |
| 7 | + |
| 8 | +[*] |
| 9 | +indent_style = space |
| 10 | +trim_trailing_whitespace = true |
| 11 | +insert_final_newline = true |
| 12 | + |
| 13 | +; .NET Code - almost, but not exactly, the same suggestions as corefx |
| 14 | +; https://github.com/dotnet/corefx/blob/master/.editorconfig |
| 15 | +[*.cs] |
| 16 | +indent_size = 4 |
| 17 | +charset = utf-8-bom |
| 18 | + |
| 19 | +; New line preferences |
| 20 | +csharp_new_line_before_open_brace = all |
| 21 | +csharp_new_line_before_else = true |
| 22 | +csharp_new_line_before_catch = true |
| 23 | +csharp_new_line_before_finally = true |
| 24 | +csharp_new_line_before_members_in_object_initializers = true |
| 25 | +csharp_new_line_before_members_in_anonymous_types = true |
| 26 | +csharp_new_line_between_query_expression_clauses = true |
| 27 | + |
| 28 | +; Indentation preferences |
| 29 | +csharp_indent_block_contents = true |
| 30 | +csharp_indent_braces = false |
| 31 | +csharp_indent_case_contents = true |
| 32 | +csharp_indent_case_contents_when_block = true |
| 33 | +csharp_indent_switch_labels = true |
| 34 | +csharp_indent_labels = one_less_than_current |
| 35 | + |
| 36 | +; Modifier preferences |
| 37 | +csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion |
| 38 | + |
| 39 | +; Avoid this. unless absolutely necessary |
| 40 | +dotnet_style_qualification_for_field = false:suggestion |
| 41 | +dotnet_style_qualification_for_property = false:suggestion |
| 42 | +dotnet_style_qualification_for_method = false:suggestion |
| 43 | +dotnet_style_qualification_for_event = false:suggestion |
| 44 | + |
| 45 | +; Types: use keywords instead of BCL types, using var is fine. |
| 46 | +csharp_style_var_when_type_is_apparent = false:none |
| 47 | +dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion |
| 48 | +dotnet_style_predefined_type_for_member_access = true:suggestion |
| 49 | + |
| 50 | +; Name all constant fields using PascalCase |
| 51 | +dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion |
| 52 | +dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields |
| 53 | +dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style |
| 54 | +dotnet_naming_symbols.constant_fields.applicable_kinds = field |
| 55 | +dotnet_naming_symbols.constant_fields.required_modifiers = const |
| 56 | +dotnet_naming_style.pascal_case_style.capitalization = pascal_case |
| 57 | + |
| 58 | +; Static fields should be PascalCase |
| 59 | +dotnet_naming_rule.static_fields_should_be_pascal_case.severity = suggestion |
| 60 | +dotnet_naming_rule.static_fields_should_be_pascal_case.symbols = static_fields |
| 61 | +dotnet_naming_rule.static_fields_should_be_pascal_case.style = pascal_case_style |
| 62 | +dotnet_naming_symbols.static_fields.applicable_kinds = field |
| 63 | +dotnet_naming_symbols.static_fields.required_modifiers = static |
| 64 | +dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected |
| 65 | + |
| 66 | +; Internal and private fields should be _camelCase |
| 67 | +dotnet_naming_rule.camel_case_for_private_internal_fields.severity = suggestion |
| 68 | +dotnet_naming_rule.camel_case_for_private_internal_fields.symbols = private_internal_fields |
| 69 | +dotnet_naming_rule.camel_case_for_private_internal_fields.style = camel_case_underscore_style |
| 70 | +dotnet_naming_symbols.private_internal_fields.applicable_kinds = field |
| 71 | +dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal |
| 72 | +dotnet_naming_style.camel_case_underscore_style.required_prefix = _ |
| 73 | +dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case |
| 74 | + |
| 75 | +; Code style defaults |
| 76 | +csharp_using_directive_placement = outside_namespace:suggestion |
| 77 | +dotnet_sort_system_directives_first = true |
| 78 | +csharp_prefer_braces = true:refactoring |
| 79 | +csharp_preserve_single_line_blocks = true:none |
| 80 | +csharp_preserve_single_line_statements = false:none |
| 81 | +csharp_prefer_static_local_function = true:suggestion |
| 82 | +csharp_prefer_simple_using_statement = false:none |
| 83 | +csharp_style_prefer_switch_expression = true:suggestion |
| 84 | + |
| 85 | +; Code quality |
| 86 | +dotnet_style_readonly_field = true:suggestion |
| 87 | +dotnet_code_quality_unused_parameters = non_public:suggestion |
| 88 | + |
| 89 | +; Expression-level preferences |
| 90 | +dotnet_style_object_initializer = true:suggestion |
| 91 | +dotnet_style_collection_initializer = true:suggestion |
| 92 | +dotnet_style_explicit_tuple_names = true:suggestion |
| 93 | +dotnet_style_coalesce_expression = true:suggestion |
| 94 | +dotnet_style_null_propagation = true:suggestion |
| 95 | +dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion |
| 96 | +dotnet_style_prefer_inferred_tuple_names = true:suggestion |
| 97 | +dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion |
| 98 | +dotnet_style_prefer_auto_properties = true:suggestion |
| 99 | +dotnet_style_prefer_conditional_expression_over_assignment = true:refactoring |
| 100 | +dotnet_style_prefer_conditional_expression_over_return = true:refactoring |
| 101 | +csharp_prefer_simple_default_expression = true:suggestion |
| 102 | + |
| 103 | +# Expression-bodied members |
| 104 | +csharp_style_expression_bodied_methods = true:refactoring |
| 105 | +csharp_style_expression_bodied_constructors = true:refactoring |
| 106 | +csharp_style_expression_bodied_operators = true:refactoring |
| 107 | +csharp_style_expression_bodied_properties = true:refactoring |
| 108 | +csharp_style_expression_bodied_indexers = true:refactoring |
| 109 | +csharp_style_expression_bodied_accessors = true:refactoring |
| 110 | +csharp_style_expression_bodied_lambdas = true:refactoring |
| 111 | +csharp_style_expression_bodied_local_functions = true:refactoring |
| 112 | + |
| 113 | +# Pattern matching |
| 114 | +csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion |
| 115 | +csharp_style_pattern_matching_over_as_with_null_check = true:suggestion |
| 116 | +csharp_style_inlined_variable_declaration = true:suggestion |
| 117 | + |
| 118 | +# Null checking preferences |
| 119 | +csharp_style_throw_expression = true:suggestion |
| 120 | +csharp_style_conditional_delegate_call = true:suggestion |
| 121 | + |
| 122 | +# Other features |
| 123 | +csharp_style_prefer_index_operator = false:none |
| 124 | +csharp_style_prefer_range_operator = false:none |
| 125 | +csharp_style_pattern_local_over_anonymous_function = false:none |
| 126 | + |
| 127 | +# Space preferences |
| 128 | +csharp_space_after_cast = false |
| 129 | +csharp_space_after_colon_in_inheritance_clause = true |
| 130 | +csharp_space_after_comma = true |
| 131 | +csharp_space_after_dot = false |
| 132 | +csharp_space_after_keywords_in_control_flow_statements = true |
| 133 | +csharp_space_after_semicolon_in_for_statement = true |
| 134 | +csharp_space_around_binary_operators = before_and_after |
| 135 | +csharp_space_around_declaration_statements = do_not_ignore |
| 136 | +csharp_space_before_colon_in_inheritance_clause = true |
| 137 | +csharp_space_before_comma = false |
| 138 | +csharp_space_before_dot = false |
| 139 | +csharp_space_before_open_square_brackets = false |
| 140 | +csharp_space_before_semicolon_in_for_statement = false |
| 141 | +csharp_space_between_empty_square_brackets = false |
| 142 | +csharp_space_between_method_call_empty_parameter_list_parentheses = false |
| 143 | +csharp_space_between_method_call_name_and_opening_parenthesis = false |
| 144 | +csharp_space_between_method_call_parameter_list_parentheses = false |
| 145 | +csharp_space_between_method_declaration_empty_parameter_list_parentheses = false |
| 146 | +csharp_space_between_method_declaration_name_and_open_parenthesis = false |
| 147 | +csharp_space_between_method_declaration_parameter_list_parentheses = false |
| 148 | +csharp_space_between_parentheses = false |
| 149 | +csharp_space_between_square_brackets = false |
| 150 | + |
| 151 | +; .NET project files and MSBuild - match defaults for VS |
| 152 | +[*.{csproj,nuspec,proj,projitems,props,shproj,targets,vbproj,vcxproj,vcxproj.filters,vsixmanifest,vsct}] |
| 153 | +indent_size = 2 |
| 154 | + |
| 155 | +; .NET solution files - match defaults for VS |
| 156 | +[*.sln] |
| 157 | +indent_style = tab |
| 158 | + |
| 159 | +; Config - match XML and default nuget.config template |
| 160 | +[*.config] |
| 161 | +indent_size = 2 |
| 162 | + |
| 163 | +; Resources - match defaults for VS |
| 164 | +[*.resx] |
| 165 | +indent_size = 2 |
| 166 | + |
| 167 | +; Static analysis rulesets - match defaults for VS |
| 168 | +[*.ruleset] |
| 169 | +indent_size = 2 |
| 170 | + |
| 171 | +; HTML, XML - match defaults for VS |
| 172 | +[*.{cshtml,html,xml}] |
| 173 | +indent_size = 4 |
| 174 | + |
| 175 | +; JavaScript and JS mixes - match eslint settings; JSON also matches .NET Core templates |
| 176 | +[*.{js,json,ts,vue}] |
| 177 | +indent_size = 2 |
| 178 | + |
| 179 | +; Markdown - match markdownlint settings |
| 180 | +[*.{md,markdown}] |
| 181 | +indent_size = 2 |
| 182 | + |
| 183 | +; PowerShell - match defaults for New-ModuleManifest and PSScriptAnalyzer Invoke-Formatter |
| 184 | +[*.{ps1,psd1,psm1}] |
| 185 | +indent_size = 4 |
| 186 | +charset = utf-8-bom |
| 187 | + |
| 188 | +; ReStructuredText - standard indentation format from examples |
| 189 | +[*.rst] |
| 190 | +indent_size = 2 |
0 commit comments