Last active
November 12, 2024 01:30
-
-
Save spencerkittleson/b271e3a9ecd680c17420275768d4c5f7 to your computer and use it in GitHub Desktop.
c# K&R Editor Config
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
# top-most EditorConfig file | |
root = true | |
# Unix-style newlines with a newline ending every file | |
[*] | |
end_of_line = lf | |
insert_final_newline = true | |
trim_trailing_whitespace = true | |
[*.cs] | |
indent_size = 4 | |
# "This." and "Me." qualifiers: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#this_and_me | |
dotnet_style_qualification_for_field = false : warning | |
dotnet_style_qualification_for_property = false : warning | |
dotnet_style_qualification_for_method = false : warning | |
dotnet_style_qualification_for_event = false : warning | |
# Language keywords instead of framework type names for type references: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#language_keywords | |
dotnet_style_predefined_type_for_locals_parameters_members = true : warning | |
dotnet_style_predefined_type_for_member_access = true : warning | |
# Modifier preferences: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#normalize_modifiers | |
dotnet_style_require_accessibility_modifiers = always : warning | |
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:warning | |
# Expression-level preferences: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#expression_level | |
dotnet_style_object_initializer = true : suggestion | |
dotnet_style_collection_initializer = 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 | |
# Null-checking preferences: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#null_checking | |
dotnet_style_coalesce_expression = true : suggestion | |
dotnet_style_null_propagation = true : suggestion | |
# Implicit and explicit types: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#var | |
csharp_style_var_for_built_in_types = true : suggestion | |
csharp_style_var_when_type_is_apparent = true : suggestion | |
csharp_style_var_elsewhere = true : suggestion | |
# Expression-bodied members: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#expression_bodied_members | |
csharp_style_expression_bodied_methods = false | |
csharp_style_expression_bodied_constructor = true : warning | |
csharp_style_expression_bodied_operators = true : warning | |
csharp_style_expression_bodied_properties = true : warning | |
csharp_style_expression_bodied_indexers = true : warning | |
csharp_style_expression_bodied_accessors = true : warning | |
# Pattern matching: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#pattern_matching | |
csharp_style_pattern_matching_over_is_with_cast_check = true : warning | |
csharp_style_pattern_matching_over_as_with_null_check = true : warning | |
# Inlined variable declarations: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#inlined_variable_declarations | |
csharp_style_inlined_variable_declaration = true : suggestion | |
# Expression-level preferences: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#expression_level_csharp | |
csharp_prefer_simple_default_expression = true : warning | |
csharp_style_deconstructed_variable_declaration = true : warning | |
csharp_style_pattern_local_over_anonymous_function = true : warning | |
# "Null" checking preferences: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#null_checking_csharp | |
csharp_style_throw_expression = true : warning | |
csharp_style_conditional_delegate_call = true : warning | |
# Code block preferences: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#code_block | |
csharp_prefer_braces = true : warning | |
# Organize usings: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#net-formatting-settings | |
dotnet_sort_system_directives_first = true | |
# C# formatting settings: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#c-formatting-settings | |
# Enforce K&R style | |
csharp_new_line_before_open_brace = none | |
csharp_new_line_before_else = false : warning | |
csharp_new_line_before_catch = false : warning | |
csharp_new_line_before_finally = false : warning | |
csharp_new_line_before_members_in_object_initializers = false : warning | |
csharp_new_line_before_members_in_anonymous_types = false : warning | |
csharp_new_line_between_query_expression_clauses = false : warning | |
# Indentation options: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#indent | |
csharp_indent_case_contents = true | |
csharp_indent_switch_labels = false | |
csharp_indent_labels = flush_left | |
# Spacing options: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#spacing | |
csharp_space_after_cast = false | |
csharp_space_after_keywords_in_control_flow_statements = false | |
csharp_space_between_method_declaration_parameter_list_parentheses = false | |
csharp_space_between_method_call_parameter_list_parentheses = false | |
csharp_space_between_parentheses = false | |
# Wrapping options: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#wrapping | |
csharp_preserve_single_line_statements = true | |
csharp_preserve_single_line_blocks = true | |
############################### | |
# Naming Conventions: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-naming-conventions | |
############################### | |
# Style Definitions | |
dotnet_naming_style.pascal_case_style.capitalization = pascal_case | |
dotnet_naming_style.camel_case_style.capitalization = camel_case | |
dotnet_naming_style.I_prefix_style.required_prefix = I | |
dotnet_naming_style.I_prefix_style.capitalization = pascal_case | |
# Use PascalCase for constant fields | |
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = warning | |
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.applicable_accessibilities = * | |
dotnet_naming_symbols.constant_fields.required_modifiers = const | |
# Use PascalCase for public fields | |
dotnet_naming_rule.pascal_case_for_public_fields.severity = warning | |
dotnet_naming_rule.pascal_case_for_public_fields.symbols = public_fields | |
dotnet_naming_rule.pascal_case_for_public_fields.style = pascal_case_style | |
dotnet_naming_symbols.public_fields.applicable_kinds = field | |
dotnet_naming_symbols.public_fields.applicable_accessibilities = public | |
# Interfaces must be PascalCase and have an I prefix | |
dotnet_naming_rule.interfaces_start_with_I.severity = warning | |
dotnet_naming_rule.interfaces_start_with_I.symbols = any_interface | |
dotnet_naming_rule.interfaces_start_with_I.style = I_prefix_style | |
dotnet_naming_symbols.any_interface.applicable_accessibilities = * | |
dotnet_naming_symbols.any_interface.applicable_kinds = interface | |
# Classes, structs, methods, enums, events, properties, namespaces, delegates must be PascalCase | |
dotnet_naming_rule.general_naming.severity = warning | |
dotnet_naming_rule.general_naming.symbols = general | |
dotnet_naming_rule.general_naming.style = pascal_case_style | |
dotnet_naming_symbols.general.applicable_kinds = class,struct,enum,property,method,event,namespace,delegate | |
dotnet_naming_symbols.general.applicable_accessibilities = * | |
# Everything else is camelCase | |
dotnet_naming_rule.everything_else_naming.severity = warning | |
dotnet_naming_rule.everything_else_naming.symbols = everything_else | |
dotnet_naming_rule.everything_else_naming.style = camel_case_style | |
dotnet_naming_symbols.everything_else.applicable_kinds = * | |
dotnet_naming_symbols.everything_else.applicable_accessibilities = * | |
# 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 = _ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment