.editorconfig

root = true

[*]
indent_style                  = space
indent_size                   = 4
trim_trailing_whitespace      = true
insert_final_newline          = true
max_line_length               = 160
space_before_self_closing     = true
space_inside_empty_tag        = true

[*.{md,markdown,json,js,ts,jsx,tsx,csproj,fsproj,targets,targets,props,json,yml,yaml,razor,xml,html,xhtml,proto,code-workspace,graphql,gql}]
indent_size = 2

[*.go]
# Gofmt is persistent on using tabs instead of spaces
indent_size = 4
indent_style = tab

[*.{tf,tfvars,editorconfig,ini,toml}]
indent_size                    = 2
align_group_field_declarations = true

[*.{sh,env}]
end_of_line = lf

# Dotnet code style settings:
[*.{cs,vb}]

##########################################
# .NET Language Conventions
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions
##########################################

# "this." and "Me." qualifiers
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#this-and-me
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

# Use language keywords instead of framework type names for type references
dotnet_style_predefined_type_for_locals_parameters_members       = true:error
dotnet_style_predefined_type_for_member_access                   = true:error

# Modifier preferences
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#normalize-modifiers
dotnet_style_require_accessibility_modifiers                     = for_non_interface_members:error
csharp_preferred_modifier_order                                  = public, private, protected, internal, static, extern, new, virtual, abstract, sealed, override, readonly, unsafe, volatile, async:error
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
dotnet_style_readonly_field                                      = true:error

# Parentheses preferences
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#parentheses-preferences
dotnet_style_parentheses_in_arithmetic_binary_operators          = always_for_clarity:error
dotnet_style_parentheses_in_relational_binary_operators          = always_for_clarity:error
dotnet_style_parentheses_in_other_binary_operators               = always_for_clarity:error
dotnet_style_parentheses_in_other_operators                      = never_if_unnecessary:suggestion

# Expression-level preferences
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#expression-level-preferences
dotnet_style_object_initializer                                  = true:error
dotnet_style_collection_initializer                              = true:error
dotnet_style_explicit_tuple_names                                = true:error
dotnet_style_prefer_inferred_tuple_names                         = true:error
dotnet_style_prefer_inferred_anonymous_type_member_names         = true:error
dotnet_style_prefer_auto_properties                              = true:error
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:error
dotnet_style_prefer_conditional_expression_over_assignment       = false:suggestion
dotnet_style_prefer_conditional_expression_over_return           = false:suggestion
dotnet_style_prefer_compound_assignment                          = true:error

# Null-checking preferences
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#null-checking-preferences
dotnet_style_coalesce_expression                                 = true:error
dotnet_style_null_propagation                                    = true:error

# Parameter preferences
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#parameter-preferences
dotnet_code_quality_unused_parameters                            = all:error

# More style options (Undocumented)
# https://github.com/MicrosoftDocs/visualstudio-docs/issues/3641
dotnet_style_operator_placement_when_wrapping                    = end_of_line
# https://github.com/dotnet/roslyn/pull/40070
dotnet_style_prefer_simplified_interpolation                     = true:error


##########################################
# C# Code Style Settings
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#c-code-style-settings
##########################################
[*.{cs}]

# Implicit and explicit types
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#implicit-and-explicit-types
csharp_style_var_for_built_in_types                       = true:error
csharp_style_var_when_type_is_apparent                    = true:error
csharp_style_var_elsewhere                                = true:error

# Expression-bodied members
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#expression-bodied-members
csharp_style_expression_bodied_methods                    = true:silent
csharp_style_expression_bodied_constructors               = false:error
csharp_style_expression_bodied_operators                  = true:suggestion
csharp_style_expression_bodied_properties                 = true:suggestion
csharp_style_expression_bodied_indexers                   = true:suggestion
csharp_style_expression_bodied_accessors                  = true:suggestion
csharp_style_expression_bodied_lambdas                    = true:suggestion
csharp_style_expression_bodied_local_functions            = true:suggestion

