-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Add .editorconfig #7357
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add .editorconfig #7357
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| # EditorConfig is awesome:http://EditorConfig.org | ||
| # .NET coding convention settings for EditorConfig | ||
| # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference | ||
| # | ||
| # The .editorconfig comes from Roslyn and CoreFX repositories: | ||
| # https://github.com/dotnet/corefx/blob/master/.editorconfig | ||
| # https://github.com/dotnet/roslyn/blob/master/.editorconfig | ||
|
|
||
| # Top-most EditorConfig file | ||
| root = true | ||
|
|
||
| # Don't use tabs for indentation. | ||
| [*] | ||
| indent_style = space | ||
| # (Please don't specify an indent_size here; that has too many unintended consequences.) | ||
|
|
||
| # Code files | ||
| [*.{cs,csx,cpp,h}] | ||
| indent_size = 4 | ||
| insert_final_newline = true | ||
| charset = utf-8 | ||
|
|
||
| # Xml project files | ||
| [*.{csproj,resx,ps1xml}] | ||
| indent_size = 2 | ||
|
|
||
| # JSON files | ||
| [*.json] | ||
| indent_size = 2 | ||
|
|
||
| # Xml files | ||
| [*.{xml,stylecop,resx,ruleset}] | ||
| indent_size = 2 | ||
|
|
||
| # Xml config files | ||
| [*.{props,targets,config,nuspec}] | ||
| indent_size = 2 | ||
|
|
||
| # Dotnet code style settings: | ||
| [*.{cs,cpp}] | ||
| # Sort using and Import directives with System.* appearing first | ||
| dotnet_sort_system_directives_first = true | ||
|
|
||
| # Avoid "this." and "Me." if not necessary | ||
| dotnet_style_qualification_for_field = false:suggestion | ||
| dotnet_style_qualification_for_property = false:suggestion | ||
| dotnet_style_qualification_for_method = false:suggestion | ||
| dotnet_style_qualification_for_event = false:suggestion | ||
|
|
||
| # Use language keywords instead of framework type names for type references | ||
| 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_style.pascal_case_style.capitalization = pascal_case | ||
|
|
||
| # Static fields should have s_ prefix | ||
| dotnet_naming_rule.static_fields_should_have_prefix.severity = suggestion | ||
| dotnet_naming_rule.static_fields_should_have_prefix.symbols = static_fields | ||
| dotnet_naming_rule.static_fields_should_have_prefix.style = static_prefix_style | ||
|
|
||
| dotnet_naming_symbols.static_fields.applicable_kinds = field | ||
| dotnet_naming_symbols.static_fields.required_modifiers = static | ||
|
|
||
| dotnet_naming_style.static_prefix_style.required_prefix = s_ | ||
| dotnet_naming_style.static_prefix_style.capitalization = camel_case | ||
|
|
||
| # Internal and private fields should be _camelCase | ||
| dotnet_naming_rule.camel_case_for_private_internal_fields.severity = suggestion | ||
| dotnet_naming_rule.camel_case_for_private_internal_fields.symbols = private_internal_fields | ||
| dotnet_naming_rule.camel_case_for_private_internal_fields.style = camel_case_underscore_style | ||
|
|
||
| dotnet_naming_symbols.private_internal_fields.applicable_kinds = field | ||
| dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal | ||
|
|
||
| dotnet_naming_style.camel_case_underscore_style.required_prefix = _ | ||
| dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case | ||
|
|
||
| # Suggest more modern language features when available | ||
| dotnet_style_object_initializer = true:suggestion | ||
| dotnet_style_collection_initializer = true:suggestion | ||
| dotnet_style_coalesce_expression = true:suggestion | ||
| dotnet_style_null_propagation = true:suggestion | ||
| dotnet_style_explicit_tuple_names = true:suggestion | ||
|
|
||
| # CSharp code style settings: | ||
| [*.cs] | ||
|
|
||
| csharp_preserve_single_line_blocks = true | ||
| csharp_preserve_single_line_statements = false | ||
|
|
||
| # Indentation preferences | ||
| csharp_indent_block_contents = true | ||
| csharp_indent_braces = false | ||
| csharp_indent_case_contents = true | ||
| csharp_indent_switch_labels = true | ||
| csharp_indent_labels = one_less_than_current | ||
|
|
||
| # Only use var when it's obvious what the variable type is | ||
| csharp_style_var_for_built_in_types = false:none | ||
| csharp_style_var_when_type_is_apparent = false:none | ||
| csharp_style_var_elsewhere = false:suggestion | ||
|
|
||
| # Prefer method-like constructs to have a block body | ||
| csharp_style_expression_bodied_methods = false:none | ||
| csharp_style_expression_bodied_constructors = false:none | ||
| csharp_style_expression_bodied_operators = false:none | ||
|
|
||
| # Prefer property-like constructs to have an expression-body | ||
| csharp_style_expression_bodied_properties = true:none | ||
| csharp_style_expression_bodied_indexers = true:none | ||
| csharp_style_expression_bodied_accessors = true:none | ||
|
|
||
| # Suggest more modern language features when available | ||
| 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 | ||
| csharp_style_throw_expression = true:suggestion | ||
| csharp_style_conditional_delegate_call = true:suggestion | ||
|
|
||
| # 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_after_semicolon_in_for_statement = true | ||
| csharp_space_around_binary_operators = before_and_after | ||
| csharp_space_around_declaration_statements = do_not_ignore | ||
| 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 | ||
|
|
||
| # Newline settings | ||
| 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 | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This isn't in our style: https://github.com/PowerShell/PowerShell/blob/master/docs/dev-process/coding-guidelines.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please clarify? We have in the guideline:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I must have misread the guidance. Resolved