From e1afc35f2401531623902eb52b78fded3bf0abb7 Mon Sep 17 00:00:00 2001 From: Joe Feser Date: Sun, 4 Aug 2024 19:46:09 -0500 Subject: [PATCH 1/4] feat(): centralize the .editorconfig to the root for consistency Signed-off-by: Joe Feser --- .editorconfig | 14 +++++++++++++- src/OpenSearch.Client/.editorconfig | 3 --- src/OpenSearch.Net/.editorconfig | 2 -- tests/Tests.ScratchPad/.editorconfig | 6 ------ tests/Tests/.editorconfig | 4 ---- 5 files changed, 13 insertions(+), 16 deletions(-) delete mode 100644 src/OpenSearch.Client/.editorconfig delete mode 100644 src/OpenSearch.Net/.editorconfig delete mode 100644 tests/Tests.ScratchPad/.editorconfig delete mode 100644 tests/Tests/.editorconfig diff --git a/.editorconfig b/.editorconfig index 63a79b9250..ddc8bc9591 100644 --- a/.editorconfig +++ b/.editorconfig @@ -177,6 +177,11 @@ csharp_preserve_single_line_statements = false csharp_preserve_single_line_blocks = true # Resharper + +resharper_check_namespace_highlighting=do_not_show + +resharper_csharp_accessor_owner_body=expression_body + resharper_csharp_braces_for_lock=required_for_multiline resharper_csharp_braces_for_using=required_for_multiline resharper_csharp_braces_for_while=required_for_multiline @@ -185,11 +190,18 @@ resharper_csharp_braces_for_for=required_for_multiline resharper_csharp_braces_for_fixed=required_for_multiline resharper_csharp_braces_for_ifelse=required_for_multiline -resharper_csharp_accessor_owner_body=expression_body +resharper_inheritdoc_invalid_usage_highlighting=do_not_show resharper_redundant_case_label_highlighting=do_not_show +resharper_redundant_anonymous_type_property_name_highlighting=do_not_show resharper_redundant_argument_default_value_highlighting=do_not_show +resharper_unused_member_local_highlighting=do_not_show +resharper_unused_parameter_local_highlighting=do_not_show +resharper_unused_variable_highlighting=do_not_show + +resharper_xUnit_1013_highlighting=do_not_show + [*.{sh,bat,ps1}] trim_trailing_whitespace=true insert_final_newline=true diff --git a/src/OpenSearch.Client/.editorconfig b/src/OpenSearch.Client/.editorconfig deleted file mode 100644 index e9ee2fe27b..0000000000 --- a/src/OpenSearch.Client/.editorconfig +++ /dev/null @@ -1,3 +0,0 @@ -[*.cs] -resharper_check_namespace_highlighting=do_not_show -resharper_inheritdoc_invalid_usage_highlighting=do_not_show diff --git a/src/OpenSearch.Net/.editorconfig b/src/OpenSearch.Net/.editorconfig deleted file mode 100644 index 2a1ed5ee6a..0000000000 --- a/src/OpenSearch.Net/.editorconfig +++ /dev/null @@ -1,2 +0,0 @@ -[*.cs] -resharper_check_namespace_highlighting=do_not_show diff --git a/tests/Tests.ScratchPad/.editorconfig b/tests/Tests.ScratchPad/.editorconfig deleted file mode 100644 index 828e8fb4f0..0000000000 --- a/tests/Tests.ScratchPad/.editorconfig +++ /dev/null @@ -1,6 +0,0 @@ -# scratchpad is suppose to have unused variables/methods/classes -[*.cs] -resharper_unused_variable_highlighting=do_not_show -resharper_unused_member_local_highlighting=do_not_show -resharper_unused_parameter_local_highlighting=do_not_show -resharper_redundant_anonymous_type_property_name_highlighting=do_not_show diff --git a/tests/Tests/.editorconfig b/tests/Tests/.editorconfig deleted file mode 100644 index 94cdea257c..0000000000 --- a/tests/Tests/.editorconfig +++ /dev/null @@ -1,4 +0,0 @@ -[*.cs] -resharper_xUnit_1013_highlighting=do_not_show -resharper_unused_variable_highlighting=do_not_show -resharper_redundant_anonymous_type_property_name_highlighting=do_not_show From d6f1dec4e0cebe5205a941c66470d1519fbbcac5 Mon Sep 17 00:00:00 2001 From: Joe Feser Date: Mon, 5 Aug 2024 20:33:43 -0500 Subject: [PATCH 2/4] feat(): add additional vs 2022 settings Signed-off-by: Joe Feser --- .editorconfig | 191 +++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 164 insertions(+), 27 deletions(-) diff --git a/.editorconfig b/.editorconfig index ddc8bc9591..b91307e8c4 100644 --- a/.editorconfig +++ b/.editorconfig @@ -17,6 +17,46 @@ indent_size = 2 [*.{cs,vb}] trim_trailing_whitespace = true +# 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 + +# 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 + +# 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 conventions https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-naming-conventions # currently not supported in Rider/Resharper so not using these for now @@ -103,78 +143,175 @@ dotnet_naming_symbols.public_members.applicable_accessibilities = public dotnet_naming_style.public_members.capitalization = pascal_case +# this. and Me. preferences +dotnet_style_qualification_for_event = false:error dotnet_style_qualification_for_field = false:error -dotnet_style_qualification_for_property = false:error dotnet_style_qualification_for_method = false:error -dotnet_style_qualification_for_event = false:error +dotnet_style_qualification_for_property = false:error # 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:error +# Parentheses preferences +dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity +dotnet_style_parentheses_in_other_binary_operators = always_for_clarity +dotnet_style_parentheses_in_other_operators = never_if_unnecessary +dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity + +# Modifier preferences +dotnet_style_require_accessibility_modifiers = for_non_interface_members:error +dotnet_style_readonly_field = true:error + # Suggest more modern language features when available -dotnet_style_object_initializer = true:error +# Expression-level preferences +dotnet_style_coalesce_expression = true:error dotnet_style_collection_initializer = true:error dotnet_style_explicit_tuple_names = true:error +dotnet_style_namespace_match_folder = true +dotnet_style_null_propagation = true:error +dotnet_style_object_initializer = true:error +dotnet_style_operator_placement_when_wrapping = beginning_of_line +dotnet_style_prefer_auto_properties = true +dotnet_style_prefer_collection_expression = true +dotnet_style_prefer_compound_assignment = true +dotnet_style_prefer_conditional_expression_over_assignment = true +dotnet_style_prefer_conditional_expression_over_return = true +dotnet_style_prefer_foreach_explicit_cast_in_source = when_strongly_typed dotnet_style_prefer_inferred_anonymous_type_member_names = true:error dotnet_style_prefer_inferred_tuple_names = true:error -dotnet_style_coalesce_expression = true:error -dotnet_style_null_propagation = true:error +dotnet_style_prefer_is_null_check_over_reference_equality_method = true +dotnet_style_prefer_simplified_boolean_expressions = true +dotnet_style_prefer_simplified_interpolation = true -dotnet_style_require_accessibility_modifiers = for_non_interface_members:error -dotnet_style_readonly_field = true:error +# Field preferences +dotnet_style_readonly_field = true + +# Parameter preferences +dotnet_code_quality_unused_parameters = all + +# Suppression preferences +dotnet_remove_unnecessary_suppression_exclusions = none + +# New line preferences +dotnet_style_allow_multiple_blank_lines_experimental = true +dotnet_style_allow_statement_immediately_after_block_experimental = true + +#### C# Coding Conventions #### -# CSharp code style settings: [*.cs] # Prefer "var" everywhere +csharp_style_var_elsewhere = true:error csharp_style_var_for_built_in_types = true:error csharp_style_var_when_type_is_apparent = true:error -csharp_style_var_elsewhere = true:error -csharp_style_expression_bodied_methods = true:error +csharp_style_expression_bodied_accessors = true:error csharp_style_expression_bodied_constructors = true:error +csharp_style_expression_bodied_indexers = true:error +csharp_style_expression_bodied_lambdas = true +csharp_style_expression_bodied_local_functions = false +csharp_style_expression_bodied_methods = true:error csharp_style_expression_bodied_operators = true:error csharp_style_expression_bodied_properties = true:error -csharp_style_expression_bodied_indexers = true:error -csharp_style_expression_bodied_accessors = true:error # Suggest more modern language features when available -csharp_style_pattern_matching_over_is_with_cast_check = true:error -csharp_style_pattern_matching_over_as_with_null_check = true:error -csharp_style_inlined_variable_declaration = true:error -csharp_style_deconstructed_variable_declaration = true:error + csharp_style_pattern_local_over_anonymous_function = true:error -csharp_style_throw_expression = true:error +csharp_style_pattern_matching_over_as_with_null_check = true:error +csharp_style_pattern_matching_over_is_with_cast_check = true:error +csharp_style_prefer_extended_property_pattern = true +csharp_style_prefer_not_pattern = true +csharp_style_prefer_pattern_matching = true +csharp_style_prefer_switch_expression = true + +# Null-checking preferences csharp_style_conditional_delegate_call = true:error -csharp_prefer_braces = false:warning +# Modifier preferences +csharp_prefer_static_local_function = true csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:error +csharp_style_prefer_readonly_struct = true +csharp_style_prefer_readonly_struct_member = true -# --- -# formatting conventions https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#formatting-conventions +# Code-block preferences +csharp_prefer_braces = false:warning +csharp_prefer_simple_using_statement = true +# csharp_style_namespace_declarations = file_scoped #This allows for no { } for namespaces +csharp_style_prefer_method_group_conversion = true +csharp_style_prefer_primary_constructors = false:warning +csharp_style_prefer_top_level_statements = true + +# Expression-level preferences +csharp_prefer_simple_default_expression = true +csharp_style_deconstructed_variable_declaration = true:error +csharp_style_implicit_object_creation_when_type_is_apparent = true +csharp_style_inlined_variable_declaration = true:error +csharp_style_prefer_index_operator = true +csharp_style_prefer_local_over_anonymous_function = true +csharp_style_prefer_null_check_over_type_check = true +csharp_style_prefer_range_operator = true +csharp_style_prefer_tuple_swap = true +csharp_style_prefer_utf8_string_literals = true +csharp_style_throw_expression = true:error +csharp_style_unused_value_assignment_preference = discard_variable +csharp_style_unused_value_expression_statement_preference = discard_variable + +# 'using' directive preferences +# csharp_using_directive_placement = outside_namespace + +# New line preferences +csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true +csharp_style_allow_blank_line_after_token_in_arrow_expression_clause_experimental = true +csharp_style_allow_blank_line_after_token_in_conditional_expression_experimental = true +csharp_style_allow_blank_lines_between_consecutive_braces_experimental = true +csharp_style_allow_embedded_statements_on_same_line_experimental = true # Newline settings (Allman yo!) -csharp_new_line_before_open_brace = all -csharp_new_line_before_else = true + csharp_new_line_before_catch = true +csharp_new_line_before_else = true csharp_new_line_before_finally = true -csharp_new_line_before_members_in_object_initializers = true # just a suggestion do to our JSON tests that use anonymous types to # represent json quite a bit (makes copy paste easier). 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 -# Indent +# 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 = one_less_than_current 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_between_method_declaration_parameter_list_parentheses = false +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 -#Wrap -csharp_preserve_single_line_statements = false +# Wrapping preferences csharp_preserve_single_line_blocks = true +csharp_preserve_single_line_statements = false # Resharper From 19cae06b0585cde035dde3d9bd00cdfe562effe8 Mon Sep 17 00:00:00 2001 From: Joe Feser Date: Tue, 6 Aug 2024 14:13:52 -0500 Subject: [PATCH 3/4] feat(): tweak the .editorconfig for dotnet format Signed-off-by: Joe Feser --- .editorconfig | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/.editorconfig b/.editorconfig index b91307e8c4..93b94d1685 100644 --- a/.editorconfig +++ b/.editorconfig @@ -170,7 +170,7 @@ dotnet_style_collection_initializer = true:error dotnet_style_explicit_tuple_names = true:error dotnet_style_namespace_match_folder = true dotnet_style_null_propagation = true:error -dotnet_style_object_initializer = true:error +dotnet_style_object_initializer = true:error # our setting:true:error. Set to false if performing a dotnet format dotnet_style_operator_placement_when_wrapping = beginning_of_line dotnet_style_prefer_auto_properties = true dotnet_style_prefer_collection_expression = true @@ -245,7 +245,7 @@ csharp_style_prefer_top_level_statements = true csharp_prefer_simple_default_expression = true csharp_style_deconstructed_variable_declaration = true:error csharp_style_implicit_object_creation_when_type_is_apparent = true -csharp_style_inlined_variable_declaration = true:error +csharp_style_inlined_variable_declaration = true:error # our setting:true:error. Set to false if performing a dotnet format csharp_style_prefer_index_operator = true csharp_style_prefer_local_over_anonymous_function = true csharp_style_prefer_null_check_over_type_check = true @@ -278,13 +278,14 @@ 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 +# Indentation preferences https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/csharp-formatting-options csharp_indent_block_contents = true csharp_indent_braces = false csharp_indent_case_contents = true csharp_indent_case_contents_when_block = true -csharp_indent_labels = one_less_than_current +csharp_indent_labels = one_less_than_current # our setting:one_less_than_current. Change to 'no_change' if running dotnet format to keep the current formatting https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/csharp-formatting-options#csharp_indent_labels csharp_indent_switch_labels = true + # Space preferences csharp_space_after_cast = false csharp_space_after_colon_in_inheritance_clause = true @@ -311,7 +312,7 @@ csharp_space_between_square_brackets = false # Wrapping preferences csharp_preserve_single_line_blocks = true -csharp_preserve_single_line_statements = false +csharp_preserve_single_line_statements = false #our setting:false. Set to true if performing a dotnet format https://stackoverflow.com/questions/49760158/visual-studio-2017-auto-formatting-single-line-if-statements-without-braces # Resharper From 6e405ed0118b88911b1067b3769e36239c56d934 Mon Sep 17 00:00:00 2001 From: Joe Feser Date: Fri, 9 Aug 2024 20:42:54 -0500 Subject: [PATCH 4/4] feat(): file_scope namespaces Signed-off-by: Joe Feser --- .editorconfig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.editorconfig b/.editorconfig index 93b94d1685..f251c140e6 100644 --- a/.editorconfig +++ b/.editorconfig @@ -236,7 +236,7 @@ csharp_style_prefer_readonly_struct_member = true # Code-block preferences csharp_prefer_braces = false:warning csharp_prefer_simple_using_statement = true -# csharp_style_namespace_declarations = file_scoped #This allows for no { } for namespaces +csharp_style_namespace_declarations = file_scoped:error #This allows for no { } for namespaces csharp_style_prefer_method_group_conversion = true csharp_style_prefer_primary_constructors = false:warning csharp_style_prefer_top_level_statements = true