.editorconfig

# EditorConfig is awesome: https://EditorConfig.org

root = true

[*]
indent_style = tab
indent_size = 4
insert_final_newline = true
end_of_line = crlf

# Code files
[*.{cs,csx,vb,vbx}]
charset = utf-8-bom

# XML project files
[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}]

# XML config files
[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}]

# JSON files
[*.json]

# Powershell files
[*.ps1]

# Azure files
[*.{yml,sh,cmd,md}]
indent_style = space

# Azure files
[*.sh]
end_of_line = lf


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

# Sort using and Import directives with System.* appearing first
dotnet_sort_system_directives_first = true
dotnet_separate_import_directive_groups = true

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

# Suggest more modern language features when available
dotnet_style_object_initializer = true:suggestion
dotnet_style_collection_initializer = true:suggestion
dotnet_style_coalesce_expression = true:suggestion
dotnet_style_null_propagation = true:suggestion
dotnet_style_explicit_tuple_names = true:suggestion

# CSharp code style settings:
[*.cs]
# Newline settings
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 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 = flush_left

# Spacing options
csharp_space_around_declaration_statements = ignore

# Prefer "var" everywhere
csharp_style_var_for_built_in_types = true:suggestion
csharp_style_var_when_type_is_apparent = true:suggestion
csharp_style_var_elsewhere = true:suggestion

# Prefer method-like constructs to have a block body
csharp_style_expression_bodied_methods = false:none
csharp_style_expression_bodied_constructors = false:none
csharp_style_expression_bodied_operators = false:none

# Prefer property-like constructs to have an expression-body
csharp_style_expression_bodied_properties = true:warning
csharp_style_expression_bodied_indexers = true:warning
csharp_style_expression_bodied_accessors = true:warning

# Suggest more modern language features when available
csharp_style_pattern_matching_over_is_with_cast_check = true:warning
csharp_style_pattern_matching_over_as_with_null_check = true:warning
csharp_style_inlined_variable_declaration = true:suggestion
csharp_style_throw_expression = true:suggestion
csharp_style_conditional_delegate_call = true:suggestion

# Blocks are allowed
csharp_prefer_braces = true:silent
csharp_preserve_single_line_blocks = true
csharp_preserve_single_line_statements = true

csharp_prefer_simple_using_statement = false:silent
csharp_style_prefer_switch_expression = true:warning

dotnet_style_prefer_compound_assignment = true:warning

[*.{cs,vb}]
#############
# Analyzers #
#############

# general settings applied to all source files
# Source folder contains additional .editorconfig with overrides
#
# enable all analyzers by default
# https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/
dotnet_analyzer_diagnostic.severity = error
dotnet_code_quality.api_surface = all
dotnet_code_quality.enable_platform_analyzer_on_pre_net5_target = true

##############################################
# active diagnostics (explicitly configured) #
##############################################

