From 6b5664ac8769a79b3ced2fdf558b43b3129cf18f Mon Sep 17 00:00:00 2001 From: Travis Illig Date: Tue, 26 May 2026 11:25:10 -0700 Subject: [PATCH] Standardize build metadata and code formatting --- .editorconfig | 364 +++++++++++------- .pre-commit-config.yaml | 6 +- build/Source.ruleset | 56 ++- build/Test.ruleset | 79 ++-- build/stylecop.json | 3 + default.proj | 3 +- .../AutofacServiceLocatorTests.cs | 2 +- 7 files changed, 309 insertions(+), 204 deletions(-) diff --git a/.editorconfig b/.editorconfig index 134e578..57b2d5a 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,8 +1,5 @@ -; EditorConfig to support per-solution formatting. -; Use the EditorConfig VS add-in to make this work. -; http://editorconfig.org/ - -; This is the default for the codeline. +# EditorConfig to support per-solution formatting. +# http://editorconfig.org/ root = true [*] @@ -10,13 +7,187 @@ indent_style = space trim_trailing_whitespace = true insert_final_newline = true -; .NET Code - almost, but not exactly, the same suggestions as corefx -; https://github.com/dotnet/corefx/blob/master/.editorconfig +# .NET Code [*.cs] indent_size = 4 charset = utf-8-bom -; New line preferences +# .NET project files and MSBuild - match defaults for VS +[*.{csproj,nuspec,proj,projitems,props,shproj,targets,vbproj,vcxproj,vcxproj.filters,vsixmanifest,vsct}] +indent_size = 2 + +# .NET solution files - match defaults for VS +[*.sln] +end_of_line = crlf +indent_style = tab + +# .NET XML solution files - match dotnet new sln defaults +[*.slnx] +indent_size = 2 + + +# Config - match XML and default nuget.config template +[*.config] +indent_size = 2 + +# Resources - match defaults for VS +[*.resx] +indent_size = 2 + +# Static analysis rulesets - match defaults for VS +[*.ruleset] +indent_size = 2 + +# HTML, XML - match defaults for VS +[*.{cshtml,html,xml}] +indent_size = 4 + +# JavaScript and JS mixes - match eslint settings; JSON also matches .NET Core templates +[*.{js,json,mjs,ts,vue}] +indent_size = 2 + +# Markdown - match markdownlint settings +[*.{md,markdown}] +indent_size = 2 + +# PowerShell - match defaults for New-ModuleManifest and PSScriptAnalyzer Invoke-Formatter +[*.{ps1,psd1,psm1}] +indent_size = 4 +charset = utf-8-bom + +# YAML - match standard YAML like Kubernetes and GitHub Actions +[*.{yaml,yml}] +indent_size = 2 + +# ReStructuredText - standard indentation format from examples +[*.rst] +indent_size = 2 + +# +# dotnet code style +# +[*.cs] + +# Sort using and Import directives with System.* appearing first +dotnet_sort_system_directives_first = true +dotnet_separate_import_directive_groups = false + +# Avoid this. unless absolutely 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:warning +dotnet_style_predefined_type_for_member_access = true:warning + +# Suggest more modern language features when available +dotnet_style_object_initializer = true:warning +dotnet_style_collection_initializer = true:warning +dotnet_style_coalesce_expression = true:warning +dotnet_style_null_propagation = true:warning +dotnet_style_explicit_tuple_names = true:warning + +# Whitespace options +dotnet_style_allow_multiple_blank_lines_experimental = false + +# Non-private static fields are PascalCase +dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.severity = warning +dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.symbols = non_private_static_fields +dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.style = non_private_static_field_style + +dotnet_naming_symbols.non_private_static_fields.applicable_kinds = field +dotnet_naming_symbols.non_private_static_fields.applicable_accessibilities = public, protected, internal, protected_internal, private_protected +dotnet_naming_symbols.non_private_static_fields.required_modifiers = static + +dotnet_naming_style.non_private_static_field_style.capitalization = pascal_case + +# Non-private readonly fields are PascalCase +dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.severity = warning +dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.symbols = non_private_readonly_fields +dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.style = non_private_readonly_field_style + +dotnet_naming_symbols.non_private_readonly_fields.applicable_kinds = field +dotnet_naming_symbols.non_private_readonly_fields.applicable_accessibilities = public, protected, internal, protected_internal, private_protected +dotnet_naming_symbols.non_private_readonly_fields.required_modifiers = readonly + +dotnet_naming_style.non_private_readonly_field_style.capitalization = pascal_case + +# Constants are PascalCase +dotnet_naming_rule.constants_should_be_pascal_case.severity = warning +dotnet_naming_rule.constants_should_be_pascal_case.symbols = constants +dotnet_naming_rule.constants_should_be_pascal_case.style = constant_style + +dotnet_naming_symbols.constants.applicable_kinds = field, local +dotnet_naming_symbols.constants.required_modifiers = const + +dotnet_naming_style.constant_style.capitalization = pascal_case + +# Static fields should be _camelCase +dotnet_naming_rule.static_fields_should_be_camel_case.severity = warning +dotnet_naming_rule.static_fields_should_be_camel_case.symbols = static_fields +dotnet_naming_rule.static_fields_should_be_camel_case.style = camel_case_underscore_style +dotnet_naming_symbols.static_fields.applicable_kinds = field +dotnet_naming_symbols.static_fields.required_modifiers = static + +dotnet_naming_style.static_field_style.capitalization = camel_case + +# Instance fields are camelCase and start with _ +dotnet_naming_rule.instance_fields_should_be_camel_case.severity = warning +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 = _ + +# Locals and parameters are camelCase +dotnet_naming_rule.locals_should_be_camel_case.severity = warning +dotnet_naming_rule.locals_should_be_camel_case.symbols = locals_and_parameters +dotnet_naming_rule.locals_should_be_camel_case.style = camel_case_style + +dotnet_naming_symbols.locals_and_parameters.applicable_kinds = parameter, local + +dotnet_naming_style.camel_case_style.capitalization = camel_case + +# Local functions are PascalCase +dotnet_naming_rule.local_functions_should_be_pascal_case.severity = warning +dotnet_naming_rule.local_functions_should_be_pascal_case.symbols = local_functions +dotnet_naming_rule.local_functions_should_be_pascal_case.style = local_function_style + +dotnet_naming_symbols.local_functions.applicable_kinds = local_function + +dotnet_naming_style.local_function_style.capitalization = pascal_case + +# By default, name items with PascalCase +dotnet_naming_rule.members_should_be_pascal_case.severity = warning +dotnet_naming_rule.members_should_be_pascal_case.symbols = all_members +dotnet_naming_rule.members_should_be_pascal_case.style = pascal_case_style + +dotnet_naming_symbols.all_members.applicable_kinds = * + +dotnet_naming_style.pascal_case_style.capitalization = pascal_case + +# IDE0035: Remove unreachable code +dotnet_diagnostic.IDE0035.severity = warning + +# IDE0036: Order modifiers +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 + +# IDE0055: Fix formatting +dotnet_diagnostic.IDE0055.severity = warning + +# C# code style +# +# Newline settings csharp_new_line_before_open_brace = all csharp_new_line_before_else = true csharp_new_line_before_catch = true @@ -25,90 +196,34 @@ 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 -; Indentation preferences +# 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 +csharp_indent_labels = flush_left -; Modifier preferences -csharp_preferred_modifier_order = public,private,protected,internal,file,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async:warning - -; Avoid this. unless absolutely 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 +# Whitespace options +# Each of the *_experimental rules has a corresponding IDE* setting. +csharp_style_allow_embedded_statements_on_same_line_experimental = false +dotnet_diagnostic.IDE2001.severity = warning +csharp_style_allow_blank_lines_between_consecutive_braces_experimental = false +dotnet_diagnostic.IDE2002.severity = warning +csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = false +dotnet_diagnostic.IDE2004.severity = warning +csharp_style_allow_blank_line_after_token_in_conditional_expression_experimental = false +dotnet_diagnostic.IDE2005.severity = warning +csharp_style_allow_blank_line_after_token_in_arrow_expression_clause_experimental = false +dotnet_diagnostic.IDE2006.severity = warning -; Types: use keywords instead of BCL types, using var is fine. -csharp_style_var_when_type_is_apparent = false:none -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 = 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.required_modifiers = const -dotnet_naming_style.pascal_case_style.capitalization = pascal_case +# Prefer "var" everywhere +dotnet_diagnostic.IDE0007.severity = warning +csharp_style_var_for_built_in_types = true:warning +csharp_style_var_when_type_is_apparent = true:warning +csharp_style_var_elsewhere = true:warning -; Static fields should be _camelCase -dotnet_naming_rule.static_fields_should_be_camel_case.severity = warning -dotnet_naming_rule.static_fields_should_be_camel_case.symbols = static_fields -dotnet_naming_rule.static_fields_should_be_camel_case.style = camel_case_underscore_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 - -; Static readonly fields should be PascalCase -dotnet_naming_rule.static_readonly_fields_should_be_pascal_case.severity = warning -dotnet_naming_rule.static_readonly_fields_should_be_pascal_case.symbols = static_readonly_fields -dotnet_naming_rule.static_readonly_fields_should_be_pascal_case.style = pascal_case_style -dotnet_naming_symbols.static_readonly_fields.applicable_kinds = field -dotnet_naming_symbols.static_readonly_fields.required_modifiers = static, readonly -dotnet_naming_symbols.static_readonly_fields.applicable_accessibilities = private, internal, private_protected - -; Internal and private fields should be _camelCase -dotnet_naming_rule.camel_case_for_private_internal_fields.severity = warning -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 - -; Code style defaults -csharp_using_directive_placement = outside_namespace:suggestion -dotnet_sort_system_directives_first = true -csharp_prefer_braces = true:refactoring -csharp_preserve_single_line_blocks = true:none -csharp_preserve_single_line_statements = false:none -csharp_prefer_static_local_function = true:suggestion -csharp_prefer_simple_using_statement = false:none -csharp_style_prefer_switch_expression = true:suggestion - -; Code quality -dotnet_style_readonly_field = true:suggestion -dotnet_code_quality_unused_parameters = non_public:suggestion - -; Expression-level preferences -dotnet_style_object_initializer = true:suggestion -dotnet_style_collection_initializer = true:suggestion -dotnet_style_explicit_tuple_names = true:suggestion -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_inferred_tuple_names = true:suggestion -dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion -dotnet_style_prefer_auto_properties = true:suggestion -dotnet_style_prefer_conditional_expression_over_assignment = true:refactoring -dotnet_style_prefer_conditional_expression_over_return = true:refactoring -csharp_prefer_simple_default_expression = true:suggestion - -# Expression-bodied members +# Prefer method-like constructs to have a block body csharp_style_expression_bodied_methods = true:refactoring csharp_style_expression_bodied_constructors = true:refactoring csharp_style_expression_bodied_operators = true:refactoring @@ -118,20 +233,15 @@ csharp_style_expression_bodied_accessors = true:refactoring csharp_style_expression_bodied_lambdas = true:refactoring csharp_style_expression_bodied_local_functions = true:refactoring -# Pattern matching -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 - -# Null checking preferences -csharp_style_throw_expression = true:suggestion -csharp_style_conditional_delegate_call = true:suggestion - -# Other features -csharp_style_namespace_declarations = file_scoped:suggestion -csharp_style_prefer_index_operator = false:none -csharp_style_prefer_range_operator = false:none -csharp_style_pattern_local_over_anonymous_function = false:none +# Suggest more modern language features when available +csharp_style_pattern_matching_over_is_with_cast_check = true:warning +csharp_style_pattern_matching_over_as_with_null_check = true:warning +csharp_style_inlined_variable_declaration = true:warning +csharp_style_throw_expression = true:warning +csharp_style_conditional_delegate_call = true:warning +csharp_style_prefer_extended_property_pattern = true:warning +csharp_style_namespace_declarations = file_scoped:warning +csharp_style_prefer_parameter_null_checking = false # Space preferences csharp_space_after_cast = false @@ -157,48 +267,30 @@ csharp_space_between_method_declaration_parameter_list_parentheses = false csharp_space_between_parentheses = false csharp_space_between_square_brackets = false -; .NET project files and MSBuild - match defaults for VS -[*.{csproj,nuspec,proj,projitems,props,shproj,targets,vbproj,vcxproj,vcxproj.filters,vsixmanifest,vsct}] -indent_size = 2 +# Blocks required +csharp_prefer_braces = true:warning +csharp_preserve_single_line_blocks = false +csharp_preserve_single_line_statements = false -; .NET solution files - match defaults for VS -[*.sln] -end_of_line = crlf -indent_style = tab +# IDE0011: Add braces +csharp_prefer_braces = when_multiline:warning +# NOTE: We need the below severity entry for Add Braces due to https://github.com/dotnet/roslyn/issues/44201 +dotnet_diagnostic.IDE0011.severity = warning -; Config - match XML and default nuget.config template -[*.config] -indent_size = 2 +# IDE0040: Add accessibility modifiers +dotnet_diagnostic.IDE0040.severity = warning -; Resources - match defaults for VS -[*.resx] -indent_size = 2 +# IDE0052: Remove unread private member +dotnet_diagnostic.IDE0052.severity = warning -; Static analysis rulesets - match defaults for VS -[*.ruleset] -indent_size = 2 +# IDE0059: Unnecessary assignment to a value +dotnet_diagnostic.IDE0059.severity = warning -; HTML, XML - match defaults for VS -[*.{cshtml,html,xml}] -indent_size = 4 - -; JavaScript and JS mixes - match eslint settings; JSON also matches .NET Core templates -[*.{js,json,ts,vue}] -indent_size = 2 +# IDE0060: Remove unused parameter +dotnet_diagnostic.IDE0060.severity = warning -; Markdown - match markdownlint settings -[*.{md,markdown}] -indent_size = 2 +# CA1012: Abstract types should not have public constructors +dotnet_diagnostic.CA1012.severity = warning -; PowerShell - match defaults for New-ModuleManifest and PSScriptAnalyzer Invoke-Formatter -[*.{ps1,psd1,psm1}] -indent_size = 4 -charset = utf-8-bom - -; ReStructuredText - standard indentation format from examples -[*.rst] -indent_size = 2 - -# YAML - match standard YAML like Kubernetes and GitHub Actions -[*.{yaml,yml}] -indent_size = 2 +# CA1822: Make member static +dotnet_diagnostic.CA1822.severity = warning diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e756d44..8066618 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: 3e8a8703264a2f4a69428a0aa4dcb512790b2c8c # frozen: v6.0.0 + rev: "3e8a8703264a2f4a69428a0aa4dcb512790b2c8c" # frozen: v6.0.0 hooks: - id: check-json - id: check-yaml @@ -8,13 +8,13 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/igorshubovych/markdownlint-cli - rev: e72a3ca1632f0b11a07d171449fe447a7ff6795e # frozen: v0.48.0 + rev: "e72a3ca1632f0b11a07d171449fe447a7ff6795e" # frozen: v0.48.0 hooks: - id: markdownlint args: - --fix - repo: https://github.com/tillig/json-sort-cli - rev: 2b7e147e0933bd30b58133b6f287e5c695ff4f0e # frozen: v3.0.1 + rev: "2b7e147e0933bd30b58133b6f287e5c695ff4f0e" # frozen: v3.0.1 hooks: - id: json-sort args: diff --git a/build/Source.ruleset b/build/Source.ruleset index 4d4e23d..459e4e0 100644 --- a/build/Source.ruleset +++ b/build/Source.ruleset @@ -4,47 +4,39 @@ + + + + + + + + + + + + + + - + + + - + + + - + - + - + - - - - - - - - - - - - - + - - - - - - - - - - - - - - diff --git a/build/Test.ruleset b/build/Test.ruleset index 2bfa7f8..3c26c01 100644 --- a/build/Test.ruleset +++ b/build/Test.ruleset @@ -2,17 +2,45 @@ + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + @@ -20,51 +48,40 @@ - - - - + + - + - + - + - - - + - + - - - + - - - + - - - + - + + + - + + + - + - + - + - - - - - diff --git a/build/stylecop.json b/build/stylecop.json index 8f5c703..20da2f6 100644 --- a/build/stylecop.json +++ b/build/stylecop.json @@ -9,6 +9,9 @@ "licenseName": "MIT" }, "xmlHeader": false + }, + "orderingRules": { + "usingDirectivesPlacement": "outsideNamespace" } } } diff --git a/default.proj b/default.proj index 6e56cbe..f51229e 100644 --- a/default.proj +++ b/default.proj @@ -56,7 +56,8 @@ - + + diff --git a/test/Autofac.Extras.CommonServiceLocator.Test/AutofacServiceLocatorTests.cs b/test/Autofac.Extras.CommonServiceLocator.Test/AutofacServiceLocatorTests.cs index d324500..ab9bf14 100644 --- a/test/Autofac.Extras.CommonServiceLocator.Test/AutofacServiceLocatorTests.cs +++ b/test/Autofac.Extras.CommonServiceLocator.Test/AutofacServiceLocatorTests.cs @@ -88,7 +88,7 @@ public void GetlAllInstance_ForUnknownType_ReturnEmptyEnumerable() { var instances = _locator.GetAllInstances(); IList list = new List(instances); - Assert.Equal(0, list.Count); + Assert.Empty(list); } [Fact]