# Pattern matching
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#pattern-matching
csharp_style_pattern_matching_over_is_with_cast_check     = true:error
csharp_style_pattern_matching_over_as_with_null_check     = true:error

# Inlined variable declarations
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#inlined-variable-declarations
csharp_style_inlined_variable_declaration                 = true:error

# Expression-level preferences
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#expression-level-preferences
csharp_prefer_simple_default_expression                   = true:error

# "Null" checking preferences
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#c-null-checking-preferences
csharp_style_throw_expression                             = true:error
csharp_style_conditional_delegate_call                    = true:error

# Code block preferences
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#code-block-preferences
csharp_prefer_braces                                      = true:error

# Unused value preferences
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#unused-value-preferences
csharp_style_unused_value_expression_statement_preference = discard_variable:none
csharp_style_unused_value_assignment_preference           = discard_variable:suggestion

# Index and range preferences
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#index-and-range-preferences
csharp_style_prefer_index_operator                        = true:error
csharp_style_prefer_range_operator                        = true:error

# Miscellaneous preferences
# https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#miscellaneous-preferences
csharp_style_deconstructed_variable_declaration           = true:error
csharp_style_pattern_local_over_anonymous_function        = true:error
csharp_style_namespace_declarations                       = file_scoped:warning
csharp_using_directive_placement                          = outside_namespace:error
csharp_prefer_static_local_function                       = true:error
csharp_prefer_simple_using_statement                      = true:suggestion
csharp_blank_lines_around_single_line_property            = 1
csharp_blank_lines_around_single_line_auto_property       = 1
csharp_blank_lines_around_single_line_invocable           = 1

##########################################
# C# Formatting Conventions
# https://docs.microsoft.com/visualstudio/ide/editorconfig-code-style-settings-reference#formatting-conventions
##########################################
[*.{cs}]

# Organize usings
# https://docs.microsoft.com/visualstudio/ide/editorconfig-formatting-conventions#organize-using-directives
dotnet_sort_system_directives_first                                      = true
dotnet_separate_import_directive_groups                                  = false

# Newline options
# https://docs.microsoft.com/visualstudio/ide/editorconfig-formatting-conventions#new-line-options
csharp_new_line_before_open_brace                                        = all
csharp_new_line_before_else                                              = true
csharp_new_line_before_catch                                             = true
csharp_new_line_before_finally                                           = true
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 options
# https://docs.microsoft.com/visualstudio/ide/editorconfig-formatting-conventions#indentation-options
csharp_indent_case_contents                                              = true
csharp_indent_switch_labels                                              = true
csharp_indent_labels                                                     = no_change
csharp_indent_block_contents                                             = true
csharp_indent_braces                                                     = false
csharp_indent_case_contents_when_block                                   = false

# Spacing options
# https://docs.microsoft.com/visualstudio/ide/editorconfig-formatting-conventions#spacing-options
csharp_space_after_cast                                                  = false
csharp_space_after_keywords_in_control_flow_statements                   = true
csharp_space_between_parentheses                                         = false
csharp_space_before_colon_in_inheritance_clause                          = true
csharp_space_after_colon_in_inheritance_clause                           = true
csharp_space_around_binary_operators                                     = before_and_after
csharp_space_between_method_declaration_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_call_parameter_list_parentheses              = false
csharp_space_between_method_call_empty_parameter_list_parentheses        = false
csharp_space_between_method_call_name_and_opening_parenthesis            = false
csharp_space_after_comma                                                 = true
csharp_space_before_comma                                                = false
csharp_space_after_dot                                                   = false
csharp_space_before_dot                                                  = false
csharp_space_after_semicolon_in_for_statement                            = true
csharp_space_before_semicolon_in_for_statement                           = false
csharp_space_around_declaration_statements                               = false
csharp_space_before_open_square_brackets                                 = false
csharp_space_between_empty_square_brackets                               = false
csharp_space_between_square_brackets                                     = false
csharp_space_within_single_line_array_initializer_braces                 = true

