.editorconfig

[*.cs]

##### Temporal additions ######

# Please keep in alphabetical order by field.

# We cannot reasonably mark ourselves CLSCompliant one way or another if
# libraries we rely on like Microsoft.Extensions.Logging.Abstractions don't
dotnet_diagnostic.CA1014.severity = none

# We have exceptions we don't want all constructors on
dotnet_diagnostic.CA1032.severity = none

# We allow nested classes e.g. in cases of sum types
dotnet_diagnostic.CA1034.severity = none

# We use nullable types instead of checking params are non-null, even in public
# methods
dotnet_diagnostic.CA1062.severity = none

# We are not concerned with globalization (yet?). The below line does not work
# in our analyzers, so we disable each one
# dotnet_analyzer_diagnostic.category-Globalization.severity = none
dotnet_diagnostic.CA1303.severity = none
dotnet_diagnostic.CA1304.severity = none
dotnet_diagnostic.CA1305.severity = none
dotnet_diagnostic.CA1307.severity = none
dotnet_diagnostic.CA1310.severity = none
dotnet_diagnostic.CA1311.severity = none

# For many of our properties like task tokens, we're ok returning byte arrays
dotnet_diagnostic.CA1819.severity = none

# ReadOnlySpan conversion errors whing using string.Concat
dotnet_diagnostic.CA1845.severity = none

# String.Contains(Char) doesn't exist in older .NET
dotnet_diagnostic.CA1847.severity = none

# We accept logging performance can improve later
dotnet_diagnostic.CA1848.severity = none

# Do not want to make all exceptions [Serializable], we don't support
# cross-AppDomain currently
dotnet_diagnostic.CA2237.severity = none

# Warn on unused imports
dotnet_diagnostic.IDE0005.severity = warning

# Don't warn on using var
dotnet_diagnostic.IDE0008.severity = none

# Cannot use range operator on older versions
dotnet_diagnostic.IDE0057.severity = none

# Do not require "this." prefix, devs are smart enough to know when to qualify
dotnet_diagnostic.SA1101.severity = none

# Allow using directives outside of the namespace
dotnet_diagnostic.SA1200.severity = none

# Don't require a blank line after every closing brace
dotnet_diagnostic.SA1513.severity = none

# Don't require a blank line before single line comments
dotnet_diagnostic.SA1515.severity = none

# Do not require partial class documentation
dotnet_diagnostic.SA1601.severity = none

# Do not require file header
dotnet_diagnostic.SA1633.severity = none

###############################

# Most of the rest of this was taken from other projects

#Core editorconfig formatting - indentation

#use soft tabs (spaces) for indentation
indent_style = space

#Formatting - indentation options

#indent switch case contents.
csharp_indent_case_contents = true
#csharp_indent_case_contents_when_block
csharp_indent_case_contents_when_block = true
#indent switch labels
csharp_indent_switch_labels = true

#Formatting - new line options

#place catch statements on a new line
csharp_new_line_before_catch = true
#place else statements on a new line
csharp_new_line_before_else = true
#require members of anonymous types to be on separate lines
csharp_new_line_before_members_in_anonymous_types = true
#require members of object intializers to be on separate lines
csharp_new_line_before_members_in_object_initializers = true
#require braces to be on a new line for object_collection_array_initializers, properties, lambdas, types, anonymous_types, methods, accessors, and control_blocks (also known as "Allman" style)
csharp_new_line_before_open_brace = object_collection_array_initializers, properties, lambdas, types, anonymous_types, methods, accessors, control_blocks

#Formatting - organize using options

#sort System.* using directives alphabetically, and place them before other usings
dotnet_sort_system_directives_first = true

#Formatting - spacing options

#require NO space between a cast and the value
csharp_space_after_cast = false
#require a space before the colon for bases or interfaces in a type declaration
csharp_space_after_colon_in_inheritance_clause = true
#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
#require a space before the colon for bases or interfaces in a type declaration
csharp_space_before_colon_in_inheritance_clause = true
#remove space within empty argument list parentheses
csharp_space_between_method_call_empty_parameter_list_parentheses = false
#remove space between method call name and opening parenthesis
csharp_space_between_method_call_name_and_opening_parenthesis = false
#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
#remove space within empty parameter list parentheses for a method declaration
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
#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

#Formatting - wrapping options

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

#Style - Code block preferences

#prefer curly braces even for one line of code
csharp_prefer_braces = true:suggestion

#Style - expression bodied member options

#prefer block bodies for accessors
csharp_style_expression_bodied_accessors = true
#prefer block bodies for constructors
csharp_style_expression_bodied_constructors = true
#prefer block bodies for methods
csharp_style_expression_bodied_methods = true
#prefer expression-bodied members for properties
csharp_style_expression_bodied_properties = true
#prefer expression-bodied members for local functions
csharp_style_expression_bodied_local_functions = true

#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:suggestion
#prefer tuple names to ItemX properties
dotnet_style_explicit_tuple_names = true:suggestion
#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:suggestion

#Style - Expression-level  preferences

#prefer objects to be initialized using object initializers when possible
dotnet_style_object_initializer = true:suggestion
#prefer inferred anonymous type member names
dotnet_style_prefer_inferred_anonymous_type_member_names = false:suggestion
#prefer inferred tuple element names
dotnet_style_prefer_inferred_tuple_names = true:suggestion

#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:suggestion

#Style - Miscellaneous preferences

#prefer local functions over anonymous functions
csharp_style_pattern_local_over_anonymous_function = true:suggestion

#Style - modifier options

#prefer accessibility modifiers to be declared except for public interface members. This will currently not differ from always and will act as future proofing for if C# adds default interface methods.
dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion

#Style - Pattern matching

#prefer pattern matching instead of is expression with type casts
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion