Created
January 28, 2024 03:31
-
-
Save mwwhited/9992e60f054553e9ceb87ea43e3c5269 to your computer and use it in GitHub Desktop.
My favorite csharp .editorconfig settings
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/code-style-rule-options | |
############################### | |
# Core EditorConfig Options # | |
############################### | |
root = true | |
# All files | |
[*] | |
indent_style = space | |
# XML project files | |
[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}] | |
indent_size = 2 | |
# XML config files | |
[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}] | |
indent_size = 2 | |
# Code files | |
[*.{cs,csx,vb,vbx}] | |
indent_size = 4 | |
insert_final_newline = true | |
charset = utf-8-bom | |
############################### | |
# .NET Coding Conventions # | |
############################### | |
[*.{cs,vb}] | |
#### Naming styles #### | |
# Naming rules | |
dotnet_naming_rule.interface_should_be_begins_with_i.severity = warning | |
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 styles | |
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 | |
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.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_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 | |
dotnet_style_prefer_auto_properties = true:suggestion | |
dotnet_style_object_initializer = true:suggestion | |
dotnet_style_collection_initializer = true:suggestion | |
dotnet_style_prefer_simplified_boolean_expressions = true:suggestion | |
dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion | |
dotnet_style_prefer_conditional_expression_over_return = true:suggestion | |
dotnet_style_explicit_tuple_names = true:suggestion | |
dotnet_style_prefer_inferred_tuple_names = true:suggestion | |
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion | |
dotnet_style_prefer_compound_assignment = true:suggestion | |
dotnet_style_prefer_simplified_interpolation = true:suggestion | |
dotnet_style_namespace_match_folder = true:suggestion | |
dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion | |
dotnet_style_predefined_type_for_member_access = true:suggestion | |
dotnet_style_prefer_collection_expression = true:suggestion | |
dotnet_style_readonly_field = true:suggestion | |
dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion | |
dotnet_style_allow_multiple_blank_lines_experimental = false:suggestion | |
dotnet_style_allow_statement_immediately_after_block_experimental = true:silent | |
dotnet_code_quality_unused_parameters = non_public:suggestion | |
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_relational_binary_operators = never_if_unnecessary:suggestion | |
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:suggestion | |
dotnet_style_qualification_for_field = false:silent | |
dotnet_style_qualification_for_property = false:silent | |
dotnet_style_qualification_for_method = false:silent | |
dotnet_style_qualification_for_event = false:silent | |
[*.cs] | |
csharp_indent_labels = one_less_than_current | |
csharp_using_directive_placement = outside_namespace:suggestion | |
csharp_prefer_simple_using_statement = true:suggestion | |
csharp_prefer_braces = true:silent | |
csharp_style_namespace_declarations = file_scoped:suggestion | |
csharp_style_prefer_method_group_conversion = true:silent | |
csharp_style_prefer_top_level_statements = false:suggestion | |
csharp_style_expression_bodied_methods = when_on_single_line:suggestion | |
csharp_style_expression_bodied_constructors = true:suggestion | |
csharp_style_expression_bodied_operators = when_on_single_line:suggestion | |
csharp_style_expression_bodied_properties = true:suggestion | |
csharp_style_expression_bodied_indexers = true:suggestion | |
csharp_style_expression_bodied_accessors = true:suggestion | |
csharp_style_expression_bodied_lambdas = true:suggestion | |
csharp_style_expression_bodied_local_functions = true:suggestion | |
csharp_style_throw_expression = true:suggestion | |
#Spell check https://devblogs.microsoft.com/visualstudio/visual-studio-spell-checker-preview-now-available/ | |
spelling_languages = en-us | |
vsspell_ignored_words_global=Linq|Mvc|Api|Nullable|Queryable|Bson|deserialize|Serializer|Jwt|Middleware|Json | |
vsspell_ignored_words_framework=Searchable|Accessor|queueing|Auth|Templating|mongo|xslt|yaml|Username | |
vsspell_ignored_words_application=Dto|Blog|Vlog|Blogs|Admin|Dataloader|Cli|Bcc|Cc|Sms|Imap | |
vsspell_ignored_words_eliassen=Eliassen|Nucleus | |
dotnet_diagnostic.CA1822.severity = none # Mark members as static | |
dotnet_diagnostic.IDE0042.severity = none # Deconstruct variable declaration | |
dotnet_diagnostic.IDE0052.severity = none # Remove unread private member | |
dotnet_diagnostic.IDE0059.severity = none # Remove unnecessary value assignment | |
dotnet_diagnostic.IDE0060.severity = none # Remove unused parameter | |
dotnet_diagnostic.CA1861.severity = none # Avoid constant arrays as arguments | |
csharp_style_prefer_primary_constructors = true:suggestion | |
csharp_space_around_binary_operators = before_and_after | |
csharp_style_prefer_null_check_over_type_check = true:suggestion | |
csharp_prefer_simple_default_expression = true:suggestion | |
csharp_style_prefer_local_over_anonymous_function = true:suggestion | |
csharp_style_prefer_index_operator = true:suggestion | |
csharp_style_prefer_range_operator = true:suggestion | |
csharp_style_implicit_object_creation_when_type_is_apparent = true:suggestion | |
csharp_style_prefer_tuple_swap = true:suggestion | |
csharp_style_prefer_utf8_string_literals = true:suggestion | |
csharp_style_inlined_variable_declaration = true:suggestion | |
csharp_style_deconstructed_variable_declaration = true:suggestion | |
csharp_style_unused_value_assignment_preference = discard_variable:suggestion | |
csharp_style_unused_value_expression_statement_preference = discard_variable:silent | |
csharp_prefer_static_local_function = false:suggestion | |
csharp_style_prefer_readonly_struct = true:suggestion | |
csharp_style_prefer_readonly_struct_member = true:suggestion | |
csharp_style_allow_embedded_statements_on_same_line_experimental = true:silent | |
csharp_style_allow_blank_lines_between_consecutive_braces_experimental = true:silent | |
csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true:silent | |
csharp_style_allow_blank_line_after_token_in_conditional_expression_experimental = true:silent | |
csharp_style_allow_blank_line_after_token_in_arrow_expression_clause_experimental = true:silent | |
csharp_style_conditional_delegate_call = true:suggestion | |
csharp_style_prefer_switch_expression = true:suggestion | |
csharp_style_prefer_pattern_matching = true:suggestion | |
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion | |
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion | |
csharp_style_prefer_not_pattern = true:suggestion | |
csharp_style_prefer_extended_property_pattern = true:suggestion | |
csharp_style_var_for_built_in_types = true:suggestion | |
csharp_style_var_when_type_is_apparent = true:suggestion | |
csharp_style_var_elsewhere = true:suggestion | |
dotnet_sort_system_directives_first = false | |
dotnet_separate_import_directive_groups = false | |
dotnet_diagnostic.IDE0005.severity = warning |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment