general .editorconfig

.editorconfig

root = true

[*]
ignore_if_in_header = This code was generated by a tool|<auto-generated>
indent_style = space
indent_size = 4
; uncomment to help with sharing files across os's (i.e. network share or through local vm)
#end_of_line = lf
charset = utf-8
insert_final_newline = true

[*.asmdef]
scrape_api = true
indent_size = 4

[**/Tests/**.asmdef]
scrape_api = false

[*.Tests.asmdef]
scrape_api = false

[*.md]
indent_size = 2
; trailing whitespace is unfortunately significant in markdown
trim_trailing_whitespace = false
; uncomment to enable basic formatting of markdown files
#formatters = generic

[{Makefile,makefile}]
; tab characters are part of the Makefile format
indent_style = tab

[*.json]
indent_size = 2

[*.{vcproj,bat,cmd,xaml,tt,t4,ttinclude}]
end_of_line = crlf

; this VS-specific stuff is based on experiments to see how VS will modify a file after it has been manually edited.
; the settings are meant to closely match what VS does to minimize unnecessary diffs.
[*.{vcxproj,vcxproj.filters}]
indent_style = space
indent_size = 2
end_of_line = crlf
charset = utf-8-bom
trim_trailing_whitespace = true
insert_final_newline = false
; must be broken out because of 51-char bug (https://github.com/editorconfig/editorconfig-visualstudio/issues/21)
[*.{csproj,pyproj,props,targets}]
indent_style = space
indent_size = 2
end_of_line = crlf
charset = utf-8-bom
trim_trailing_whitespace = true
insert_final_newline = false
[*.{sln,sln.template}]
indent_style = tab
indent_size = 4
end_of_line = crlf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = false

[*.cs]
indent_style = space
indent_size = 2
indent_with_tabs = 2
insert_final_newline = true

# New line preferences
csharp_new_line_before_open_brace = none
csharp_new_line_before_else = false
csharp_new_line_before_catch = false
csharp_new_line_before_finally = false
csharp_new_line_before_members_in_object_initializers = true
csharp_new_line_before_members_in_anonymous_types = true
csharp_new_line_between_query_expression_clauses = true

# Indentation preferences
csharp_indent_block_contents = true
csharp_indent_braces = false
csharp_indent_case_contents = true
csharp_indent_case_contents_when_block = false
csharp_indent_switch_labels = true
csharp_indent_labels = one_less_than_current

dotnet_diagnostic.IDE0055.severity = suggestion
dotnet_diagnostic.IDE0058.severity = none
dotnet_diagnostic.IDE0059.severity = none
dotnet_diagnostic.IDE0130.severity = none

# Modifier preferences
csharp_preferred_modifier_order = public,private,protected,internal,file,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async:suggestion

# avoid this. unless absolutely necessary
dotnet_style_qualification_for_field = false:suggestion
dotnet_style_qualification_for_property = false:suggestion
dotnet_style_qualification_for_method = false:suggestion
dotnet_style_qualification_for_event = false:suggestion

# Types: use keywords instead of BCL types, and permit var only when the type is clear
csharp_style_var_for_built_in_types = false:suggestion
csharp_style_var_when_type_is_apparent = false:none
csharp_style_var_elsewhere = false:suggestion
dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
dotnet_style_predefined_type_for_member_access = true:suggestion

# "ALL_UPPER" style - constant fields
dotnet_naming_rule.all_upper_rule.style    = all_upper_style
dotnet_naming_rule.all_upper_rule.symbols  = all_upper_symbol
dotnet_naming_rule.all_upper_rule.severity = suggestion
dotnet_naming_symbols.all_upper_symbol.applicable_kinds   = field
dotnet_naming_symbols.all_upper_symbol.required_modifiers = const
dotnet_naming_style.all_upper_style.capitalization = all_upper

# "PascalCase " style - event, property, enum
dotnet_naming_rule.pascal_case_rule.style = pascal_case_style
dotnet_naming_rule.pascal_case_rule.symbols = pascal_case_symbol
dotnet_naming_rule.pascal_case_rule.severity = suggestion
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
dotnet_naming_symbols.pascal_case_symbol.applicable_kinds = event, property, enum
dotnet_naming_symbols.pascal_case_symbol.applicable_accessibilities = *

# "OnPascalCase" style - event
dotnet_naming_rule.on_prefix_pascal_case_rule.style = on_prefix_pascal_case_style
dotnet_naming_rule.on_prefix_pascal_case_rule.symbols = on_prefix_pascal_case_symbol
dotnet_naming_rule.on_prefix_pascal_case_rule.severity = suggestion
dotnet_naming_style.on_prefix_pascal_case_style.capitalization = pascal_case
dotnet_naming_style.on_prefix_pascal_case_style.required_prefix = On
dotnet_naming_symbols.on_prefix_pascal_case_symbol.applicable_kinds = event
dotnet_naming_symbols.on_prefix_pascal_case_symbol.applicable_accessibilities = *

# "s_PascalCase" style - private/internal/private_protected static field
dotnet_naming_rule.s_prefix_pascal_case_rule.style    = s_prefix_pascal_case_style
dotnet_naming_rule.s_prefix_pascal_case_rule.symbols  = s_prefix_pascal_case_symbol
dotnet_naming_rule.s_prefix_pascal_case_rule.severity = suggestion
dotnet_naming_style.s_prefix_pascal_case_style.required_prefix = s_
dotnet_naming_style.s_prefix_pascal_case_style.capitalization = pascal_case
dotnet_naming_symbols.s_prefix_pascal_case_symbol.applicable_kinds   = field
dotnet_naming_symbols.s_prefix_pascal_case_symbol.required_modifiers = static
dotnet_naming_symbols.s_prefix_pascal_case_symbol.applicable_accessibilities = private, internal, private_protected

# "_camelCase" style - private/internal/protected instance field
dotnet_naming_rule.underscore_prefix_camel_case_rule.style    = underscore_prefix_camel_case_style
dotnet_naming_rule.underscore_prefix_camel_case_rule.symbols  = underscore_prefix_camel_case_symbol
dotnet_naming_rule.underscore_prefix_camel_case_rule.severity = suggestion
dotnet_naming_style.underscore_prefix_camel_case_style.required_prefix = _
dotnet_naming_style.underscore_prefix_camel_case_style.capitalization = camel_case
dotnet_naming_symbols.underscore_prefix_camel_case_symbol.applicable_kinds = field
dotnet_naming_symbols.underscore_prefix_camel_case_symbol.applicable_accessibilities = protected, private

# "camelCase" style - public instance field
dotnet_naming_rule.camel_case_rule.style = camel_case_style
dotnet_naming_rule.camel_case_rule.symbols  = came_case_symbol
dotnet_naming_rule.camel_case_rule.severity = suggestion
dotnet_naming_style.camel_case_style.capitalization = camel_case
dotnet_naming_symbols.came_case_symbol.applicable_kinds = field
dotnet_naming_symbols.came_case_symbol.applicable_accessibilities = public, internal

# Code style defaults
csharp_using_directive_placement = outside_namespace:suggestion
dotnet_sort_system_directives_first = true
csharp_prefer_braces = true:silent
csharp_preserve_single_line_blocks = true:suggestion
csharp_preserve_single_line_statements = false:suggestion
csharp_prefer_static_local_function = true:suggestion
csharp_prefer_simple_using_statement = false:none
csharp_style_prefer_switch_expression = true:suggestion
dotnet_style_readonly_field = true:suggestion

# Expression-level preferences
dotnet_style_object_initializer = true:suggestion
dotnet_style_collection_initializer = true:suggestion
dotnet_style_prefer_collection_expression = when_types_exactly_match
dotnet_style_explicit_tuple_names = true:suggestion
dotnet_style_coalesce_expression = true:suggestion
dotnet_style_null_propagation = true:suggestion
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
dotnet_style_prefer_inferred_tuple_names = true:suggestion
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_auto_properties = true:suggestion
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
dotnet_style_prefer_conditional_expression_over_return = true:silent
csharp_prefer_simple_default_expression = true:suggestion

# Expression-bodied members
csharp_style_expression_bodied_methods = false:silent
csharp_style_expression_bodied_constructors = false:silent
csharp_style_expression_bodied_operators = true:silent
csharp_style_expression_bodied_properties = true:silent
csharp_style_expression_bodied_indexers = true:silent
csharp_style_expression_bodied_accessors = true:silent
csharp_style_expression_bodied_lambdas = true:silent
csharp_style_expression_bodied_local_functions = true:silent

# Pattern matching
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
csharp_style_inlined_variable_declaration = true:suggestion

# Null checking preferences
csharp_style_throw_expression = true:suggestion
csharp_style_conditional_delegate_call = true:suggestion

# Other features
csharp_style_prefer_index_operator = false:none
csharp_style_prefer_range_operator = false:none
csharp_style_pattern_local_over_anonymous_function = false:none

# Space preferences
csharp_space_after_cast = false
csharp_space_after_colon_in_inheritance_clause = true
csharp_space_after_comma = true
csharp_space_after_dot = false
csharp_space_after_keywords_in_control_flow_statements = true
csharp_space_after_semicolon_in_for_statement = true
csharp_space_around_binary_operators = before_and_after
csharp_space_around_declaration_statements = do_not_ignore
csharp_space_before_colon_in_inheritance_clause = true
csharp_space_before_comma = false
csharp_space_before_dot = false
csharp_space_before_open_square_brackets = false
csharp_space_before_semicolon_in_for_statement = false
csharp_space_between_empty_square_brackets = false
csharp_space_between_method_call_empty_parameter_list_parentheses = false
csharp_space_between_method_call_name_and_opening_parenthesis = false
csharp_space_between_method_call_parameter_list_parentheses = false
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
csharp_space_between_method_declaration_name_and_open_parenthesis = false
csharp_space_between_method_declaration_parameter_list_parentheses = false
csharp_space_between_parentheses = false
csharp_space_between_square_brackets = false

[*.lua]
indent_size = 2