dotnet_diagnostic.CA1825.severity = error # CA1825: Avoid zero-length array allocations
# generates a lot of noise in tests, enabled in source .editorconfig
dotnet_diagnostic.CA2007.severity = none # CA2007: Do not directly await a Task
dotnet_diagnostic.CA2012.severity = error # CA2012: Use ValueTasks correctly
dotnet_diagnostic.CA2016.severity = error # CA2016: Forward the CancellationToken parameter to methods that take one
dotnet_diagnostic.CA1018.severity = error # CA1018: Mark attributes with AttributeUsageAttribute
dotnet_diagnostic.CA1200.severity = error # CA1200: Avoid using cref tags with a prefix
dotnet_diagnostic.CA1507.severity = error # CA1507: Use nameof in place of string
dotnet_diagnostic.CA1725.severity = error # CA1725: Parameter names should match base declaration
dotnet_diagnostic.CA1805.severity = error # CA1805: Do not initialize unnecessarily
# not interested
dotnet_diagnostic.CA1816.severity = none # CA1816: Call GC.SuppressFinalize correctly
dotnet_diagnostic.CA1826.severity = error # CA1826: Use property instead of Linq Enumerable method
# reported for valid test linq code, rule enabled in source .editorconfig
dotnet_diagnostic.CA1827.severity = none # CA1827: Do not use Count/LongCount when Any can be used
# reported for valid test linq code, rule enabled in source .editorconfig
dotnet_diagnostic.CA1829.severity = none # CA1829: Use Length/Count property instead of Enumerable.Count method
dotnet_diagnostic.CA1830.severity = error # CA1830: Prefer strongly-typed Append and Insert method overloads on StringBuilder
dotnet_diagnostic.CA1834.severity = error # CA1834: Use StringBuilder.Append(char) for single character strings
dotnet_diagnostic.CA1836.severity = error # CA1836: Prefer IsEmpty over Count when available
# missing from .net framework
dotnet_diagnostic.CA1847.severity = none # CA1847: Use string.Contains(char)
dotnet_diagnostic.CA2101.severity = error # CA2101: Specify marshaling for P/Invoke string arguments
dotnet_diagnostic.CA2200.severity = error # CA2200: Rethrow to preserve stack details
dotnet_diagnostic.CA2201.severity = error # CA2201: Do not raise reserved exception types
dotnet_diagnostic.CA2208.severity = error # CA2208: Instantiate argument exceptions correctly
dotnet_diagnostic.CA2215.severity = error # CA2215: Dispose methods should call base class dispose
# not interested
dotnet_diagnostic.CA2231.severity = none # CA2231: Overload operator equals on overriding ValueType.Equals
# disabled, as NETFX doesn't have string.Contains overloads with comparison type
dotnet_diagnostic.CA2249.severity = none # CA2249: Consider using String.Contains instead of String.IndexOf
dotnet_diagnostic.CA3075.severity = error # CA3075: Insecure DTD Processing
# very slow (https://github.com/dotnet/roslyn-analyzers/issues/4754)
# also we don't have code that could be targeted by it
dotnet_diagnostic.CA3076.severity = none # CA3076: Insecure XSLT Script Execution