# Wrapping options
# https://docs.microsoft.com/visualstudio/ide/editorconfig-formatting-conventions#wrap-options
csharp_preserve_single_line_statements                                   = false
csharp_preserve_single_line_blocks                                       = true
csharp_place_type_constraints_on_same_line                               = false
csharp_wrap_after_invocation_lpar                                        = true
csharp_wrap_arguments_style                                              = chop_if_long
csharp_wrap_before_binary_opsign                                         = true
csharp_wrap_parameters_style                                             = chop_if_long
csharp_wrap_after_declaration_lpar                                       = true
csharp_wrap_chained_binary_expressions                                   = chop_if_long
csharp_wrap_multiple_type_parameter_constraints_style                    = chop_always

##########################################
# .NET Naming Conventions
# https://docs.microsoft.com/visualstudio/ide/editorconfig-naming-conventions
##########################################

[*.{cs,csx,cake,vb,vbx}]

# camel_case_style - Define the camelCase style
dotnet_naming_style.camel_case_style.capitalization                                            = camel_case
# pascal_case_style - Define the PascalCase style
dotnet_naming_style.pascal_case_style.capitalization                                           = pascal_case
# first_upper_style - The first character must start with an upper-case character
dotnet_naming_style.first_upper_style.capitalization                                           = first_word_upper
# prefix_interface_with_i_style - Interfaces must be PascalCase and the first character of an interface must be an 'I'
dotnet_naming_style.prefix_interface_with_i_style.capitalization                               = pascal_case
dotnet_naming_style.prefix_interface_with_i_style.required_prefix                              = I
# prefix_type_parameters_with_t_style - Generic Type Parameters must be PascalCase and the first character must be a 'T'
dotnet_naming_style.prefix_type_parameters_with_t_style.capitalization                         = pascal_case
dotnet_naming_style.prefix_type_parameters_with_t_style.required_prefix                        = T
# disallowed_style - Anything that has this style applied is marked as disallowed
dotnet_naming_style.disallowed_style.capitalization                                            = pascal_case
dotnet_naming_style.disallowed_style.required_prefix                                           = ____RULE_VIOLATION____
dotnet_naming_style.disallowed_style.required_suffix                                           = ____RULE_VIOLATION____
# internal_error_style - This style should never occur... if it does, it indicates a bug in file or in the parser using the file
dotnet_naming_style.internal_error_style.capitalization                                        = pascal_case
dotnet_naming_style.internal_error_style.required_prefix                                       = ____INTERNAL_ERROR____
dotnet_naming_style.internal_error_style.required_suffix                                       = ____INTERNAL_ERROR____

##########################################
# .NET Design Guideline Field Naming Rules
# Naming rules for fields follow the .NET Framework design guidelines
# https://docs.microsoft.com/dotnet/standard/design-guidelines/index
##########################################

# All public/protected/protected_internal constant fields must be PascalCase
# https://docs.microsoft.com/dotnet/standard/design-guidelines/field
dotnet_naming_symbols.public_protected_constant_fields_group.applicable_accessibilities        = public, protected, protected_internal
dotnet_naming_symbols.public_protected_constant_fields_group.required_modifiers                = const
dotnet_naming_symbols.public_protected_constant_fields_group.applicable_kinds                  = field
dotnet_naming_rule.public_protected_constant_fields_must_be_pascal_case_rule.symbols           = public_protected_constant_fields_group
dotnet_naming_rule.public_protected_constant_fields_must_be_pascal_case_rule.style             = pascal_case_style
dotnet_naming_rule.public_protected_constant_fields_must_be_pascal_case_rule.severity          = warning

# All public/protected/protected_internal static readonly fields must be PascalCase
# https://docs.microsoft.com/dotnet/standard/design-guidelines/field
dotnet_naming_symbols.public_protected_static_readonly_fields_group.applicable_accessibilities = public, protected, protected_internal
dotnet_naming_symbols.public_protected_static_readonly_fields_group.required_modifiers         = static, readonly
dotnet_naming_symbols.public_protected_static_readonly_fields_group.applicable_kinds           = field
dotnet_naming_rule.public_protected_static_readonly_fields_must_be_pascal_case_rule.symbols    = public_protected_static_readonly_fields_group
dotnet_naming_rule.public_protected_static_readonly_fields_must_be_pascal_case_rule.style      = pascal_case_style
dotnet_naming_rule.public_protected_static_readonly_fields_must_be_pascal_case_rule.severity   = warning

