OSOE-110: Fix that the NuGet version of Lombiq Analyzer doesn't detect any analyzer violations

Lombiq.Analyzers.Tests/AnalyzerViolationTests.cs

@@ -0,0 +1,62 @@
+using Lombiq.HelpfulLibraries.Cli;
+using Shouldly;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Xunit;
+
+namespace Lombiq.Analyzers.Tests;
+
+public class AnalyzerViolationTests
+{
+    [Theory]
+    [MemberData(nameof(Data))]
+    public async Task AnalyzerViolationShouldBeReported(string solutionRelativePath)
+    {
+        var exception = (InvalidOperationException)await Should.ThrowAsync(
+            () => ExecuteStaticCodeAnalysisAsync(solutionRelativePath),
+            typeof(InvalidOperationException));
+
+        // Excepted exception codes:
+        // error IDE0021: Use expression body for constructors.
+        // error IDE0044: Make field readonly.
+        // error S2933: Make 'Number' 'readonly'.
+        // error S4487: Remove this unread private field 'Number' or refactor the code to use its value.
+
+        var exceptionCodes = new[] { "IDE0021", "IDE0044", "S2933", "S4487" };
+
+        exception
+            .Message
+            .Split(new[] { '\n', '\r' }, StringSplitOptions.None)
+            .Where(line => line.Contains(" error "))
+            .Select(line => line.RegexReplace(@"^.* error ([^:]+):.*$", "$1"))
+            .OrderBy(line => line)
+            .ShouldBe(exceptionCodes);
+    }
+
+    // See https://github.com/Lombiq/.NET-Analyzers/blob/dev/Docs/UsingAnalyzersDuringCommandLineBuilds.md#net-code-style-analysis
+    private static Task ExecuteStaticCodeAnalysisAsync(string solutionPath) =>
+        CliProgram.DotNet.ExecuteAsync(
+            CancellationToken.None,
+            "build",
+            Path.Combine("..", "..", "..", "..", "TestSolutions", solutionPath),
+            "--no-incremental",
+            "-warnaserror",
+            "/p:TreatWarningsAsErrors=true",
+            "/p:RunAnalyzersDuringBuild=true",
+            "-nologo",
+            "-consoleLoggerParameters:NoSummary",
+            "-verbosity:quiet");
+
+    public static IEnumerable<object[]> Data()
+    {
+        static object[] FromProjectName(string projectName) =>
+            new object[] { Path.Combine(projectName, projectName + ".csproj") };
+
+        yield return FromProjectName("Lombiq.Analyzers.PackageReference");
+        yield return FromProjectName("Lombiq.Analyzers.ProjectReference");
+    }
+}

Lombiq.Analyzers.Tests/Lombiq.Analyzers.Tests.csproj

@@ -0,0 +1,20 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.2.0" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\..\src\Libraries\Lombiq.HelpfulLibraries\Lombiq.HelpfulLibraries.Cli\Lombiq.HelpfulLibraries.Cli.csproj" />
+    <ProjectReference Include="..\..\..\test\Lombiq.Tests\Lombiq.Tests.csproj" />
+  </ItemGroup>
+
+</Project>

TestSolutions/AnalyzerViolations.cs

@@ -0,0 +1,11 @@
+namespace Lombiq.Analyzers.ProjectReference;
+
+// This file has intentional analyzer violations.
+public class Class1
+{
+    private int Number;
+    public Class1(int number)
+    {
+        Number = number;
+    }
+}

TestSolutions/Directory.Build.props

@@ -0,0 +1,6 @@
+<Project>
+  <PropertyGroup>
+    <!-- This property prevents the Directory.Build.props in the repository root. -->
+    <SkipRootBuildProps>true</SkipRootBuildProps>
+  </PropertyGroup>
+</Project>

TestSolutions/Lombiq.Analyzers.PackageReference/.editorconfig

