.editorconfig 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  1. # With more recent updates Visual Studio 2017 supports EditorConfig files out of the box
  2. # Visual Studio Code needs an extension: https://github.com/editorconfig/editorconfig-vscode
  3. # For emacs, vim, np++ and other editors, see here: https://github.com/editorconfig
  4. ###############################
  5. # Core EditorConfig Options #
  6. ###############################
  7. root = true
  8. # All files
  9. [*]
  10. indent_style = space
  11. indent_size = 4
  12. charset = utf-8
  13. trim_trailing_whitespace = true
  14. insert_final_newline = true
  15. end_of_line = lf
  16. max_line_length = null
  17. # XML indentation
  18. [*.{csproj,xml}]
  19. indent_size = 2
  20. ###############################
  21. # .NET Coding Conventions #
  22. ###############################
  23. [*.{cs,vb}]
  24. # Organize usings
  25. dotnet_sort_system_directives_first = true
  26. # this. preferences
  27. dotnet_style_qualification_for_field = false:silent
  28. dotnet_style_qualification_for_property = false:silent
  29. dotnet_style_qualification_for_method = false:silent
  30. dotnet_style_qualification_for_event = false:silent
  31. # Language keywords vs BCL types preferences
  32. dotnet_style_predefined_type_for_locals_parameters_members = true:silent
  33. dotnet_style_predefined_type_for_member_access = true:silent
  34. # Parentheses preferences
  35. dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
  36. dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
  37. dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
  38. dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
  39. # Modifier preferences
  40. dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
  41. dotnet_style_readonly_field = true:suggestion
  42. # Expression-level preferences
  43. dotnet_style_object_initializer = true:suggestion
  44. dotnet_style_collection_initializer = true:suggestion
  45. dotnet_style_explicit_tuple_names = true:suggestion
  46. dotnet_style_null_propagation = true:suggestion
  47. dotnet_style_coalesce_expression = true:suggestion
  48. dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent
  49. dotnet_prefer_inferred_tuple_names = true:suggestion
  50. dotnet_prefer_inferred_anonymous_type_member_names = true:suggestion
  51. dotnet_style_prefer_auto_properties = true:silent
  52. dotnet_style_prefer_conditional_expression_over_assignment = true:silent
  53. dotnet_style_prefer_conditional_expression_over_return = true:silent
  54. ###############################
  55. # Naming Conventions #
  56. ###############################
  57. # Style Definitions (From Roslyn)
  58. # Non-private static fields are PascalCase
  59. dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.severity = suggestion
  60. dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.symbols = non_private_static_fields
  61. dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.style = non_private_static_field_style
  62. dotnet_naming_symbols.non_private_static_fields.applicable_kinds = field
  63. dotnet_naming_symbols.non_private_static_fields.applicable_accessibilities = public, protected, internal, protected internal, private protected
  64. dotnet_naming_symbols.non_private_static_fields.required_modifiers = static
  65. dotnet_naming_style.non_private_static_field_style.capitalization = pascal_case
  66. # Constants are PascalCase
  67. dotnet_naming_rule.constants_should_be_pascal_case.severity = suggestion
  68. dotnet_naming_rule.constants_should_be_pascal_case.symbols = constants
  69. dotnet_naming_rule.constants_should_be_pascal_case.style = constant_style
  70. dotnet_naming_symbols.constants.applicable_kinds = field, local
  71. dotnet_naming_symbols.constants.required_modifiers = const
  72. dotnet_naming_style.constant_style.capitalization = pascal_case
  73. # Static fields are camelCase and start with s_
  74. dotnet_naming_rule.static_fields_should_be_camel_case.severity = suggestion
  75. dotnet_naming_rule.static_fields_should_be_camel_case.symbols = static_fields
  76. dotnet_naming_rule.static_fields_should_be_camel_case.style = static_field_style
  77. dotnet_naming_symbols.static_fields.applicable_kinds = field
  78. dotnet_naming_symbols.static_fields.required_modifiers = static
  79. dotnet_naming_style.static_field_style.capitalization = camel_case
  80. dotnet_naming_style.static_field_style.required_prefix = _
  81. # Instance fields are camelCase and start with _
  82. dotnet_naming_rule.instance_fields_should_be_camel_case.severity = suggestion
  83. dotnet_naming_rule.instance_fields_should_be_camel_case.symbols = instance_fields
  84. dotnet_naming_rule.instance_fields_should_be_camel_case.style = instance_field_style
  85. dotnet_naming_symbols.instance_fields.applicable_kinds = field
  86. dotnet_naming_style.instance_field_style.capitalization = camel_case
  87. dotnet_naming_style.instance_field_style.required_prefix = _
  88. # Locals and parameters are camelCase
  89. dotnet_naming_rule.locals_should_be_camel_case.severity = suggestion
  90. dotnet_naming_rule.locals_should_be_camel_case.symbols = locals_and_parameters
  91. dotnet_naming_rule.locals_should_be_camel_case.style = camel_case_style
  92. dotnet_naming_symbols.locals_and_parameters.applicable_kinds = parameter, local
  93. dotnet_naming_style.camel_case_style.capitalization = camel_case
  94. # Local functions are PascalCase
  95. dotnet_naming_rule.local_functions_should_be_pascal_case.severity = suggestion
  96. dotnet_naming_rule.local_functions_should_be_pascal_case.symbols = local_functions
  97. dotnet_naming_rule.local_functions_should_be_pascal_case.style = local_function_style
  98. dotnet_naming_symbols.local_functions.applicable_kinds = local_function
  99. dotnet_naming_style.local_function_style.capitalization = pascal_case
  100. # By default, name items with PascalCase
  101. dotnet_naming_rule.members_should_be_pascal_case.severity = suggestion
  102. dotnet_naming_rule.members_should_be_pascal_case.symbols = all_members
  103. dotnet_naming_rule.members_should_be_pascal_case.style = pascal_case_style
  104. dotnet_naming_symbols.all_members.applicable_kinds = *
  105. dotnet_naming_style.pascal_case_style.capitalization = pascal_case
  106. ###############################
  107. # C# Coding Conventions #
  108. ###############################
  109. [*.cs]
  110. # var preferences
  111. csharp_style_var_for_built_in_types = true:silent
  112. csharp_style_var_when_type_is_apparent = true:silent
  113. csharp_style_var_elsewhere = true:silent
  114. # Expression-bodied members
  115. csharp_style_expression_bodied_methods = false:silent
  116. csharp_style_expression_bodied_constructors = false:silent
  117. csharp_style_expression_bodied_operators = false:silent
  118. csharp_style_expression_bodied_properties = true:silent
  119. csharp_style_expression_bodied_indexers = true:silent
  120. csharp_style_expression_bodied_accessors = true:silent
  121. # Pattern matching preferences
  122. csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
  123. csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
  124. # Null-checking preferences
  125. csharp_style_throw_expression = true:suggestion
  126. csharp_style_conditional_delegate_call = true:suggestion
  127. # Modifier preferences
  128. csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
  129. # Expression-level preferences
  130. csharp_prefer_braces = true:silent
  131. csharp_style_deconstructed_variable_declaration = true:suggestion
  132. csharp_prefer_simple_default_expression = true:suggestion
  133. csharp_style_pattern_local_over_anonymous_function = true:suggestion
  134. csharp_style_inlined_variable_declaration = true:suggestion
  135. ###############################
  136. # C# Formatting Rules #
  137. ###############################
  138. # New line preferences
  139. csharp_new_line_before_open_brace = all
  140. csharp_new_line_before_else = true
  141. csharp_new_line_before_catch = true
  142. csharp_new_line_before_finally = true
  143. csharp_new_line_before_members_in_object_initializers = true
  144. csharp_new_line_before_members_in_anonymous_types = true
  145. csharp_new_line_between_query_expression_clauses = true
  146. # Indentation preferences
  147. csharp_indent_case_contents = true
  148. csharp_indent_switch_labels = true
  149. csharp_indent_labels = flush_left
  150. # Space preferences
  151. csharp_space_after_cast = false
  152. csharp_space_after_keywords_in_control_flow_statements = true
  153. csharp_space_between_method_call_parameter_list_parentheses = false
  154. csharp_space_between_method_declaration_parameter_list_parentheses = false
  155. csharp_space_between_parentheses = false
  156. csharp_space_before_colon_in_inheritance_clause = true
  157. csharp_space_after_colon_in_inheritance_clause = true
  158. csharp_space_around_binary_operators = before_and_after
  159. csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
  160. csharp_space_between_method_call_name_and_opening_parenthesis = false
  161. csharp_space_between_method_call_empty_parameter_list_parentheses = false
  162. # Wrapping preferences
  163. csharp_preserve_single_line_statements = true
  164. csharp_preserve_single_line_blocks = true
  165. ###############################
  166. # VB Coding Conventions #
  167. ###############################
  168. [*.vb]
  169. # Modifier preferences
  170. visual_basic_preferred_modifier_order = Partial,Default,Private,Protected,Public,Friend,NotOverridable,Overridable,MustOverride,Overloads,Overrides,MustInherit,NotInheritable,Static,Shared,Shadows,ReadOnly,WriteOnly,Dim,Const,WithEvents,Widening,Narrowing,Custom,Async:suggestion