WalletWasabi/.editorconfig

# You can learn more about .editorconfig here: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference
root = true

# For all files.
[*]

charset = utf-8
insert_final_newline = true

# Formatting - remove any whitespace characters preceding newline characters
trim_trailing_whitespace = true

[*.{cs,csproj,props}]

# use hard tabs for indentation
indent_style = tab
indent_size = 4

# Formatting - set preferred newline characters
end_of_line = lf

[*.{xaml,axaml}]

indent_style = space
indent_size = 2

[*.cs]

# Spell Checker rules
spelling_languages = en-us
spelling_checkable_types = strings,identifiers,comments
spelling_error_severity = information
spelling_exclusion_path = .\exclusion.dic

# require braces to be on a new line for all
csharp_new_line_before_open_brace = all

# Formatting - spacing options

# require NO space between a cast and the value
csharp_space_after_cast = false:error
# require a space before the colon for bases or interfaces in a type declaration
csharp_space_after_colon_in_inheritance_clause = true:error
# require a space after a keyword in a control flow statement such as a for loop
csharp_space_after_keywords_in_control_flow_statements = true:error
# require a space before the colon for bases or interfaces in a type declaration
csharp_space_before_colon_in_inheritance_clause = true:error
# remove space within empty argument list parentheses
csharp_space_between_method_call_empty_parameter_list_parentheses = false:error
# remove space between method call name and opening parenthesis
csharp_space_between_method_call_name_and_opening_parenthesis = false:error
# do not place space characters after the opening parenthesis and before the closing parenthesis of a method call
csharp_space_between_method_call_parameter_list_parentheses = false:error
# remove space within empty parameter list parentheses for a method declaration
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false:error
# place a space character after the opening parenthesis and before the closing parenthesis of a method declaration parameter list.
csharp_space_between_method_declaration_parameter_list_parentheses = false:error

# Formatting - wrapping options

# leave code block on single line
csharp_preserve_single_line_blocks = true:error
# leave statements and member declarations on the same line
csharp_preserve_single_line_statements = true:error

# Style - expression bodied member options

# prefer expression-bodied members for accessors
csharp_style_expression_bodied_accessors = true:suggestion
# prefer block bodies for constructors
csharp_style_expression_bodied_constructors = false:suggestion
# prefer expression-bodied members for operators
csharp_style_expression_bodied_operators = true:suggestion
# prefer expression-bodied members for properties
csharp_style_expression_bodied_properties = true:suggestion

# Style - expression level options

# prefer out variables to be declared inline in the argument list of a method call when possible
csharp_style_inlined_variable_declaration = true:error
csharp_style_deconstructed_variable_declaration = false:warning
# prefer the language keyword for member access expressions, instead of the type name, for types that have a keyword to represent them
dotnet_style_predefined_type_for_member_access = true:error

# Style - language keyword and framework type options

# prefer the language keyword for local variables, method parameters, and class members, instead of the type name, for types that have a keyword to represent them
dotnet_style_predefined_type_for_locals_parameters_members = true:error

# Style - qualification options

# prefer events not to be prefaced with this. or Me. in Visual Basic
dotnet_style_qualification_for_event = false:error
# prefer fields not to be prefaced with this. or Me. in Visual Basic
dotnet_style_qualification_for_field = false:error
# prefer methods not to be prefaced with this. or Me. in Visual Basic
dotnet_style_qualification_for_method = false:error
# prefer properties not to be prefaced with this. or Me. in Visual Basic
dotnet_style_qualification_for_property = false:error

dotnet_style_object_initializer = false:warning
dotnet_style_collection_initializer = true:error
dotnet_style_explicit_tuple_names = true:error

csharp_prefer_simple_default_expression = true:error

csharp_indent_case_contents = true:warning
csharp_indent_switch_labels = true:warning
csharp_style_namespace_declarations = file_scoped:warning

# prefer 'is null' for reference equality checks
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:error

# prefer braces
csharp_prefer_braces = true:error

# do not suggest readonly fields
dotnet_style_readonly_field = false:error

# use expression body for lambdas
csharp_style_expression_bodied_lambdas = true:suggestion

# IDE0066: Convert switch statement to expression
csharp_style_prefer_switch_expression = true:error

# IDE0063: Use simple 'using' statement
csharp_prefer_simple_using_statement = true:error

# IDE0054: Use compound assignment
dotnet_style_prefer_compound_assignment = true:error

# IDE0062: Make local function 'static'
csharp_prefer_static_local_function = true:error


