diff --git a/src/modules/cmdpal/.editorconfig b/src/modules/cmdpal/.editorconfig index f93166a809..281fbeeee7 100644 --- a/src/modules/cmdpal/.editorconfig +++ b/src/modules/cmdpal/.editorconfig @@ -2,28 +2,44 @@ # You can modify the rules from these initially generated values to suit your own policies. # You can learn more about editorconfig here: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference. -[*.cs] +################################################## +# Global settings +################################################## -file_header_template = Copyright (c) Microsoft Corporation\r\nThe Microsoft Corporation licenses this file to you under the MIT license.\r\nSee the LICENSE file in the project root for more information. - -#Core editorconfig formatting - indentation - -#use soft tabs (spaces) for indentation +[*.{cs,vb}] +tab_width = 4 +indent_size = 4 +end_of_line = crlf indent_style = space +insert_final_newline = true +file_header_template = Copyright (c) Microsoft Corporation\nThe Microsoft Corporation licenses this file to you under the MIT license.\nSee the LICENSE file in the project root for more information. -#Formatting - new line options +################################################## +# C# specific formatting +################################################## + +[*.cs] +# ---------------------------------------------- +# Core editorconfig formatting - indentation +# ---------------------------------------------- #place else statements on a new line csharp_new_line_before_else = true #require braces to be on a new line for lambdas, methods, control_blocks, types, properties, and accessors (also known as "Allman" style) csharp_new_line_before_open_brace = all -#Formatting - organize using options +# ---------------------------------------------- +# Formatting - organize using options +# ---------------------------------------------- -#sort System.* using directives alphabetically, and place them before other usings +# sort System.* using directives alphabetically, and place them before other usings dotnet_sort_system_directives_first = true +# Do not place System.* using directives before other using directives. +dotnet_separate_import_directive_groups = false -#Formatting - spacing options +# ---------------------------------------------- +# Formatting - spacing options +# ---------------------------------------------- #require NO space between a cast and the value csharp_space_after_cast = false @@ -44,17 +60,29 @@ csharp_space_between_method_declaration_empty_parameter_list_parentheses = false #place a space character after the opening parenthesis and before the closing parenthesis of a method declaration parameter list. csharp_space_between_method_declaration_parameter_list_parentheses = false -#Formatting - wrapping options +# ---------------------------------------------- +# Formatting - wrapping options +# ---------------------------------------------- #leave code block on separate lines csharp_preserve_single_line_blocks = true +#put each statement on a separate line +csharp_preserve_single_line_statements = false -#Style - Code block preferences +################################################## +# C# style rules +################################################## + +# ---------------------------------------------- +# Style - Code block preferences +# ---------------------------------------------- #prefer curly braces even for one line of code csharp_prefer_braces = true:suggestion -#Style - expression bodied member options +# ---------------------------------------------- +# Style - expression bodied member options +# ---------------------------------------------- #prefer expression bodies for accessors csharp_style_expression_bodied_accessors = true:warning @@ -65,55 +93,73 @@ csharp_style_expression_bodied_methods = when_on_single_line:silent #prefer expression-bodied members for properties csharp_style_expression_bodied_properties = true:warning -#Style - expression level options +# ---------------------------------------------- +# Style - expression level options +# ---------------------------------------------- #prefer out variables to be declared before the method call csharp_style_inlined_variable_declaration = false:suggestion #prefer the language keyword for member access expressions, instead of the type name, for types that have a keyword to represent them dotnet_style_predefined_type_for_member_access = true:suggestion -#Style - Expression-level preferences +# ---------------------------------------------- +# Style - Expression-level preferences +# ---------------------------------------------- #prefer default over default(T) csharp_prefer_simple_default_expression = true:suggestion #prefer objects to be initialized using object initializers when possible dotnet_style_object_initializer = true:suggestion -#Style - implicit and explicit types +# ---------------------------------------------- +# Style - implicit and explicit types +# ---------------------------------------------- #prefer var over explicit type in all cases, unless overridden by another code style rule csharp_style_var_elsewhere = true:suggestion #prefer var is used to declare variables with built-in system types such as int -csharp_style_var_for_built_in_types = true:suggestion +csharp_style_var_for_built_in_types = true:warning #prefer var when the type is already mentioned on the right-hand side of a declaration expression csharp_style_var_when_type_is_apparent = true:suggestion -#Style - language keyword and framework type options +# ---------------------------------------------- +# Style - language keyword and framework type options +# ---------------------------------------------- #prefer the language keyword for local variables, method parameters, and class members, instead of the type name, for types that have a keyword to represent them dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion -#Style - Language rules -csharp_style_implicit_object_creation_when_type_is_apparent = true:warning -csharp_style_var_for_built_in_types = true:warning +# ---------------------------------------------- +# Style - Language rules +# ---------------------------------------------- -#Style - modifier options +csharp_style_implicit_object_creation_when_type_is_apparent = true:warning + +# ---------------------------------------------- +# Style - modifier options +# ---------------------------------------------- #prefer accessibility modifiers to be declared except for public interface members. This will currently not differ from always and will act as future proofing for if C# adds default interface methods. dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion -#Style - Modifier preferences +# ---------------------------------------------- +# Style - Modifier preferences +# ---------------------------------------------- #when this rule is set to a list of modifiers, prefer the specified ordering. csharp_preferred_modifier_order = public,private,protected,internal,static,async,readonly,override,sealed,abstract,virtual:warning dotnet_style_readonly_field = true:warning -#Style - Pattern matching +# ---------------------------------------------- +# Style - Pattern matching +# ---------------------------------------------- #prefer pattern matching instead of is expression with type casts csharp_style_pattern_matching_over_as_with_null_check = true:warning -#Style - qualification options +# ---------------------------------------------- +# Style - qualification options +# ---------------------------------------------- #prefer events not to be prefaced with this. or Me. in Visual Basic dotnet_style_qualification_for_event = false:suggestion @@ -123,20 +169,26 @@ dotnet_style_qualification_for_field = false:suggestion dotnet_style_qualification_for_method = false:suggestion #prefer properties not to be prefaced with this. or Me. in Visual Basic dotnet_style_qualification_for_property = false:suggestion -csharp_indent_labels = one_less_than_current -csharp_using_directive_placement = outside_namespace:silent -csharp_prefer_simple_using_statement = true:warning -csharp_style_namespace_declarations = file_scoped:warning + +# ---------------------------------------------- +# Style - expression bodies +# ---------------------------------------------- csharp_style_expression_bodied_operators = false:silent csharp_style_expression_bodied_indexers = true:silent csharp_style_expression_bodied_lambdas = true:silent csharp_style_expression_bodied_local_functions = false:silent +# ---------------------------------------------- +# Style - Miscellaneous preferences +# ---------------------------------------------- + +csharp_indent_labels = one_less_than_current +csharp_using_directive_placement = outside_namespace:silent +csharp_prefer_simple_using_statement = true:warning +csharp_style_namespace_declarations = file_scoped:warning + [*.{cs,vb}] dotnet_style_operator_placement_when_wrapping = beginning_of_line -tab_width = 4 -indent_size = 4 -end_of_line = crlf dotnet_style_coalesce_expression = true:suggestion dotnet_style_null_propagation = true:suggestion dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion @@ -146,12 +198,13 @@ dotnet_style_collection_initializer = true:suggestion dotnet_style_prefer_simplified_boolean_expressions = true:suggestion dotnet_style_prefer_conditional_expression_over_assignment = true:silent dotnet_style_prefer_conditional_expression_over_return = true:silent -[*.{cs,vb}] - -#Style - Unnecessary code rules csharp_style_unused_value_assignment_preference = discard_variable:warning -#### Naming styles #### +################################################## +# Naming rules +################################################## + +[*.{cs,vb}] # Naming rules @@ -203,7 +256,11 @@ dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion dotnet_style_prefer_compound_assignment = true:warning dotnet_style_prefer_simplified_interpolation = true:suggestion -# Diagnostic configuration +################################################## +# Diagnostics +################################################## + +[*.{cs,vb}] # CS8305: Type is for evaluation purposes only and is subject to change or removal in future updates. dotnet_diagnostic.CS8305.severity = suggestion