; EditorConfig to support per-solution formatting. ; Use the EditorConfig VS add-in to make this work. ; http://editorconfig.org/ ; ; Here are some resources for what's supported for .NET/C# ; https://kent-boogaart.com/blog/editorconfig-reference-for-c-developers ; https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference?view=vs-2017 ; ; Be **careful** editing this because some of the rules don't support adding a severity level ; For instance if you change to `dotnet_sort_system_directives_first = true:warning` (adding `:warning`) ; then the rule will be silently ignored. ; This is the default for the codeline. root = true [*] indent_style = space charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true [*.cs] indent_size = 4 dotnet_sort_system_directives_first = true # Don't use this. qualifier dotnet_style_qualification_for_field = false:suggestion dotnet_style_qualification_for_property = false:suggestion # use int x = .. over Int32 dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion # use int.MaxValue over Int32.MaxValue dotnet_style_predefined_type_for_member_access = true:suggestion # Require var all the time. csharp_style_var_for_built_in_types = true:suggestion csharp_style_var_when_type_is_apparent = true:suggestion csharp_style_var_elsewhere = true:suggestion # Disallow throw expressions. csharp_style_throw_expression = false:suggestion # 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 # Namespace settings csharp_style_namespace_declarations = file_scoped:warning [*.{xml,config,*proj,nuspec,props,resx,targets,yml,tasks}] indent_size = 2 # Xml config files [*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}] indent_size = 2 [*.json] indent_size = 2 [*.{ps1,psm1}] indent_size = 4 [*.sh] indent_size = 4 end_of_line = lf [*.{razor,cshtml}] charset = utf-8-bom [*.{cs,vb}] # CA1018: Mark attributes with AttributeUsageAttribute dotnet_diagnostic.CA1018.severity = warning # CA1047: Do not declare protected member in sealed type dotnet_diagnostic.CA1047.severity = warning # CA1305: Specify IFormatProvider dotnet_diagnostic.CA1305.severity = warning # CA1507: Use nameof to express symbol names dotnet_diagnostic.CA1507.severity = warning # CA1725: Parameter names should match base declaration dotnet_diagnostic.CA1725.severity = suggestion # CA1802: Use literals where appropriate dotnet_diagnostic.CA1802.severity = warning # CA1805: Do not initialize unnecessarily dotnet_diagnostic.CA1805.severity = warning # CA1810: Do not initialize unnecessarily dotnet_diagnostic.CA1810.severity = suggestion # CA1821: Remove empty Finalizers dotnet_diagnostic.CA1821.severity = warning # CA1822: Make member static dotnet_diagnostic.CA1822.severity = suggestion # CA1823: Avoid unused private fields dotnet_diagnostic.CA1823.severity = warning # CA1825: Avoid zero-length array allocations dotnet_diagnostic.CA1825.severity = warning # CA1826: Do not use Enumerable methods on indexable collections. Instead use the collection directly dotnet_diagnostic.CA1826.severity = warning # CA1827: Do not use Count() or LongCount() when Any() can be used dotnet_diagnostic.CA1827.severity = warning # CA1828: Do not use CountAsync() or LongCountAsync() when AnyAsync() can be used dotnet_diagnostic.CA1828.severity = warning # CA1829: Use Length/Count property instead of Count() when available dotnet_diagnostic.CA1829.severity = warning # CA1830: Prefer strongly-typed Append and Insert method overloads on StringBuilder dotnet_diagnostic.CA1830.severity = warning # CA1831: Use AsSpan or AsMemory instead of Range-based indexers when appropriate # CA1832: Use AsSpan or AsMemory instead of Range-based indexers when appropriate # CA1833: Use AsSpan or AsMemory instead of Range-based indexers when appropriate dotnet_diagnostic.CA1831.severity = warning dotnet_diagnostic.CA1832.severity = warning dotnet_diagnostic.CA1833.severity = warning # CA1834: Consider using 'StringBuilder.Append(char)' when applicable dotnet_diagnostic.CA1834.severity = warning # CA1835: Prefer the 'Memory'-based overloads for 'ReadAsync' and 'WriteAsync' dotnet_diagnostic.CA1835.severity = warning # CA1836: Prefer IsEmpty over Count dotnet_diagnostic.CA1836.severity = warning # CA1837: Use 'Environment.ProcessId' dotnet_diagnostic.CA1837.severity = warning # CA1838: Avoid 'StringBuilder' parameters for P/Invokes dotnet_diagnostic.CA1838.severity = warning # CA1839: Use 'Environment.ProcessPath' dotnet_diagnostic.CA1839.severity = warning # CA1840: Use 'Environment.CurrentManagedThreadId' dotnet_diagnostic.CA1840.severity = warning # CA1841: Prefer Dictionary.Contains methods dotnet_diagnostic.CA1841.severity = warning # CA1842: Do not use 'WhenAll' with a single task dotnet_diagnostic.CA1842.severity = warning # CA1843: Do not use 'WaitAll' with a single task dotnet_diagnostic.CA1843.severity = warning # CA1845: Use span-based 'string.Concat' dotnet_diagnostic.CA1845.severity = warning # CA1846: Prefer AsSpan over Substring dotnet_diagnostic.CA1846.severity = warning # CA2008: Do not create tasks without passing a TaskScheduler dotnet_diagnostic.CA2008.severity = warning # CA2009: Do not call ToImmutableCollection on an ImmutableCollection value dotnet_diagnostic.CA2009.severity = warning # CA2011: Avoid infinite recursion dotnet_diagnostic.CA2011.severity = warning # CA2012: Use ValueTask correctly dotnet_diagnostic.CA2012.severity = warning # CA2013: Do not use ReferenceEquals with value types dotnet_diagnostic.CA2013.severity = warning # CA2014: Do not use stackalloc in loops. dotnet_diagnostic.CA2014.severity = warning # CA2016: Forward the 'CancellationToken' parameter to methods that take one dotnet_diagnostic.CA2016.severity = warning # CA2200: Rethrow to preserve stack details dotnet_diagnostic.CA2200.severity = warning # CA2208: Instantiate argument exceptions correctly dotnet_diagnostic.CA2208.severity = warning # IDE0035: Remove unreachable code dotnet_diagnostic.IDE0035.severity = warning # IDE0036: Order modifiers csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion dotnet_diagnostic.IDE0036.severity = warning # IDE0043: Format string contains invalid placeholder dotnet_diagnostic.IDE0043.severity = warning # IDE0044: Make field readonly dotnet_diagnostic.IDE0044.severity = warning # IDE0073: File header dotnet_diagnostic.IDE0073.severity = warning file_header_template = Licensed under the Apache License, Version 2.0 (the "License").\nYou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n https://github.com/FastTunnel/FastTunnel/edit/v2/LICENSE\nCopyright (c) 2019 Gui.H # IDE0161: Convert to file-scoped namespace dotnet_diagnostic.IDE0161.severity = warning end_of_line = crlf dotnet_style_qualification_for_field = false:suggestion dotnet_style_qualification_for_property = false:suggestion dotnet_style_qualification_for_method = false:silent dotnet_style_qualification_for_event = false:silent dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent dotnet_code_quality_unused_parameters = all:suggestion dotnet_style_readonly_field = true:suggestion dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent dotnet_style_allow_multiple_blank_lines_experimental = true:silent dotnet_style_allow_statement_immediately_after_block_experimental = true:silent 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:silent 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:silent dotnet_style_prefer_conditional_expression_over_return = true:silent 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_namespace_match_folder = true:suggestion [**/{test,samples,perf}/**.{cs,vb}] # CA1018: Mark attributes with AttributeUsageAttribute dotnet_diagnostic.CA1018.severity = suggestion # CA1507: Use nameof to express symbol names dotnet_diagnostic.CA1507.severity = suggestion # CA1802: Use literals where appropriate dotnet_diagnostic.CA1802.severity = suggestion # CA1805: Do not initialize unnecessarily dotnet_diagnostic.CA1805.severity = suggestion # CA1823: Avoid zero-length array allocations dotnet_diagnostic.CA1825.severity = suggestion # CA1826: Do not use Enumerable methods on indexable collections. Instead use the collection directly dotnet_diagnostic.CA1826.severity = suggestion # CA1827: Do not use Count() or LongCount() when Any() can be used dotnet_diagnostic.CA1827.severity = suggestion # CA1829: Use Length/Count property instead of Count() when available dotnet_diagnostic.CA1829.severity = suggestion # CA1834: Consider using 'StringBuilder.Append(char)' when applicable dotnet_diagnostic.CA1834.severity = suggestion # CA1835: Prefer the 'Memory'-based overloads for 'ReadAsync' and 'WriteAsync' dotnet_diagnostic.CA1835.severity = suggestion # CA1837: Use 'Environment.ProcessId' dotnet_diagnostic.CA1837.severity = suggestion # CA1838: Avoid 'StringBuilder' parameters for P/Invokes dotnet_diagnostic.CA1838.severity = suggestion # CA1841: Prefer Dictionary.Contains methods dotnet_diagnostic.CA1841.severity = suggestion # CA1844: Provide memory-based overrides of async methods when subclassing 'Stream' dotnet_diagnostic.CA1844.severity = suggestion # CA1845: Use span-based 'string.Concat' dotnet_diagnostic.CA1845.severity = suggestion # CA1846: Prefer AsSpan over Substring dotnet_diagnostic.CA1846.severity = suggestion # CA2008: Do not create tasks without passing a TaskScheduler dotnet_diagnostic.CA2008.severity = suggestion # CA2012: Use ValueTask correctly dotnet_diagnostic.CA2012.severity = suggestion # IDE0044: Make field readonly dotnet_diagnostic.IDE0044.severity = suggestion # CA2016: Forward the 'CancellationToken' parameter to methods that take one dotnet_diagnostic.CA2016.severity = suggestion # Defaults for content in the shared src/ and shared runtime dir [{**/Shared/runtime/**.{cs,vb},src/Shared/test/Shared.Tests/runtime/**.{cs,vb},**/microsoft.extensions.hostfactoryresolver.sources/**.{cs,vb}}] # IDE0161: Convert to file-scoped namespace dotnet_diagnostic.IDE0161.severity = silent [*.cs] #### 命名样式 #### # 命名规则 dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion 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 # 符号规范 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 = # 命名样式 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 csharp_using_directive_placement = outside_namespace:silent csharp_style_expression_bodied_methods = false:silent csharp_style_expression_bodied_constructors = false:silent csharp_style_expression_bodied_operators = false:silent csharp_style_expression_bodied_properties = true:silent csharp_style_expression_bodied_indexers = true:silent csharp_style_expression_bodied_accessors = true:silent csharp_style_expression_bodied_lambdas = true:silent csharp_style_expression_bodied_local_functions = false:silent csharp_style_conditional_delegate_call = true:suggestion csharp_prefer_simple_using_statement = true:suggestion csharp_prefer_braces = true:silent csharp_style_prefer_method_group_conversion = true:silent csharp_style_prefer_top_level_statements = true:silent csharp_prefer_static_local_function = true:suggestion csharp_style_prefer_readonly_struct = 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_prefer_switch_expression = true:suggestion csharp_style_prefer_pattern_matching = true:silent 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 [*.vb] #### 命名样式 #### # 命名规则 dotnet_naming_rule.interface_should_be_以_i_开始.severity = suggestion dotnet_naming_rule.interface_should_be_以_i_开始.symbols = interface dotnet_naming_rule.interface_should_be_以_i_开始.style = 以_i_开始 dotnet_naming_rule.类型_should_be_帕斯卡拼写法.severity = suggestion dotnet_naming_rule.类型_should_be_帕斯卡拼写法.symbols = 类型 dotnet_naming_rule.类型_should_be_帕斯卡拼写法.style = 帕斯卡拼写法 dotnet_naming_rule.非字段成员_should_be_帕斯卡拼写法.severity = suggestion dotnet_naming_rule.非字段成员_should_be_帕斯卡拼写法.symbols = 非字段成员 dotnet_naming_rule.非字段成员_should_be_帕斯卡拼写法.style = 帕斯卡拼写法 # 符号规范 dotnet_naming_symbols.interface.applicable_kinds = interface dotnet_naming_symbols.interface.applicable_accessibilities = public, friend, private, protected, protected_friend, private_protected dotnet_naming_symbols.interface.required_modifiers = dotnet_naming_symbols.类型.applicable_kinds = class, struct, interface, enum dotnet_naming_symbols.类型.applicable_accessibilities = public, friend, private, protected, protected_friend, private_protected dotnet_naming_symbols.类型.required_modifiers = dotnet_naming_symbols.非字段成员.applicable_kinds = property, event, method dotnet_naming_symbols.非字段成员.applicable_accessibilities = public, friend, private, protected, protected_friend, private_protected dotnet_naming_symbols.非字段成员.required_modifiers = # 命名样式 dotnet_naming_style.以_i_开始.required_prefix = I dotnet_naming_style.以_i_开始.required_suffix = dotnet_naming_style.以_i_开始.word_separator = dotnet_naming_style.以_i_开始.capitalization = pascal_case dotnet_naming_style.帕斯卡拼写法.required_prefix = dotnet_naming_style.帕斯卡拼写法.required_suffix = dotnet_naming_style.帕斯卡拼写法.word_separator = dotnet_naming_style.帕斯卡拼写法.capitalization = pascal_case dotnet_naming_style.帕斯卡拼写法.required_prefix = dotnet_naming_style.帕斯卡拼写法.required_suffix = dotnet_naming_style.帕斯卡拼写法.word_separator = dotnet_naming_style.帕斯卡拼写法.capitalization = pascal_case