336 строки
16 KiB
INI
336 строки
16 KiB
INI
# Remove the line below if you want to inherit .editorconfig settings from higher directories
|
|
root = true
|
|
|
|
# C# files
|
|
[*.cs]
|
|
|
|
#### Core EditorConfig Options ####
|
|
|
|
# Indentation and spacing
|
|
indent_size = 4
|
|
indent_style = space
|
|
tab_width = 4
|
|
|
|
# New line preferences
|
|
end_of_line = crlf
|
|
insert_final_newline = false
|
|
|
|
#### .NET Coding Conventions ####
|
|
|
|
# Organize usings
|
|
dotnet_separate_import_directive_groups = false
|
|
dotnet_sort_system_directives_first = true
|
|
|
|
# this. and Me. preferences
|
|
dotnet_style_qualification_for_event = false:suggestion
|
|
dotnet_style_qualification_for_field = false:suggestion
|
|
dotnet_style_qualification_for_method = false:suggestion
|
|
dotnet_style_qualification_for_property = false:suggestion
|
|
|
|
# Language keywords vs BCL types preferences
|
|
dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
|
|
dotnet_style_predefined_type_for_member_access = true:suggestion
|
|
|
|
# Parentheses preferences
|
|
dotnet_style_parentheses_in_arithmetic_binary_operators = never_if_unnecessary:suggestion
|
|
dotnet_style_parentheses_in_other_binary_operators = never_if_unnecessary:suggestion
|
|
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:suggestion
|
|
dotnet_style_parentheses_in_relational_binary_operators = never_if_unnecessary:suggestion
|
|
|
|
# Modifier preferences
|
|
dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion
|
|
|
|
# Expression-level preferences
|
|
dotnet_style_coalesce_expression = true:suggestion
|
|
dotnet_style_collection_initializer = true:suggestion
|
|
dotnet_style_explicit_tuple_names = true:suggestion
|
|
dotnet_style_null_propagation = true:suggestion
|
|
dotnet_style_object_initializer = true:suggestion
|
|
dotnet_style_prefer_auto_properties = true:suggestion
|
|
dotnet_style_prefer_compound_assignment = true:suggestion
|
|
dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion
|
|
dotnet_style_prefer_conditional_expression_over_return = true:suggestion
|
|
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
|
|
dotnet_style_prefer_inferred_tuple_names = true:suggestion
|
|
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
|
|
|
|
# Field preferences
|
|
dotnet_style_readonly_field = true:suggestion
|
|
|
|
# Parameter preferences
|
|
dotnet_code_quality_unused_parameters = all:suggestion
|
|
|
|
#### IoT SDK copyright header
|
|
file_header_template = Copyright (c) Microsoft. All rights reserved.\nLicensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
|
|
#### C# Coding Conventions ####
|
|
|
|
# var preferences
|
|
csharp_style_var_elsewhere = false:suggestion
|
|
csharp_style_var_for_built_in_types = false:suggestion
|
|
csharp_style_var_when_type_is_apparent = true:suggestion
|
|
|
|
# Expression-bodied members
|
|
csharp_style_expression_bodied_accessors = true:suggestion
|
|
csharp_style_expression_bodied_constructors = false:silent
|
|
csharp_style_expression_bodied_indexers = true:silent
|
|
csharp_style_expression_bodied_lambdas = true:silent
|
|
csharp_style_expression_bodied_local_functions = false:silent
|
|
csharp_style_expression_bodied_methods = false:silent
|
|
csharp_style_expression_bodied_operators = false:silent
|
|
csharp_style_expression_bodied_properties = true:suggestion
|
|
|
|
# Pattern matching preferences
|
|
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
|
|
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
|
|
csharp_style_prefer_switch_expression = true:suggestion
|
|
|
|
# Null-checking preferences
|
|
csharp_style_conditional_delegate_call = true:suggestion
|
|
|
|
# Modifier preferences
|
|
csharp_prefer_static_local_function = true:suggestion
|
|
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async
|
|
|
|
# Code-block preferences
|
|
csharp_prefer_braces = true:suggestion
|
|
csharp_prefer_simple_using_statement = true:suggestion
|
|
|
|
# Expression-level preferences
|
|
csharp_prefer_simple_default_expression = true:suggestion
|
|
csharp_style_deconstructed_variable_declaration = true:suggestion
|
|
csharp_style_inlined_variable_declaration = true:suggestion
|
|
csharp_style_pattern_local_over_anonymous_function = true:suggestion
|
|
csharp_style_prefer_index_operator = true:suggestion
|
|
csharp_style_prefer_range_operator = true:suggestion
|
|
csharp_style_throw_expression = true:suggestion
|
|
csharp_style_unused_value_assignment_preference = discard_variable:suggestion
|
|
csharp_style_unused_value_expression_statement_preference = discard_variable:silent
|
|
|
|
# 'using' directive preferences
|
|
csharp_using_directive_placement = outside_namespace:suggestion
|
|
|
|
#### C# Formatting Rules ####
|
|
|
|
# New line preferences
|
|
csharp_new_line_before_catch = true
|
|
csharp_new_line_before_else = true
|
|
csharp_new_line_before_finally = true
|
|
csharp_new_line_before_members_in_anonymous_types = true
|
|
csharp_new_line_before_members_in_object_initializers = true
|
|
csharp_new_line_before_open_brace = all
|
|
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 = true
|
|
csharp_indent_labels = flush_left
|
|
csharp_indent_switch_labels = true
|
|
|
|
# Space preferences
|
|
csharp_space_after_cast = false
|
|
csharp_space_after_colon_in_inheritance_clause = true
|
|
csharp_space_after_comma = true
|
|
csharp_space_after_dot = false
|
|
csharp_space_after_keywords_in_control_flow_statements = true
|
|
csharp_space_after_semicolon_in_for_statement = true
|
|
csharp_space_around_binary_operators = before_and_after
|
|
csharp_space_around_declaration_statements = false
|
|
csharp_space_before_colon_in_inheritance_clause = true
|
|
csharp_space_before_comma = false
|
|
csharp_space_before_dot = false
|
|
csharp_space_before_open_square_brackets = false
|
|
csharp_space_before_semicolon_in_for_statement = false
|
|
csharp_space_between_empty_square_brackets = false
|
|
csharp_space_between_method_call_empty_parameter_list_parentheses = false
|
|
csharp_space_between_method_call_name_and_opening_parenthesis = false
|
|
csharp_space_between_method_call_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_declaration_parameter_list_parentheses = false
|
|
csharp_space_between_parentheses = false
|
|
csharp_space_between_square_brackets = false
|
|
|
|
# Wrapping preferences
|
|
csharp_preserve_single_line_blocks = true
|
|
csharp_preserve_single_line_statements = true
|
|
|
|
#### Naming styles ####
|
|
|
|
# Naming rules
|
|
|
|
dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
|
|
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
|
|
dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
|
|
|
|
dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
|
|
dotnet_naming_rule.types_should_be_pascal_case.symbols = types
|
|
dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
|
|
|
|
dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
|
|
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
|
|
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
|
|
|
|
dotnet_naming_rule.public_members_must_be_capitalized.symbols = public_symbols
|
|
dotnet_naming_symbols.public_symbols.applicable_kinds = property,method,field,event,delegate
|
|
dotnet_naming_symbols.public_symbols.applicable_accessibilities = public
|
|
dotnet_naming_symbols.public_symbols.required_modifiers = readonly
|
|
dotnet_naming_rule.public_members_must_be_capitalized.style = first_word_upper_case_style
|
|
dotnet_naming_style.first_word_upper_case_style.capitalization = first_word_upper
|
|
|
|
dotnet_naming_rule.public_members_must_be_capitalized.severity = suggestion
|
|
|
|
# Non-private static fields are PascalCase
|
|
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.severity = suggestion
|
|
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.symbols = non_private_static_fields
|
|
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.style = non_private_static_field_style
|
|
|
|
dotnet_naming_symbols.non_private_static_fields.applicable_kinds = field
|
|
dotnet_naming_symbols.non_private_static_fields.applicable_accessibilities = public, protected, internal, protected_internal, private_protected
|
|
dotnet_naming_symbols.non_private_static_fields.required_modifiers = static
|
|
|
|
dotnet_naming_style.non_private_static_field_style.capitalization = pascal_case
|
|
|
|
# Non-private readonly fields are PascalCase
|
|
dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.severity = suggestion
|
|
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 = non_private_readonly_field_style
|
|
|
|
dotnet_naming_symbols.non_private_readonly_fields.applicable_kinds = field
|
|
dotnet_naming_symbols.non_private_readonly_fields.applicable_accessibilities = public, protected, internal, protected_internal, private_protected
|
|
dotnet_naming_symbols.non_private_readonly_fields.required_modifiers = readonly
|
|
|
|
dotnet_naming_style.non_private_readonly_field_style.capitalization = pascal_case
|
|
|
|
# Constants are PascalCase
|
|
dotnet_naming_rule.constants_should_be_pascal_case.severity = suggestion
|
|
dotnet_naming_rule.constants_should_be_pascal_case.symbols = constants
|
|
dotnet_naming_rule.constants_should_be_pascal_case.style = constant_style
|
|
|
|
dotnet_naming_symbols.constants.applicable_kinds = field
|
|
dotnet_naming_symbols.constants.required_modifiers = const
|
|
|
|
dotnet_naming_style.constant_style.capitalization = pascal_case
|
|
|
|
# Static fields are camelCase and start with s_
|
|
dotnet_naming_rule.static_fields_should_be_camel_case.severity = suggestion
|
|
dotnet_naming_rule.static_fields_should_be_camel_case.symbols = static_fields
|
|
dotnet_naming_rule.static_fields_should_be_camel_case.style = static_field_style
|
|
|
|
dotnet_naming_symbols.static_fields.applicable_kinds = field
|
|
dotnet_naming_symbols.static_fields.required_modifiers = static
|
|
|
|
dotnet_naming_style.static_field_style.capitalization = camel_case
|
|
dotnet_naming_style.static_field_style.required_prefix = s_
|
|
|
|
# Instance fields are camelCase and start with _
|
|
dotnet_naming_rule.instance_fields_should_be_camel_case.severity = suggestion
|
|
dotnet_naming_rule.instance_fields_should_be_camel_case.symbols = instance_fields
|
|
dotnet_naming_rule.instance_fields_should_be_camel_case.style = instance_field_style
|
|
|
|
dotnet_naming_symbols.instance_fields.applicable_kinds = field
|
|
|
|
dotnet_naming_style.instance_field_style.capitalization = camel_case
|
|
dotnet_naming_style.instance_field_style.required_prefix = _
|
|
|
|
# Locals and parameters are camelCase
|
|
dotnet_naming_rule.locals_should_be_camel_case.severity = suggestion
|
|
dotnet_naming_rule.locals_should_be_camel_case.symbols = locals_and_parameters
|
|
dotnet_naming_rule.locals_should_be_camel_case.style = camel_case_style
|
|
|
|
dotnet_naming_symbols.locals_and_parameters.applicable_kinds = parameter, local
|
|
|
|
dotnet_naming_style.camel_case_style.capitalization = camel_case
|
|
|
|
# Local functions are PascalCase
|
|
dotnet_naming_rule.local_functions_should_be_pascal_case.severity = suggestion
|
|
dotnet_naming_rule.local_functions_should_be_pascal_case.symbols = local_functions
|
|
dotnet_naming_rule.local_functions_should_be_pascal_case.style = local_function_style
|
|
|
|
dotnet_naming_symbols.local_functions.applicable_kinds = local_function
|
|
|
|
dotnet_naming_style.local_function_style.capitalization = pascal_case
|
|
|
|
# By default, name items with PascalCase
|
|
dotnet_naming_rule.members_should_be_pascal_case.severity = suggestion
|
|
dotnet_naming_rule.members_should_be_pascal_case.symbols = all_members
|
|
dotnet_naming_rule.members_should_be_pascal_case.style = pascal_case_style
|
|
|
|
dotnet_naming_symbols.all_members.applicable_kinds = *
|
|
|
|
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
|
|
|
|
# Symbol specifications
|
|
|
|
dotnet_naming_symbols.interface.applicable_kinds = interface
|
|
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
|
|
dotnet_naming_symbols.interface.required_modifiers =
|
|
|
|
dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
|
|
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
|
|
dotnet_naming_symbols.types.required_modifiers =
|
|
|
|
dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
|
|
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
|
|
dotnet_naming_symbols.non_field_members.required_modifiers =
|
|
|
|
# Naming styles
|
|
|
|
dotnet_naming_style.pascal_case.required_prefix =
|
|
dotnet_naming_style.pascal_case.required_suffix =
|
|
dotnet_naming_style.pascal_case.word_separator =
|
|
dotnet_naming_style.pascal_case.capitalization = pascal_case
|
|
|
|
dotnet_naming_style.begins_with_i.required_prefix = I
|
|
dotnet_naming_style.begins_with_i.required_suffix =
|
|
dotnet_naming_style.begins_with_i.word_separator =
|
|
dotnet_naming_style.begins_with_i.capitalization = pascal_case
|
|
|
|
# Async methods should have "Async" suffix
|
|
dotnet_naming_rule.async_methods_end_in_async.symbols = any_async_methods
|
|
dotnet_naming_rule.async_methods_end_in_async.style = end_in_async
|
|
dotnet_naming_rule.async_methods_end_in_async.severity = suggestion
|
|
|
|
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_in_async.required_prefix =
|
|
dotnet_naming_style.end_in_async.required_suffix = Async
|
|
dotnet_naming_style.end_in_async.capitalization = pascal_case
|
|
dotnet_naming_style.end_in_async.word_separator =
|
|
|
|
# Exclude extension method 'this' parameter
|
|
#
|
|
# For all methods the default behaivor of the analyzer is to check to see if any argument is being
|
|
# used without a null check (this is good). However, for extension methods, this means that
|
|
# the "this" argument to the extension method is checked alongside of the other arguments.
|
|
#
|
|
# This is not great behavior as an extension method should behave like an instance method and we should
|
|
# allow a NullRefException be generated if we attempt to access the "this" object.
|
|
#
|
|
# This flag ignores all of the "this" arguments but still reports the others.
|
|
dotnet_code_quality.CA1062.exclude_extension_method_this_parameter = true
|
|
|
|
|
|
# All of these severity changes below were because of an upgrade to the 3.3.1 analyzers which turned them
|
|
# from warnings to errors. As we fix these warnings we should remove these lines to allow the default behaivor
|
|
# and break the build.
|
|
# CA2016: Forward the 'CancellationToken' parameter to methods that take one
|
|
dotnet_diagnostic.CA2016.severity = warning
|
|
# CA1805: Do not initialize unnecessarily
|
|
dotnet_diagnostic.CA1805.severity = warning
|
|
# CA1834: Consider using 'StringBuilder.Append(char)' when applicable
|
|
dotnet_diagnostic.CA1834.severity = warning
|
|
# CA2000: Dispose objects before losing scope
|
|
dotnet_diagnostic.CA2000.severity = warning
|
|
|
|
# CA2208: Instantiate argument exceptions correctly
|
|
# CA2208 is suggesting that the argument that is passed to ArgumentNullException should match a name of a parameter
|
|
# in the signature of the method that is throwing the exception. However, many of the CA2208 warning instances is
|
|
# because the code throws an ArgumentNullException while passing in a property (or a field) on the object that is
|
|
# passed into the method that is throwing the exception. A proper fix for this would be to throw an ArgumentException
|
|
# instead. However, many of these instances are of a public method. So changing the exception being thrown is a breaking change.
|
|
dotnet_diagnostic.CA2208.severity = suggestion |