mirror of
https://github.com/PowerShell/PowerShell.git
synced 2024-11-23 17:53:58 +08:00
204 lines
7.9 KiB
INI
204 lines
7.9 KiB
INI
# EditorConfig is awesome: https://EditorConfig.org
|
|
# .NET coding convention settings for EditorConfig
|
|
# https://learn.microsoft.com/visualstudio/ide/editorconfig-code-style-settings-reference
|
|
#
|
|
# This file comes from dotnet repositories:
|
|
# https://github.com/dotnet/runtime/blob/master/.editorconfig
|
|
# https://github.com/dotnet/roslyn/blob/master/.editorconfig
|
|
|
|
# Top-most EditorConfig file
|
|
root = true
|
|
|
|
[*]
|
|
charset = utf-8
|
|
# indent_size intentionally not specified in this section
|
|
indent_style = space
|
|
insert_final_newline = true
|
|
|
|
# Source code
|
|
[*.{cs,ps1,psd1,psm1}]
|
|
indent_size = 4
|
|
|
|
# Shell scripts
|
|
[*.sh]
|
|
end_of_line = lf
|
|
indent_size = 4
|
|
|
|
# Xml project files
|
|
[*.{csproj,resx,ps1xml}]
|
|
indent_size = 2
|
|
|
|
# Data serialization
|
|
[*.{json,yaml,yml}]
|
|
indent_size = 2
|
|
|
|
# Markdown
|
|
[*.md]
|
|
indent_size = 2
|
|
|
|
# Xml files
|
|
[*.{resx,ruleset,stylecop,xml,xsd,xsl}]
|
|
indent_size = 2
|
|
|
|
# Xml config files
|
|
[*.{props,targets,config,nuspec}]
|
|
indent_size = 2
|
|
|
|
[*.tsv]
|
|
indent_style = tab
|
|
|
|
# Dotnet code style settings:
|
|
[*.cs]
|
|
# Ignore xUnit analyzer rule "Do not use blocking task operations in test method"
|
|
dotnet_diagnostic.xUnit1031.severity = none
|
|
|
|
# Sort using and Import directives with System.* appearing first
|
|
dotnet_sort_system_directives_first = true
|
|
|
|
file_header_template = Copyright (c) Microsoft Corporation.\nLicensed under the MIT License.
|
|
|
|
# Modifier preferences
|
|
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
|
|
|
|
# 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_symbols.static_fields.applicable_accessibilities = private, internal, private_protected
|
|
|
|
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
|
|
dotnet_style_readonly_field = true:suggestion
|
|
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
|
|
dotnet_style_prefer_inferred_tuple_names = true:suggestion
|
|
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
|
|
dotnet_style_prefer_conditional_expression_over_return = true:silent
|
|
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
|
|
dotnet_style_prefer_auto_properties = true:suggestion
|
|
csharp_prefer_simple_default_expression = true:suggestion
|
|
|
|
dotnet_code_quality_unused_parameters = non_public:suggestion
|
|
|
|
# CSharp code style settings:
|
|
[*.cs]
|
|
|
|
csharp_preserve_single_line_blocks = true
|
|
csharp_preserve_single_line_statements = false
|
|
csharp_prefer_braces = true:silent
|
|
|
|
csharp_prefer_static_local_function = true:suggestion
|
|
csharp_prefer_simple_using_statement = false:none
|
|
csharp_style_prefer_switch_expression = true:suggestion
|
|
csharp_style_prefer_range_operator = false:none
|
|
csharp_style_prefer_index_operator = false:none
|
|
csharp_style_pattern_local_over_anonymous_function = false:none
|
|
|
|
csharp_using_directive_placement = outside_namespace:suggestion
|
|
|
|
# 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_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
|
|
|
|
# Expression-bodied members
|
|
csharp_style_expression_bodied_local_functions = true:silent
|
|
|
|
# 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
|
|
csharp_new_line_between_query_expression_clauses = true
|