@@ -0,0 +1,294 @@
+# WARNING: Only edit this file in the Lombiq .NET Analyzers repository's folder. A copy of this file anywhere else will
+# be overwritten.
+
+# Common .NET conventions, code formatting and naming convention rules. Check out possible configs here:
+# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference
+# If you found some issue then try to fix it, which you can also do from VS Quick Actions:
+# https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019#automatically-configure-code-styles
+# Add new file types at the bottom. For new rules for C# files follow the structure that VS generates.
+
+# All files
+[*]
+
+# Basics
+
+charset = utf-8
+guidelines = 120 1px dotted 80ff0000, 150 1px solid 80ff0000
+
+# Indentation and spacing
+indent_size = 4
+indent_style = space
+trim_trailing_whitespace = true
+
+
+# New line preferences
+end_of_line = crlf
+insert_final_newline = true
+dotnet_style_operator_placement_when_wrapping = beginning_of_line
+tab_width = 4
+dotnet_style_coalesce_expression = true:warning
+dotnet_style_null_propagation = true:warning
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:warning
+dotnet_style_prefer_auto_properties = true:warning
+
+# C# files
+[*.cs]
+
+#### .NET Coding Conventions ####
+
+# Organize usings
+dotnet_separate_import_directive_groups = false
+dotnet_sort_system_directives_first = false
+
+# this. and Me. preferences
+dotnet_style_qualification_for_event = false:warning
+dotnet_style_qualification_for_field = false:warning
+dotnet_style_qualification_for_method = false:warning
+dotnet_style_qualification_for_property = false:warning
+
+# Language keywords vs BCL types preferences
+dotnet_style_predefined_type_for_locals_parameters_members = true:warning
+dotnet_style_predefined_type_for_member_access = true:warning
+
+# Parentheses preferences
+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_other_operators = never_if_unnecessary:silent
+dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
+
+# Modifier preferences
+dotnet_style_require_accessibility_modifiers = always:warning
+
+# Expression-level preferences
+dotnet_style_coalesce_expression = true:warning
+dotnet_style_collection_initializer = true:warning
+dotnet_style_explicit_tuple_names = true:warning
+dotnet_style_null_propagation = true:warning
+dotnet_style_object_initializer = true:warning
+dotnet_style_prefer_auto_properties = true:warning
+dotnet_style_prefer_compound_assignment = true:warning
+dotnet_style_prefer_conditional_expression_over_assignment = true:warning
+dotnet_style_prefer_conditional_expression_over_return = false
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:warning
+dotnet_style_prefer_inferred_tuple_names = true:warning
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:warning
+dotnet_style_prefer_simplified_interpolation = true:warning
+
+# Field preferences
+dotnet_style_readonly_field = true:warning
+
+# Parameter preferences
+dotnet_code_quality_unused_parameters = non_pubic:suggestion
+
+#### C# Style Rules ####
+
+#IDE* rules are managed here.
+
+# Note that currently both IDE* rules and csharp_style_* rules are necessary, because only IDE rules will be enforced
+# during build, see: https://github.com/dotnet/roslyn/issues/44201.
+
+# Default severity for analyzer diagnostics with category 'Style' (escalated to build warnings)
+dotnet_analyzer_diagnostic.category-Style.severity = warning
+
+# IDE0011: Add braces to 'if' statement.
+# The "when-multiline:warning" config is not actually for cases when the if body is in another line so we have to turn
+# this off completely, see: https://github.com/dotnet/roslyn/issues/40912.
+dotnet_diagnostic.IDE0011.severity = none
+# IDE0050: Convert to tuple
+# Quite dangerous as we most frequently use anonymous types to interface with other APIs (like generating routes) and
+# those can fail on this silently in runtime while building correctly.
+dotnet_diagnostic.IDE0050.severity = none
+# IDE0052: Private member can be removed as the value assigned to it is never used.
+# We use S4487 for that.
+dotnet_diagnostic.IDE0052.severity = none
+# IDE0072: Populate switch
+# Also signals on switches with discards, by design: https://github.com/dotnet/roslyn/issues/48876.
+dotnet_diagnostic.IDE0072.severity = none
+# "Namespace 'Foo' does not match folder structure, expected 'Foo'"
+dotnet_diagnostic.IDE0130.severity = none
+
+# While these are in the Style category, they need to be explicitly set for some reason.
+# IDE0079 Remove unnecessary suppression
+dotnet_diagnostic.IDE0079.severity = warning
+dotnet_diagnostic.IDE0022.severity = warning
+
+# 'var' preferences
+dotnet_diagnostic.IDE0007.severity = warning
+dotnet_diagnostic.IDE0008.severity = none
+
+#### C# Coding Conventions ####
+
+# 'var' preferences
+# These won't take effect during build due to this bug:
+# https://github.com/dotnet/roslyn/issues/44250
+csharp_style_var_elsewhere = true:warning
+# If this is not turned off then there will be messages for e.g. integers too, like in for loops.
+csharp_style_var_for_built_in_types = false:none
+csharp_style_var_when_type_is_apparent = true:warning
+
+# Expression-bodied members
+csharp_style_expression_bodied_accessors = true:warning
+csharp_style_expression_bodied_constructors = true:warning
+csharp_style_expression_bodied_indexers = true:warning
+csharp_style_expression_bodied_lambdas = true:warning
+csharp_style_expression_bodied_local_functions = true:warning
+csharp_style_expression_bodied_methods = true:warning
+csharp_style_expression_bodied_operators = true:warning
+csharp_style_expression_bodied_properties = true:warning
+
+# Pattern matching preferences
+csharp_style_pattern_matching_over_as_with_null_check = true:warning
+csharp_style_pattern_matching_over_is_with_cast_check = true:warning
+csharp_style_prefer_switch_expression = true:warning
+
+# Null-checking preferences
+csharp_style_conditional_delegate_call = true:warning
+
+# Modifier preferences
+csharp_prefer_static_local_function = true:warning
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:silent
+
+# Code-block preferences
+csharp_prefer_simple_using_statement = true:warning
+# IDE0160: Convert to block-scoped namespace
+csharp_style_namespace_declarations = file_scoped:warning
+
+# Expression-level preferences
+csharp_prefer_simple_default_expression = true:warning
+csharp_style_deconstructed_variable_declaration = false:silent
+csharp_style_inlined_variable_declaration = true:warning
+csharp_style_pattern_local_over_anonymous_function = true:warning
+csharp_style_prefer_index_operator = true:warning
+csharp_style_prefer_range_operator = true:warning
+csharp_style_throw_expression = true:warning
+csharp_style_unused_value_assignment_preference = discard_variable:suggestion
+csharp_style_unused_value_expression_statement_preference = discard_variable:none
+
+# 'using' directive preferences
+csharp_using_directive_placement = outside_namespace:silent
+
+#### C# Formatting Rules ####
+
+# New line preferences
+csharp_new_line_before_catch = true
+csharp_new_line_before_else = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_open_brace = all
+csharp_new_line_between_query_expression_clauses = true
+
+# 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_labels = no_change
+csharp_indent_switch_labels = true
+
+# 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 = false
+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
+
+# Wrapping preferences
+csharp_preserve_single_line_blocks = true
+csharp_preserve_single_line_statements = true
+
+#### Naming styles ####
+
+# Naming rules
+
+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
+
+# Symbol specifications
+
+dotnet_naming_symbols.interface.applicable_kinds = interface
+dotnet_naming_symbols.interface.applicable_accessibilities = *
+dotnet_naming_symbols.interface.required_modifiers =
+
+dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
+dotnet_naming_symbols.types.applicable_accessibilities = *
+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 = *
+dotnet_naming_symbols.non_field_members.required_modifiers =
+
+# Naming styles
+
+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.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
+
+# Disabling "catch a more specific exception type" suggestion which is overwhelmingly a false positive.
+dotnet_diagnostic.CA1031.severity = silent
+# Disabling "do not nest type" suggestion.
+dotnet_diagnostic.CA1034.severity = silent
+# Disabling "CA1810: Initialize reference type static fields inline" as RSPEC-3963 is used instead.
+dotnet_diagnostic.CA1810.severity = none
+
+# Don't apply "CA1822: Mark members as static" to the public API
+dotnet_code_quality.ca1822.api_surface = private, internal
+csharp_prefer_braces = true:silent
+
+# Various config files
+[*.{config,csproj,json,props,targets}]
+
+indent_size = 2
+
+# Markdown files
+[*.md]
+
+trim_trailing_whitespace = false
+
+# JavaScript files
+[*.js]
+
+# Placeholder, no unique rules for JS files at the moment.
+
+
+# SCSS files
+[*.scss]
+
+# Placeholder, no unique rules for SCSS files at the moment.
+
+# PowerShell files
+[*.ps1]
+
+# Placeholder, no unique rules for PS files at the moment.