# name all constant or static fields using PascalCase
dotnet_naming_rule.constant_or_static_fields_should_be_pascal_case.severity = error
dotnet_naming_rule.constant_or_static_fields_should_be_pascal_case.symbols  = constant_or_static_fields
dotnet_naming_rule.constant_or_static_fields_should_be_pascal_case.style    = pascal_case_style

dotnet_naming_symbols.constant_or_static_fields.applicable_kinds   = field
dotnet_naming_symbols.constant_or_static_fields.required_modifiers = const
dotnet_naming_symbols.constant_or_static_fields.required_modifiers = static

dotnet_naming_style.pascal_case_style.capitalization = pascal_case

# private fields should be _camelCase
dotnet_naming_rule.camel_case_for_private_fields.severity = error
dotnet_naming_rule.camel_case_for_private_fields.symbols  = private_fields
dotnet_naming_rule.camel_case_for_private_fields.style    = camel_case_underscore_style

dotnet_naming_symbols.private_fields.applicable_kinds = field
dotnet_naming_symbols.private_fields.applicable_accessibilities = private

dotnet_naming_style.camel_case_underscore_style.required_prefix = _
dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case

# No other public/protected/protected_internal/private_protected fields are allowed
dotnet_naming_rule.disallowed_fields_rule.severity = error
dotnet_naming_rule.disallowed_fields_rule.symbols  = disallowed_fields_symbols
dotnet_naming_rule.disallowed_fields_rule.style    = disallowed_fields_style

dotnet_naming_symbols.disallowed_fields_symbols.applicable_kinds           = field
dotnet_naming_symbols.disallowed_fields_symbols.applicable_accessibilities = public, protected_internal, protected, private_protected
# disallowed_fields_style - Anything that has this style applied is marked as disallowed
dotnet_naming_style.disallowed_fields_style.capitalization  = all_upper
dotnet_naming_style.disallowed_fields_style.required_prefix = ____RULE_VIOLATION____
dotnet_naming_style.disallowed_fields_style.required_suffix = ____RULE_VIOLATION____

# async methods should end with Async suffix
dotnet_naming_rule.async_methods_end_with_async.severity = warning
dotnet_naming_rule.async_methods_end_with_async.symbols  = any_async_methods
dotnet_naming_rule.async_methods_end_with_async.style    = end_with_async

dotnet_naming_symbols.any_async_methods.applicable_kinds           = method
dotnet_naming_symbols.any_async_methods.applicable_accessibilities = *
dotnet_naming_symbols.any_async_methods.required_modifiers         = async

dotnet_naming_style.end_with_async.required_suffix = Async
dotnet_naming_style.end_with_async.capitalization  = pascal_case

# Interfaces must be IPascalCase
dotnet_naming_rule.interfaces_I_pascal_case.severity = error
dotnet_naming_rule.interfaces_I_pascal_case.symbols  = interfaces_symbols
dotnet_naming_rule.interfaces_I_pascal_case.style    = I_pascal_case_style

dotnet_naming_symbols.interfaces_symbols.applicable_kinds = interface
dotnet_naming_symbols.interfaces_symbols.applicable_accessibilities = *

dotnet_naming_style.I_pascal_case_style.required_prefix = I
dotnet_naming_style.I_pascal_case_style.capitalization = pascal_case

# name most members using PascalCase (except interface, field, local, parameter, type_parameter)
dotnet_naming_rule.most_members_must_be_pascal_case.severity = error
dotnet_naming_rule.most_members_must_be_pascal_case.symbols  = most_members_symbols
dotnet_naming_rule.most_members_must_be_pascal_case.style    = pascal_case_style

dotnet_naming_symbols.most_members_symbols.applicable_kinds   = class, struct, enum, property, method, event, namespace, local_function
dotnet_naming_symbols.most_members_symbols.applicable_accessibilities = *

# name Local variables & parameters using camelCase
dotnet_naming_rule.local_variables_and_parameters_camel_case.severity = error
dotnet_naming_rule.local_variables_and_parameters_camel_case.symbols  = local_variables_and_parameters_symbols
dotnet_naming_rule.local_variables_and_parameters_camel_case.style    = camel_case_style

dotnet_naming_symbols.local_variables_and_parameters_symbols.applicable_kinds = local,parameter

dotnet_naming_style.camel_case_style.capitalization = camel_case

# name local constant using PascalCase
dotnet_naming_rule.local_const_pascal_case.severity = error
dotnet_naming_rule.local_const_pascal_case.symbols  = local_const
dotnet_naming_rule.local_const_pascal_case.style    = pascal_case_style

dotnet_naming_symbols.local_const.applicable_kinds   = local
dotnet_naming_symbols.local_const.required_modifiers = const

dotnet_naming_style.pascal_case_style.capitalization = pascal_case

# all type parameters should be TPascalCase
dotnet_naming_rule.type_parameters_T_pascal_case.severity = error
dotnet_naming_rule.type_parameters_T_pascal_case.symbols  = type_parameters_symbols
dotnet_naming_rule.type_parameters_T_pascal_case.style    = T_pascal_case_style

dotnet_naming_symbols.type_parameters_symbols.applicable_kinds = type_parameter

dotnet_naming_style.T_pascal_case_style.required_prefix = T
dotnet_naming_style.T_pascal_case_style.capitalization = pascal_case


# IDE0004: Remove Unnecessary Cast
dotnet_diagnostic.IDE0004.severity = error

# IDE0019: Use pattern matching
csharp_style_pattern_matching_over_as_with_null_check = true:error

# IDE0028: Simplify collection initialization
dotnet_diagnostic.IDE0028.severity = silent

# IDE0032: Use auto property
dotnet_style_prefer_auto_properties = true:error

# IDE0056: Use index operator
csharp_style_prefer_index_operator = true:error

# IDE0057: Use range operator
csharp_style_prefer_range_operator = true:error

# IDE0071: Simplify interpolation
dotnet_style_prefer_simplified_interpolation = true:error

# IDE0130: Warn and provide code fixes for when namespaces do not match the folder structure.
dotnet_diagnostic.IDE0130.severity = warning

# IDE0290: Use primary constructor
dotnet_diagnostic.IDE0290.severity = silent

# IDE0300: Simplify collection initialization
dotnet_diagnostic.IDE0300.severity = silent

# IDE0305: Simplify collection initialization
dotnet_diagnostic.IDE0305.severity = silent

# CA1304: Specify CultureInfo
dotnet_diagnostic.CA1304.severity = warning

# CA1305: Specify IFormatProvider
dotnet_diagnostic.CA1305.severity = warning

# CA1816: Dispose methods should call SuppressFinalize
dotnet_diagnostic.CA1816.severity = none

# CA1822: This complains to make functions static. Static is evil. Don't let it complain.
dotnet_diagnostic.CA1822.severity = none

# CA1825: Avoid zero-length array allocations
dotnet_diagnostic.CA1825.severity = warning

# CA1827: Do not use Count() or LongCount() when Any() can be used
dotnet_diagnostic.CA1827.severity = warning

# CA1829: Use Length/Count property instead of Count() when available
dotnet_diagnostic.CA1829.severity = warning

# CA1835: Prefer the 'Memory'-based overloads for 'ReadAsync' and 'WriteAsync'
dotnet_diagnostic.CA1835.severity = warning

# CA1841: Prefer Dictionary Contains methods
dotnet_diagnostic.CA1841.severity = warning

# CA1845: Use span-based 'string.Concat'
dotnet_diagnostic.CA1845.severity = warning

# CA1846: Prefer AsSpan over Substring
dotnet_diagnostic.CA1846.severity = warning

# CA1847: Use string.Contains(char) instead of string.Contains(string) with single characters
dotnet_diagnostic.CA1847.severity = warning

# CA1859: Use concrete types when possible for improved performance
dotnet_diagnostic.CA1859.severity = none

# CA1865-CA1867: Use 'string.Method(char)' instead of 'string.Method(string)' for string with single char
dotnet_diagnostic.CA1865.severity = warning
dotnet_diagnostic.CA1866.severity = warning
dotnet_diagnostic.CA1867.severity = warning

# CA1868: Unnecessary call to Set.Contains(item)
dotnet_diagnostic.CA1868.severity = warning

# CA2000: Dispose objects before losing scope
dotnet_diagnostic.CA2000.severity = warning

# CA2009: Do not call ToImmutableCollection on an ImmutableCollection value
dotnet_diagnostic.CA2009.severity = warning

# CA2016: Forward the 'CancellationToken' parameter to methods that take one
dotnet_diagnostic.CA2016.severity = warning

# CA2200: Rethrow to preserve stack details
dotnet_diagnostic.CA2200.severity = warning

# xUnit1030: Do not call ConfigureAwait in test method
dotnet_diagnostic.xUnit1030.severity = warning

# RS0030: Do not use banned APIs
dotnet_diagnostic.RS0030.severity = error