#########################################################################################################
# inactive diagnostics (not reviewed yet => disabled to not fail build, basically TODO list for future) #
#########################################################################################################
dotnet_diagnostic.CA1000.severity = none # CA1000: Do not declare static members on generic types
dotnet_diagnostic.CA1001.severity = none # CA1001: Types that own disposable fields should be disposable
dotnet_diagnostic.CA1002.severity = none # CA1002: Do not expose generic lists
dotnet_diagnostic.CA1003.severity = none # CA1003: Use generic event handler instances
dotnet_diagnostic.CA1008.severity = none # CA1008: Enums should have zero value
dotnet_diagnostic.CA1010.severity = none # CA1010: Collections should implement generic interface
dotnet_diagnostic.CA1019.severity = none # CA1019: Define accessors for attribute arguments
dotnet_diagnostic.CA1024.severity = none # CA1024: Use properties where appropriate
dotnet_diagnostic.CA1027.severity = none # CA1027: Mark enums with FlagsAttribute
dotnet_diagnostic.CA1028.severity = none # CA1028: Enum storage should be Int32
dotnet_diagnostic.CA1031.severity = none # CA1031: Do not catch general exception types
dotnet_diagnostic.CA1033.severity = none # CA1033: Interface methods should be callable by child types
dotnet_diagnostic.CA1034.severity = none # CA1034: Nested types should not be visible
dotnet_diagnostic.CA1040.severity = none # CA1040: Avoid empty interfaces
dotnet_diagnostic.CA1050.severity = none # CA1050: Declare types in namespaces
dotnet_diagnostic.CA1056.severity = none # CA1056: URI properties should not be strings
dotnet_diagnostic.CA1030.severity = none # CA1030: Use events where appropriate
dotnet_diagnostic.CA1032.severity = none # CA1032: Implement standard exception constructors
dotnet_diagnostic.CA1036.severity = none # CA1036: Override methods on comparable types
dotnet_diagnostic.CA1043.severity = none # CA1043: Use integral or string argument for indexers
dotnet_diagnostic.CA1051.severity = none # CA1051: Do not declare visible instance fields
dotnet_diagnostic.CA1054.severity = none # CA1054: URI parameters should not be strings
dotnet_diagnostic.CA1062.severity = none # CA1062: Validate arguments of public methods
dotnet_diagnostic.CA1063.severity = none # CA1063: Implement IDisposable correctly
dotnet_diagnostic.CA1065.severity = none # CA1065: Do not raise exceptions in unexpected locations
dotnet_diagnostic.CA1067.severity = none # CA1067: Override Equals when implementing IEquatable
dotnet_diagnostic.CA1068.severity = none # CA1068: CancellationToken parameters must come last
dotnet_diagnostic.CA1069.severity = none # CA1069: Enums should not have duplicate values
dotnet_diagnostic.CA1303.severity = none # CA1303: Do not pass literals as localized parameters
dotnet_diagnostic.CA1304.severity = none # CA1304: Specify CultureInfo
dotnet_diagnostic.CA1305.severity = none # CA1305: Specify IFormatProvider
dotnet_diagnostic.CA1307.severity = none # CA1307: Specify StringComparison for clarity
dotnet_diagnostic.CA1308.severity = none # CA1308: Normalize strings to uppercase
dotnet_diagnostic.CA1309.severity = none # CA1309: Use ordinal StringComparison
dotnet_diagnostic.CA1310.severity = none # CA1310: Specify StringComparison for correctness
dotnet_diagnostic.CA1311.severity = none # CA1311: Specify a culture or use an invariant version
dotnet_diagnostic.CA1416.severity = none # CA1416: Validate platform compatibility
dotnet_diagnostic.CA1422.severity = none # CA1422: Validate platform compatibility - obsoleted APIs
dotnet_diagnostic.CA1510.severity = none # CA1510: use throw helpers
dotnet_diagnostic.CA1511.severity = none # CA1511: use throw helpers
dotnet_diagnostic.CA1512.severity = none # CA1512: use throw helpers
dotnet_diagnostic.CA1513.severity = none # CA1513: use throw helpers
dotnet_diagnostic.CA1864.severity = none # CA1864: Prefer the 'IDictionary.TryAdd(TKey, TValue)' method
dotnet_diagnostic.CA1866.severity = none # CA1866: Use 'string.Method(char)' instead of 'string.Method(string)' for string with single char
dotnet_diagnostic.CA1700.severity = none # CA1700: Do not name enum values 'Reserved'
dotnet_diagnostic.CA1707.severity = none # CA1707: Identifiers should not contain underscores
dotnet_diagnostic.CA1708.severity = none # CA1708: Identifiers should differ by more than case
dotnet_diagnostic.CA1711.severity = none # CA1711: Identifiers should not have incorrect suffix
dotnet_diagnostic.CA1715.severity = none # CA1715: Identifiers should have correct prefix
dotnet_diagnostic.CA1716.severity = none # CA1716: Identifiers should not match keywords
dotnet_diagnostic.CA1720.severity = none # CA1720: Identifiers should not contain type names
dotnet_diagnostic.CA1721.severity = none # CA1721: Property names should not match get methods
dotnet_diagnostic.CA1724.severity = none # CA1724: Type names should not match namespaces
dotnet_diagnostic.CA1806.severity = none # CA1806: Do not ignore method results
dotnet_diagnostic.CA1810.severity = none # CA1810: Initialize reference type static fields inline
dotnet_diagnostic.CA1813.severity = none # CA1813: Avoid unsealed attributes
dotnet_diagnostic.CA1815.severity = none # CA1815: Override equals and operator equals on value types
dotnet_diagnostic.CA1819.severity = none # CA1819: Properties should not return arrays
dotnet_diagnostic.CA1822.severity = none # CA1822: Mark members as static TODO: V6 - fix remaining errors
dotnet_diagnostic.CA1845.severity = none # CA1845: Use span-based string.Concat and AsSpan instead of Substring
dotnet_diagnostic.CA1846.severity = none # CA1846: Prefer AsSpan over Substring
dotnet_diagnostic.CA1859.severity = none # CA1859: Use concrete types when possible for improved performance
dotnet_diagnostic.CA1862.severity = none # CA1862: Prefer the 'StringComparison' method overloads to perform case-insensitive string comparisons
dotnet_diagnostic.CA2100.severity = none # CA2100: Review SQL queries for security vulnerabilities
dotnet_diagnostic.CA2119.severity = none # CA2119: Seal methods that satisfy private interfaces
dotnet_diagnostic.CA2211.severity = none # CA2211: Non-constant fields should not be visible
dotnet_diagnostic.CA2217.severity = none # CA2217: Do not mark enums with FlagsAttribute
dotnet_diagnostic.CA2225.severity = none # CA2225: Operator overloads have named alternates
dotnet_diagnostic.CA2227.severity = none # CA2227: Collection properties should be read only
dotnet_diagnostic.CA2234.severity = none # CA2234: Pass System.Uri objects instead of strings
dotnet_diagnostic.CA2241.severity = none # CA2241: Provide correct arguments to formatting methods
dotnet_diagnostic.CA2252.severity = none # CA2252: Opt in to preview features before using them
dotnet_diagnostic.CA2301.severity = none # CA2301: Do not call BinaryFormatter.Deserialize without first setting BinaryFormatter.Binder
dotnet_diagnostic.CA2302.severity = none # CA2302: Ensure BinaryFormatter.Binder is set before calling BinaryFormatter.Deserialize
dotnet_diagnostic.CA3001.severity = none # CA3001: Review code for SQL injection vulnerabilities
dotnet_diagnostic.CA3003.severity = none # CA3003: Review code for file path injection vulnerabilities
dotnet_diagnostic.CA3005.severity = none # CA3005: Review code for LDAP injection vulnerabilities
dotnet_diagnostic.CA3006.severity = none # CA3006: Review code for process command injection vulnerabilities
dotnet_diagnostic.CA3007.severity = none # CA3007: Review code for open redirect vulnerabilities
dotnet_diagnostic.CA3008.severity = none # CA3008: Review code for XPath injection vulnerabilities
dotnet_diagnostic.CA3009.severity = none # CA3009: Review code for XML injection vulnerabilities
dotnet_diagnostic.CA3010.severity = none # CA3010: Review code for XAML injection vulnerabilities
dotnet_diagnostic.CA3011.severity = none # CA3011: Review code for DLL injection vulnerabilities
dotnet_diagnostic.CA3012.severity = none # CA3012: Review code for regex injection vulnerabilities
dotnet_diagnostic.CA3077.severity = none # CA3077: Insecure Processing in API Design, XML Document and XML Text Reader
dotnet_diagnostic.CA5350.severity = none # CA5350: Do Not Use Weak Cryptographic Algorithms
dotnet_diagnostic.CA5351.severity = none # CA5351 Do Not Use Broken Cryptographic Algorithms
dotnet_diagnostic.CA5360.severity = none # CA5360: Do not call dangerous methods in deserialization
dotnet_diagnostic.CA5382.severity = none # CA5382: Use secure cookies in ASP.NET Core
dotnet_diagnostic.CA5383.severity = none # CA5383: Ensure use secure cookies in ASP.NET Core
dotnet_diagnostic.CA5384.severity = none # CA5384: Do not use digital signature algorithm (DSA)
dotnet_diagnostic.CA5387.severity = none # CA5387: Do not use weak key derivation function with insufficient iteration count
dotnet_diagnostic.CA5388.severity = none # CA5388: Ensure sufficient iteration count when using weak key derivation function
dotnet_diagnostic.CA5389.severity = none # CA5389: Do not add archive item's path to the target file system path
dotnet_diagnostic.CA5390.severity = none # CA5390: DoNotHardCodeEncryptionKey
dotnet_diagnostic.CA5394.severity = none # CA5394: Do not use insecure randomness
dotnet_diagnostic.CA5397.severity = none # CA5397: Do not use deprecated SslProtocols values
dotnet_diagnostic.CA5398.severity = none # CA5398: Avoid hardcoded SslProtocols values
dotnet_diagnostic.CA5399.severity = none # CA5399: Enable HttpClient certificate revocation list check
dotnet_diagnostic.CA5400.severity = none # CA5400: Ensure HttpClient certificate revocation list check is not disabled
dotnet_diagnostic.CA5401.severity = none # CA5401: Do not use CreateEncryptor with non-default IV
dotnet_diagnostic.CA5402.severity = none # CA5402: Use CreateEncryptor with the default IV
dotnet_diagnostic.CA5403.severity = none # CA5403: DoNotHardCodeCertificate