# No other public/protected/protected_internal fields are allowed
# https://docs.microsoft.com/dotnet/standard/design-guidelines/field
dotnet_naming_symbols.other_public_protected_fields_group.applicable_accessibilities           = public, protected, protected_internal
dotnet_naming_symbols.other_public_protected_fields_group.applicable_kinds                     = field
dotnet_naming_rule.other_public_protected_fields_disallowed_rule.symbols                       = other_public_protected_fields_group
dotnet_naming_rule.other_public_protected_fields_disallowed_rule.style                         = disallowed_style
dotnet_naming_rule.other_public_protected_fields_disallowed_rule.severity                      = error

##########################################
# StyleCop Field Naming Rules
# Naming rules for fields follow the StyleCop analyzers
# This does not override any rules using disallowed_style above
# https://github.com/DotNetAnalyzers/StyleCopAnalyzers
##########################################

# All constant fields must be PascalCase
# https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1303.md
dotnet_naming_symbols.stylecop_constant_fields_group.applicable_accessibilities                = public, internal, protected_internal, protected, private_protected, private
dotnet_naming_symbols.stylecop_constant_fields_group.required_modifiers                        = const
dotnet_naming_symbols.stylecop_constant_fields_group.applicable_kinds                          = field
dotnet_naming_rule.stylecop_constant_fields_must_be_pascal_case_rule.symbols                   = stylecop_constant_fields_group
dotnet_naming_rule.stylecop_constant_fields_must_be_pascal_case_rule.style                     = pascal_case_style
dotnet_naming_rule.stylecop_constant_fields_must_be_pascal_case_rule.severity                  = warning

# All static readonly fields must be PascalCase
# https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1311.md
dotnet_naming_symbols.stylecop_static_readonly_fields_group.applicable_accessibilities         = public, internal, protected_internal, protected, private_protected, private
dotnet_naming_symbols.stylecop_static_readonly_fields_group.required_modifiers                 = static, readonly
dotnet_naming_symbols.stylecop_static_readonly_fields_group.applicable_kinds                   = field
dotnet_naming_rule.stylecop_static_readonly_fields_must_be_pascal_case_rule.symbols            = stylecop_static_readonly_fields_group
dotnet_naming_rule.stylecop_static_readonly_fields_must_be_pascal_case_rule.style              = pascal_case_style
dotnet_naming_rule.stylecop_static_readonly_fields_must_be_pascal_case_rule.severity           = warning

# No non-private instance fields are allowed
# https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1401.md
dotnet_naming_symbols.stylecop_fields_must_be_private_group.applicable_accessibilities         = public, internal, protected_internal, protected, private_protected
dotnet_naming_symbols.stylecop_fields_must_be_private_group.applicable_kinds                   = field
dotnet_naming_rule.stylecop_instance_fields_must_be_private_rule.symbols                       = stylecop_fields_must_be_private_group
dotnet_naming_rule.stylecop_instance_fields_must_be_private_rule.style                         = disallowed_style
dotnet_naming_rule.stylecop_instance_fields_must_be_private_rule.severity                      = error

# Private fields must be camelCase
# https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1306.md
dotnet_naming_symbols.stylecop_private_fields_group.applicable_accessibilities                 = private
dotnet_naming_symbols.stylecop_private_fields_group.applicable_kinds                           = field
dotnet_naming_rule.stylecop_private_fields_must_be_camel_case_rule.symbols                     = stylecop_private_fields_group
dotnet_naming_rule.stylecop_private_fields_must_be_camel_case_rule.style                       = camel_case_style
dotnet_naming_rule.stylecop_private_fields_must_be_camel_case_rule.severity                    = warning

# Local variables must be camelCase
# https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1312.md
dotnet_naming_symbols.stylecop_local_fields_group.applicable_accessibilities                   = local
dotnet_naming_symbols.stylecop_local_fields_group.applicable_kinds                             = local
dotnet_naming_rule.stylecop_local_fields_must_be_camel_case_rule.symbols                       = stylecop_local_fields_group
dotnet_naming_rule.stylecop_local_fields_must_be_camel_case_rule.style                         = camel_case_style
dotnet_naming_rule.stylecop_local_fields_must_be_camel_case_rule.severity                      = silent

# This rule should never fire.  However, it's included for at least two purposes:
# First, it helps to understand, reason about, and root-case certain types of issues, such as bugs in .editorconfig parsers.
# Second, it helps to raise immediate awareness if a new field type is added (as occurred recently in C#).
dotnet_naming_symbols.sanity_check_uncovered_field_case_group.applicable_accessibilities       = *
dotnet_naming_symbols.sanity_check_uncovered_field_case_group.applicable_kinds                 = field
dotnet_naming_rule.sanity_check_uncovered_field_case_rule.symbols                              = sanity_check_uncovered_field_case_group
dotnet_naming_rule.sanity_check_uncovered_field_case_rule.style                                = internal_error_style
dotnet_naming_rule.sanity_check_uncovered_field_case_rule.severity                             = error


##########################################
# Other Naming Rules
##########################################

# All of the following must be PascalCase:
# - Namespaces
#   https://docs.microsoft.com/dotnet/standard/design-guidelines/names-of-namespaces
#   https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1300.md
# - Classes and Enumerations
#   https://docs.microsoft.com/dotnet/standard/design-guidelines/names-of-classes-structs-and-interfaces
#   https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1300.md
# - Delegates
#   https://docs.microsoft.com/dotnet/standard/design-guidelines/names-of-classes-structs-and-interfaces#names-of-common-types
# - Constructors, Properties, Events, Methods
#   https://docs.microsoft.com/dotnet/standard/design-guidelines/names-of-type-members
dotnet_naming_symbols.element_group.applicable_kinds                                           = namespace, class, enum, struct, delegate, event, method, property
dotnet_naming_rule.element_rule.symbols                                                        = element_group
dotnet_naming_rule.element_rule.style                                                          = pascal_case_style
dotnet_naming_rule.element_rule.severity                                                       = warning

# Interfaces use PascalCase and are prefixed with uppercase 'I'
# https://docs.microsoft.com/dotnet/standard/design-guidelines/names-of-classes-structs-and-interfaces
dotnet_naming_symbols.interface_group.applicable_kinds                                         = interface
dotnet_naming_rule.interface_rule.symbols                                                      = interface_group
dotnet_naming_rule.interface_rule.style                                                        = prefix_interface_with_i_style
dotnet_naming_rule.interface_rule.severity                                                     = warning

# Generics Type Parameters use PascalCase and are prefixed with uppercase 'T'
# https://docs.microsoft.com/dotnet/standard/design-guidelines/names-of-classes-structs-and-interfaces
dotnet_naming_symbols.type_parameter_group.applicable_kinds                                    = type_parameter
dotnet_naming_rule.type_parameter_rule.symbols                                                 = type_parameter_group
dotnet_naming_rule.type_parameter_rule.style                                                   = prefix_type_parameters_with_t_style
dotnet_naming_rule.type_parameter_rule.severity                                                = warning

# Function parameters use camelCase
# https://docs.microsoft.com/dotnet/standard/design-guidelines/naming-parameters
dotnet_naming_symbols.parameters_group.applicable_kinds                                        = parameter
dotnet_naming_rule.parameters_rule.symbols                                                     = parameters_group
dotnet_naming_rule.parameters_rule.style                                                       = camel_case_style
dotnet_naming_rule.parameters_rule.severity                                                    = warning

# https://www.jetbrains.com/help/rider/EditorConfig_CSHARP_LineBreaksPageSchema.html#resharper_csharp_keep_existing_attribute_arrangement
csharp_keep_existing_attribute_arrangement                                                     = true
csharp_wrap_object_and_collection_initializer_style                                            = chop_always