9cd55df584
Aligns the naming conventions defined in editorconfig (dotnet_naming_style, dotnet_naming_symbols, dotnet_naming_rule) which are reported under the IDE1006 rule with the existing StyleCop rules from the SA13XX range. This ensures the two rulesets agree when rejecting and accepting naming conventions within the IDE, with a few edges cases where only one ruleset can enforce the convention. IDE1006 allows use to specify a naming convention for type parameters, const locals and protected readonly fields which SA13XX cannot enforce. Some StyleCop SA13XX rules such as SA1309 'Field names should not begin with underscore' are not possible to enforce with the naming rules of IDE1006. Therefore we enable the IDE1006 as a build time warning to enforce conventions and extend them. We disable SA13XX rules that can now be covered by IDE1006 to avoid double-reporting but leave the remaining SA13XX rules that cover additional cases enabled. We also re-enable the SA1311 rule convention but enforce it via IDE1006, requiring some violations to be fixed or duplication of existing suppressions. Most violations fixes are trivial renames with the following exception. In ActorInitializer.cs, we prefer to make the fields private instead. ValueActorInit provides a publicly accessible property for access and OwnerInit provides a publicly accessible method. Health.cs is adjusted to access the property base instead when overriding. The reflection calls must be adjusted to target the base class specifically, as searching for a private field from the derived class will fail to locate it on the base class. Unused suppressions were removed.
154 lines
6.3 KiB
INI
154 lines
6.3 KiB
INI
; Top-most http://editorconfig.org/ file
|
|
root = true
|
|
charset=utf-8
|
|
|
|
; Unix-style newlines
|
|
[*]
|
|
end_of_line = LF
|
|
insert_final_newline = true
|
|
trim_trailing_whitespace = true
|
|
|
|
; 4-column tab indentation and .NET coding conventions
|
|
[*.cs]
|
|
indent_style = tab
|
|
indent_size = 4
|
|
|
|
dotnet_separate_import_directive_groups = false
|
|
dotnet_sort_system_directives_first = true
|
|
|
|
csharp_style_var_elsewhere = true:suggestion
|
|
csharp_style_var_for_built_in_types = true:suggestion
|
|
csharp_style_var_when_type_is_apparent = true:suggestion
|
|
|
|
csharp_prefer_braces = when_multiline:suggestion
|
|
csharp_using_directive_placement = outside_namespace:suggestion
|
|
csharp_new_line_before_open_brace = all
|
|
csharp_space_around_binary_operators = before_and_after
|
|
|
|
## Naming styles:
|
|
|
|
dotnet_naming_style.camel_case.capitalization = camel_case
|
|
|
|
dotnet_naming_style.pascal_case.capitalization = pascal_case
|
|
|
|
dotnet_naming_style.i_prefix_pascal_case.capitalization = pascal_case
|
|
dotnet_naming_style.i_prefix_pascal_case.required_prefix = I
|
|
|
|
## Symbol specifications:
|
|
|
|
dotnet_naming_symbols.const_locals.applicable_kinds = local
|
|
dotnet_naming_symbols.const_locals.applicable_accessibilities = *
|
|
dotnet_naming_symbols.const_locals.required_modifiers = const
|
|
|
|
dotnet_naming_symbols.const_fields.applicable_kinds = field
|
|
dotnet_naming_symbols.const_fields.applicable_accessibilities = *
|
|
dotnet_naming_symbols.const_fields.required_modifiers = const
|
|
|
|
dotnet_naming_symbols.static_readonly_fields.applicable_kinds = field
|
|
dotnet_naming_symbols.static_readonly_fields.applicable_accessibilities = *
|
|
dotnet_naming_symbols.static_readonly_fields.required_modifiers = static, readonly
|
|
|
|
dotnet_naming_symbols.non_private_readonly_fields.applicable_kinds = field
|
|
dotnet_naming_symbols.non_private_readonly_fields.applicable_accessibilities = public, internal, protected, protected_internal, private_protected
|
|
dotnet_naming_symbols.non_private_readonly_fields.required_modifiers = readonly
|
|
|
|
dotnet_naming_symbols.private_or_protected_fields.applicable_kinds = field
|
|
dotnet_naming_symbols.private_or_protected_fields.applicable_accessibilities = private, protected, private_protected
|
|
|
|
dotnet_naming_symbols.interfaces.applicable_kinds = interface
|
|
dotnet_naming_symbols.interfaces.applicable_accessibilities = *
|
|
|
|
dotnet_naming_symbols.parameters_and_locals.applicable_kinds = parameter, local
|
|
dotnet_naming_symbols.parameters_and_locals.applicable_accessibilities = *
|
|
|
|
dotnet_naming_symbols.most_symbols.applicable_kinds = namespace, class, struct, enum, field, property, method, local_function, event, delegate, type_parameter
|
|
dotnet_naming_symbols.most_symbols.applicable_accessibilities = *
|
|
|
|
## Naming rules:
|
|
|
|
dotnet_naming_rule.const_locals_should_be_pascal_case.symbols = const_locals
|
|
dotnet_naming_rule.const_locals_should_be_pascal_case.style = pascal_case
|
|
dotnet_naming_rule.const_locals_should_be_pascal_case.severity = warning
|
|
|
|
dotnet_naming_rule.const_fields_should_be_pascal_case.symbols = const_fields
|
|
dotnet_naming_rule.const_fields_should_be_pascal_case.style = pascal_case
|
|
dotnet_naming_rule.const_fields_should_be_pascal_case.severity = warning
|
|
|
|
dotnet_naming_rule.static_readonly_fields_should_be_pascal_case.symbols = static_readonly_fields
|
|
dotnet_naming_rule.static_readonly_fields_should_be_pascal_case.style = pascal_case
|
|
dotnet_naming_rule.static_readonly_fields_should_be_pascal_case.severity = warning
|
|
|
|
dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.symbols = non_private_readonly_fields
|
|
dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.style = pascal_case
|
|
dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.severity = warning
|
|
|
|
dotnet_naming_rule.private_or_protected_fields_should_be_camel_case.symbols = private_or_protected_fields
|
|
dotnet_naming_rule.private_or_protected_fields_should_be_camel_case.style = camel_case
|
|
dotnet_naming_rule.private_or_protected_fields_should_be_camel_case.severity = warning
|
|
|
|
dotnet_naming_rule.interfaces_should_be_i_prefix_pascal_case.symbols = interfaces
|
|
dotnet_naming_rule.interfaces_should_be_i_prefix_pascal_case.style = i_prefix_pascal_case
|
|
dotnet_naming_rule.interfaces_should_be_i_prefix_pascal_case.severity = warning
|
|
|
|
dotnet_naming_rule.parameters_and_locals_should_be_camel_case.symbols = parameters_and_locals
|
|
dotnet_naming_rule.parameters_and_locals_should_be_camel_case.style = camel_case
|
|
dotnet_naming_rule.parameters_and_locals_should_be_camel_case.severity = warning
|
|
|
|
dotnet_naming_rule.most_symbols_should_be_pascal_case.symbols = most_symbols
|
|
dotnet_naming_rule.most_symbols_should_be_pascal_case.style = pascal_case
|
|
dotnet_naming_rule.most_symbols_should_be_pascal_case.severity = warning
|
|
|
|
## Formatting:
|
|
|
|
# Also handled by StyleCopAnalyzers - SA1024: ColonsMustBeSpacedCorrectly.
|
|
csharp_space_after_colon_in_inheritance_clause = true
|
|
|
|
# Also handled by StyleCopAnalyzers - SA1024: ColonsMustBeSpacedCorrectly.
|
|
csharp_space_before_colon_in_inheritance_clause = true
|
|
|
|
# Also handled by StyleCopAnalyzers - SA1000: KeywordsMustBeSpacedCorrectly.
|
|
csharp_space_after_keywords_in_control_flow_statements = true
|
|
|
|
# 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
|
|
|
|
# IDE0049, IDE-only counterpart of StyleCopAnalyzers - SA1121: UseBuiltInTypeAlias.
|
|
dotnet_style_predefined_type_for_member_access = true
|
|
|
|
# IDE0049, IDE-only counterpart of StyleCopAnalyzers - SA1121: UseBuiltInTypeAlias.
|
|
dotnet_style_predefined_type_for_locals_parameters_members = true
|
|
|
|
## Others:
|
|
|
|
# Show an IDE warning when default access modifiers are explicitly specified.
|
|
dotnet_style_require_accessibility_modifiers = omit_if_default:warning
|
|
|
|
# Don't prefer braces (for one liners).
|
|
dotnet_diagnostic.IDE0011.severity = silent
|
|
|
|
# Object initialization can be simplified / Use object initializer.
|
|
dotnet_diagnostic.IDE0017.severity = warning
|
|
|
|
# Modifiers are not ordered.
|
|
dotnet_diagnostic.IDE0036.severity = warning
|
|
|
|
# Raise a warning on build when default access modifiers are explicitly specified.
|
|
dotnet_diagnostic.IDE0040.severity = warning
|
|
|
|
# Make field readonly.
|
|
dotnet_diagnostic.IDE0044.severity = warning
|
|
|
|
# Naming rule violation.
|
|
dotnet_diagnostic.IDE1006.severity = warning
|
|
|
|
# Avoid unnecessary zero-length array allocations.
|
|
dotnet_diagnostic.CA1825.severity = warning
|
|
|
|
; 4-column tab indentation
|
|
[*.yaml]
|
|
indent_style = tab
|
|
indent_size = 4
|