###################################################################################
# VS analyzers                                                                    #
# https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/ #
###################################################################################
dotnet_diagnostic.IDE0001.severity = error # IDE0001: Simplify name
dotnet_diagnostic.IDE0002.severity = error # IDE0002: Simplify member access

# IDE0003: Remove this or Me qualification
# IDE0009: Add this or Me qualification
dotnet_diagnostic.IDE0003.severity = error
dotnet_style_qualification_for_field = false:refactoring
dotnet_style_qualification_for_property = false:refactoring
dotnet_style_qualification_for_method = false:refactoring
dotnet_style_qualification_for_event = false:refactoring

# IDE0004: don't enable, very slow on our code-base, requires research/bug report
dotnet_diagnostic.IDE0004.severity = none # IDE0004: Remove unnecessary cast
dotnet_diagnostic.IDE0005.severity = none # IDE0005: Remove unnecessary import

# not reviewed yet rules
dotnet_diagnostic.IDE0007.severity = none # IDE0007: Use 'var' instead of explicit type
dotnet_diagnostic.IDE0008.severity = none # IDE0008: Use explicit type
dotnet_diagnostic.IDE0009.severity = none # IDE0009: Qualify member access
dotnet_diagnostic.IDE0010.severity = none # IDE0010: Add missing cases to switch statement
dotnet_diagnostic.IDE0011.severity = none # IDE0011: Add braces
dotnet_diagnostic.IDE0016.severity = none # IDE0016: Use throw expression
dotnet_diagnostic.IDE0017.severity = none # IDE0017: Use object initializers
dotnet_diagnostic.IDE0018.severity = none # IDE0018: Inline variable declaration
dotnet_diagnostic.IDE0019.severity = none # IDE0019: Use pattern matching to avoid 'as' followed by a 'null' check
dotnet_diagnostic.IDE0021.severity = none # IDE0021: Use expression body for
dotnet_diagnostic.IDE0022.severity = none # IDE0022: Use expression body for
dotnet_diagnostic.IDE0023.severity = none # IDE0023: Use expression body for
dotnet_diagnostic.IDE0024.severity = none # IDE0024: Use expression body for
dotnet_diagnostic.IDE0025.severity = none # IDE0025: Use expression body for properties
dotnet_diagnostic.IDE0026.severity = none # IDE0026: Use expression body for indexers
dotnet_diagnostic.IDE0027.severity = none # IDE0027: Use expression body for accessors
dotnet_diagnostic.IDE0028.severity = none # IDE0028: Use collection initializers
dotnet_diagnostic.IDE0029.severity = none # IDE0029: Use coalesce expression (non-nullable types)
dotnet_diagnostic.IDE0030.severity = none # IDE0030: Use coalesce expression
dotnet_diagnostic.IDE0031.severity = none # IDE0031: Use null propagation
dotnet_diagnostic.IDE0032.severity = none # IDE0032: Use auto property
dotnet_diagnostic.IDE0034.severity = none # IDE0034: Simplify 'default' expression
dotnet_diagnostic.IDE0035.severity = none # IDE0035: Remove unreachable code
dotnet_diagnostic.IDE0036.severity = none # IDE0036: Order modifiers
dotnet_diagnostic.IDE0037.severity = none # IDE0037: Use inferred member name
dotnet_diagnostic.IDE0038.severity = none # IDE0038: Use pattern matching to avoid 'is' check followed by a cast
dotnet_diagnostic.IDE0040.severity = none # IDE0040: Add accessibility modifiers
dotnet_diagnostic.IDE0041.severity = none # IDE0041: Use is null check
dotnet_diagnostic.IDE0044.severity = none # IDE0044: Add readonly modifier
dotnet_diagnostic.IDE0045.severity = none # IDE0045: Use conditional expression for assignment
dotnet_diagnostic.IDE0046.severity = none # IDE0046: Convert to conditional expression
dotnet_diagnostic.IDE0047.severity = none # IDE0047: Remove unnecessary parentheses
dotnet_diagnostic.IDE0048.severity = none # IDE0048: Add parentheses for clarity
dotnet_diagnostic.IDE0049.severity = none # IDE0049: Use language keywords instead of framework type names for type references
dotnet_diagnostic.IDE0050.severity = none # IDE0050: Convert to tuple
dotnet_diagnostic.IDE0051.severity = none # IDE0051: Remove unused private members
dotnet_diagnostic.IDE0052.severity = none # IDE0052: Remove unread private member
dotnet_diagnostic.IDE0054.severity = none # IDE0054: Use compound assignment
dotnet_diagnostic.IDE0055.severity = none # IDE0055: Formatting rules
dotnet_diagnostic.IDE0056.severity = none # IDE0056: Use index operator
dotnet_diagnostic.IDE0057.severity = none # IDE0057: Use range operator
dotnet_diagnostic.IDE0058.severity = none # IDE0058: computed value is never used
dotnet_diagnostic.IDE0059.severity = none # IDE0059: Remove unnecessary value assignment
dotnet_diagnostic.IDE0060.severity = none # IDE0060: Remove unused parameter
dotnet_diagnostic.IDE0061.severity = none # IDE0061: Use expression body for local functions
dotnet_diagnostic.IDE0062.severity = none # IDE0062: Make local function static
dotnet_diagnostic.IDE0065.severity = none # IDE0065: Misplaced using directive
dotnet_diagnostic.IDE0066.severity = none # IDE0066: Convert switch statement to expression
dotnet_diagnostic.IDE0070.severity = none # IDE0070: Use 'System.HashCode.Combine'
dotnet_diagnostic.IDE0072.severity = none # IDE0072: Add missing cases
dotnet_diagnostic.IDE0075.severity = none # IDE0075: Simplify conditional expression
dotnet_diagnostic.IDE0078.severity = none # IDE0078: Use pattern matching
dotnet_diagnostic.IDE0079.severity = none # IDE0079: Remove unnecessary suppression
dotnet_diagnostic.IDE0080.severity = none # IDE0080: Remove unnecessary suppression operator
dotnet_diagnostic.IDE0081.severity = none # IDE0081: Remove ByVal
dotnet_diagnostic.IDE0083.severity = none # IDE0083: Use pattern matching (not operator)
dotnet_diagnostic.IDE0090.severity = none # IDE0090: new expression can be simplified
dotnet_diagnostic.IDE0100.severity = none # IDE0100: remove redundant equality
dotnet_diagnostic.IDE0120.severity = none # IDE0120: Simplify LINQ expression
dotnet_diagnostic.IDE0130.severity = none # IDE0130: Namespace does not match folder structure
dotnet_diagnostic.IDE0150.severity = none # IDE0150: null check can be clarified
dotnet_diagnostic.IDE0210.severity = none # IDE0210: convert to lol-level statements
dotnet_diagnostic.IDE0220.severity = none # IDE0220: add explicit cast to MS implicity typed collections foreach
dotnet_diagnostic.IDE0230.severity = none # IDE0230: use utf-8 literal
dotnet_diagnostic.IDE0251.severity = none # IDE0251: Make member 'readonly'
dotnet_diagnostic.IDE0270.severity = none # IDE0270: Null check can be simplified
dotnet_diagnostic.IDE1006.severity = none # IDE1006: Naming rule violation

dotnet_diagnostic.CS1998.severity = error # CS1998: Async method lacks 'await' operators and will run synchronously
dotnet_diagnostic.CS8618.severity = error # CS8618: Non-nullable field is uninitialized. Consider declaring as nullable.
dotnet_diagnostic.CS4014.severity = error # CS4014: Because this call is not awaited, execution of the current method continues before the call is completed

dotnet_diagnostic.SYSLIB1045.severity = none # Use GeneratedRegexAttribute
dotnet_diagnostic.SYSLIB1054.severity = none # Use LibraryImportAttribute