177 lines
7.1 KiB
INI
177 lines
7.1 KiB
INI
# To learn more about .editorconfig see https://aka.ms/editorconfigdocs
|
|
###############################
|
|
# Core EditorConfig Options #
|
|
###############################
|
|
# All files
|
|
[*]
|
|
charset = utf-8
|
|
indent_style = space
|
|
indent_size = 2
|
|
insert_final_newline = true
|
|
trim_trailing_whitespace = true
|
|
|
|
[*.sh]
|
|
end_of_line = lf
|
|
|
|
[*.{cs,cshtml,htm,html,md,py,sln,xml}]
|
|
indent_size = 4
|
|
|
|
###############################
|
|
# Copyright header #
|
|
###############################
|
|
[*.cs]
|
|
file_header_template = Copyright The OpenTelemetry Authors\nSPDX-License-Identifier: Apache-2.0
|
|
|
|
###############################
|
|
# .NET Coding Conventions #
|
|
###############################
|
|
# Directive order based on dotnet/runtime settings
|
|
# https://github.com/dotnet/runtime/blob/main/.editorconfig
|
|
[*.cs]
|
|
# New line preferences
|
|
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_case_contents = true
|
|
csharp_indent_switch_labels = true
|
|
csharp_indent_labels = flush_left
|
|
|
|
# Modifier preferences
|
|
csharp_preferred_modifier_order = public,private,protected,internal,file,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async:suggestion
|
|
dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion
|
|
|
|
# this. preferences
|
|
dotnet_style_qualification_for_field = true:suggestion
|
|
dotnet_style_qualification_for_property = true:suggestion
|
|
dotnet_style_qualification_for_method = true:suggestion
|
|
dotnet_style_qualification_for_event = true:suggestion
|
|
|
|
# var preferences, language keywords vs BCL types preferences
|
|
csharp_style_var_for_built_in_types = true:silent
|
|
csharp_style_var_when_type_is_apparent = true:silent
|
|
csharp_style_var_elsewhere = true:silent
|
|
dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
|
|
dotnet_style_predefined_type_for_member_access = true:suggestion
|
|
|
|
# name all constant fields using PascalCase
|
|
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
|
|
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
|
|
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
|
|
dotnet_naming_symbols.constant_fields.applicable_kinds = field
|
|
dotnet_naming_symbols.constant_fields.required_modifiers = const
|
|
dotnet_naming_symbols.constant_fields.applicable_accessibilities = *
|
|
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
|
|
|
|
# Code style defaults
|
|
dotnet_sort_system_directives_first = true
|
|
csharp_prefer_braces = true:silent
|
|
csharp_preserve_single_line_blocks = true
|
|
csharp_preserve_single_line_statements = true
|
|
csharp_prefer_simple_using_statement = true:suggestion
|
|
dotnet_style_readonly_field = true:suggestion
|
|
csharp_style_implicit_object_creation_when_type_is_apparent = true:suggestion
|
|
dotnet_style_prefer_simplified_interpolation = true:suggestion
|
|
dotnet_style_object_initializer = true:suggestion
|
|
csharp_style_prefer_primary_constructors = false:none
|
|
|
|
# Expression-level preferences
|
|
dotnet_style_object_initializer = true:suggestion
|
|
dotnet_style_collection_initializer = true:suggestion
|
|
dotnet_style_explicit_tuple_names = true:suggestion
|
|
dotnet_style_coalesce_expression = true:suggestion
|
|
dotnet_style_null_propagation = true:suggestion
|
|
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
|
|
dotnet_style_prefer_inferred_tuple_names = true:suggestion
|
|
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
|
|
dotnet_style_prefer_auto_properties = true:suggestion
|
|
dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion
|
|
dotnet_style_prefer_conditional_expression_over_return = true:suggestion
|
|
csharp_prefer_simple_default_expression = true:suggestion
|
|
csharp_style_unused_value_expression_statement_preference = discard_variable:none
|
|
|
|
# Expression-bodied members
|
|
csharp_style_expression_bodied_methods = true:suggestion
|
|
dotnet_diagnostic.IDE0022.severity = suggestion # dotnet format doesn't respect the suggestion in the line above
|
|
csharp_style_expression_bodied_constructors = false:warning
|
|
csharp_style_expression_bodied_operators = true:suggestion
|
|
csharp_style_expression_bodied_properties = true:suggestion
|
|
csharp_style_expression_bodied_indexers = true:suggestion
|
|
csharp_style_expression_bodied_accessors = true:suggestion
|
|
|
|
# Pattern matching
|
|
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
|
|
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
|
|
csharp_style_inlined_variable_declaration = true:suggestion
|
|
|
|
# Null checking preferences
|
|
csharp_style_throw_expression = true:suggestion
|
|
csharp_style_conditional_delegate_call = true:suggestion
|
|
|
|
# Other features
|
|
csharp_style_prefer_index_operator = false:none
|
|
csharp_style_prefer_range_operator = false:none
|
|
csharp_style_pattern_local_over_anonymous_function = true:suggestion
|
|
csharp_style_deconstructed_variable_declaration = true:suggestion
|
|
csharp_style_namespace_declarations = file_scoped:warning
|
|
dotnet_style_namespace_match_folder = false:none
|
|
|
|
# Space preferences
|
|
csharp_space_after_cast = false
|
|
csharp_space_after_colon_in_inheritance_clause = true
|
|
csharp_space_after_keywords_in_control_flow_statements = true
|
|
csharp_space_around_binary_operators = before_and_after
|
|
csharp_space_before_colon_in_inheritance_clause = true
|
|
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_parameter_list_parentheses = false
|
|
csharp_space_between_parentheses = false
|
|
|
|
# Parentheses preferences
|
|
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:suggestion
|
|
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:suggestion
|
|
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:suggestion
|
|
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:suggestion
|
|
|
|
# Code analyzers
|
|
# CA1031: Do not catch general exception types
|
|
dotnet_diagnostic.CA1031.severity = none
|
|
|
|
# CA1303: Do not pass literals as localized parameters
|
|
dotnet_diagnostic.CA1303.severity = none
|
|
|
|
# IDE0001: Simplify name
|
|
dotnet_diagnostic.IDE0001.severity = warning
|
|
|
|
# IDE0002: Simplify member access
|
|
dotnet_diagnostic.IDE0002.severity = warning
|
|
|
|
# IDE0005: Remove unnecessary import
|
|
dotnet_diagnostic.IDE0005.severity = warning
|
|
|
|
# RS0041: Public members should not use oblivious types
|
|
dotnet_diagnostic.RS0041.severity = suggestion
|
|
|
|
[*Tests.cs]
|
|
# CA1515: Disable making types internal for Tests classes. It is required by xunit
|
|
dotnet_diagnostic.CA1515.severity = none
|
|
|
|
# CA2007: Disable Consider calling ConfigureAwait on the awaited task. It is not working with xunit
|
|
dotnet_diagnostic.CA2007.severity = none
|
|
|
|
[**/obj/**.cs]
|
|
generated_code = true
|
|
|
|
[*.csproj]
|
|
indent_size = 2
|
|
|
|
[*.cshtml.cs]
|
|
dotnet_diagnostic.SA1649.severity = none
|