fix: Update code style rules and improve SARIF logging (#121)

* fix: Update code style rules and improve SARIF logging

- Increased max line length to 200 for XML/JSON/config files in .editorconfig
- Added naming rule for static readonly fields (PascalCase, error)
- Disabled style rules for .received.*, .verified.*, and migration files
- Updated .csharpierignore to ignore NuGet config and test output files
- Renamed _newLineSeparator to NewLineSeparator in ProjectFactory.cs
- Enhanced SARIF result logging: only log on errors/warnings and when logger is enabled, with CA1873 suppression

* refactor: Rename variables for improved clarity and consistency

Author: samtrion

.csharpierignore

@@ -1,3 +1,3 @@
-**/nuget.config
-**/_snapshots/
-**/_snapshot/
+**/[Nn]u[Gg]et.config
+**/*.verified.*
+**/*.received.*

.editorconfig

@@ -44,19 +44,22 @@ generated_code = true
 # XML project files
 [*.{slnx,csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj,nativeproj,locproj}]
 indent_size = 2
-max_line_length = 160
+max_line_length = 200
 
 # Xml build files
 [*.builds]
 indent_size = 2
+max_line_length = 200
 
 # Xml files
 [*.{xml,stylecop,resx,ruleset}]
 indent_size = 2
+max_line_length = 200
 
 # XML config files
 [*.{props,targets,ruleset,config,nuspec,vsixmanifest,vsct}]
 indent_size = 2
+max_line_length = 200
 
 # JSON files
 [*.json]
@@ -87,10 +90,6 @@ insert_final_newline = false
 [*.sln]
 indent_style = tab
 
-[*.{received,verified}.txt]
-insert_final_newline = false
-trim_trailing_whitespace = false
-
 [*.{cs,csx,vb,vbx}]
 # .NET Code Style Settings
 # See https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference
@@ -135,6 +134,13 @@ dotnet_naming_rule.all_const.severity                                   = error
 dotnet_naming_rule.all_const.style                                      = all_elements
 dotnet_naming_rule.all_const.symbols                                    = all_const
 
+dotnet_naming_style.all_static_readonly.capitalization                  = pascal_case
+dotnet_naming_symbols.all_static_readonly.applicable_kinds              = field
+dotnet_naming_symbols.all_static_readonly.required_modifiers            = static, readonly
+dotnet_naming_rule.all_static_readonly.severity                         = error
+dotnet_naming_rule.all_static_readonly.style                            = all_static_readonly
+dotnet_naming_rule.all_static_readonly.symbols                          = all_static_readonly
+
 dotnet_naming_style.all_fields.required_prefix                          = _
 dotnet_naming_style.all_fields.capitalization                           = camel_case
 dotnet_naming_symbols.all_fields.applicable_kinds                       = field
@@ -267,19 +273,18 @@ dotnet_diagnostic.IDE0290.severity                                      = sugges
 # [CSharpier] Incompatible rules deactivated
 # https://csharpier.com/docs/IntegratingWithLinters#code-analysis-rules
 dotnet_diagnostic.IDE0055.severity                                      = none
-dotnet_diagnostic.SA1000.severity                                       = none
-dotnet_diagnostic.SA1009.severity                                       = none
-dotnet_diagnostic.SA1111.severity                                       = none
-dotnet_diagnostic.SA1118.severity                                       = none
-dotnet_diagnostic.SA1137.severity                                       = none
-dotnet_diagnostic.SA1413.severity                                       = none
-dotnet_diagnostic.SA1500.severity                                       = none
-dotnet_diagnostic.SA1501.severity                                       = none
-dotnet_diagnostic.SA1502.severity                                       = none
-dotnet_diagnostic.SA1504.severity                                       = none
-dotnet_diagnostic.SA1515.severity                                       = none
-dotnet_diagnostic.SA1516.severity                                       = none
 
 # Support for NetEvolve.Arguments Methods
 # https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1062#null-check-validation-methods
 dotnet_code_quality.CA1062.null_check_validation_methods                = M:NetEvolve.Arguments.Argument.ThrowIfNull(System.Object,System.String)|M:NetEvolve.Arguments.Argument.ThrowIfNull(System.Void*,System.String)|M:NetEvolve.Arguments.Argument.ThrowIfNullOrEmpty(System.String,System.String)|M:NetEvolve.Arguments.Argument.ThrowIfNullOrEmpty``1(System.Collections.Generic.IEnumerable{``0},System.String)|M:NetEvolve.Arguments.Argument.ThrowIfNullOrWhiteSpace(System.String,System.String)
+
+# Disable all style rules for generated code
+[*.{received,verified}.*]
+generated_code = true
+# Disable all style rules for migrations
+dotnet_analyzer_diagnostic.severity = none
+
+[**/Migrations/*.{cs,csx,vb,vbx}]
+generated_code = true
+# Disable all style rules for migrations
+dotnet_analyzer_diagnostic.severity = none

Directory.Packages.props

@@ -4,6 +4,7 @@
     <CentralPackageTransitivePinningEnabled>true</CentralPackageTransitivePinningEnabled>
   </PropertyGroup>
   <ItemGroup>
+    <GlobalPackageReference Include="CSharpier.MSBuild" Version="1.2.6" />
     <GlobalPackageReference Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="4.14.0" />
     <GlobalPackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="10.0.201" />
     <GlobalPackageReference Include="Microsoft.SourceLink.GitHub" Version="10.0.201" />

ProjectBuilders.slnx

@@ -28,9 +28,6 @@
   <Folder Name="/tests/">
     <Project Path="tests/NetEvolve.ProjectBuilders.Tests.Unit/NetEvolve.ProjectBuilders.Tests.Unit.csproj" />
     <Project Path="tests/NetEvolve.ProjectBuilders.TUnit.Tests.Integration/NetEvolve.ProjectBuilders.TUnit.Tests.Integration.csproj" />
-    <Project
-      Path="tests/NetEvolve.ProjectBuilders.XUnit.Tests.Integration/NetEvolve.ProjectBuilders.XUnit.Tests.Integration.csproj"
-      Id="594f97b7-f15b-43c9-9067-996a157539ec"
-    />
+    <Project Path="tests/NetEvolve.ProjectBuilders.XUnit.Tests.Integration/NetEvolve.ProjectBuilders.XUnit.Tests.Integration.csproj" Id="594f97b7-f15b-43c9-9067-996a157539ec" />
   </Folder>
 </Solution>

src/NetEvolve.ProjectBuilders/Builders/TestPackageBuilder.cs

@@ -32,7 +32,7 @@ internal sealed class TestPackageBuilder : ITestPackageBuilder
     private TemporaryDirectoryBuilder? _nugetFolder;
     private readonly ISubdirectoryBuilder _directoy;
     private bool _isInitialized;
-    private static readonly SemaphoreSlim _lock = new SemaphoreSlim(1, 1);
+    private static readonly SemaphoreSlim Lock = new SemaphoreSlim(1, 1);
     private readonly HashSet<string> _packagePaths = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
 
     /// <inheritdoc cref="IObjectBuilder.FullPath"/>
@@ -49,7 +49,7 @@ internal sealed class TestPackageBuilder : ITestPackageBuilder
     /// <inheritdoc cref="IObjectBuilder.CreateAsync(CancellationToken)"/>
     public async ValueTask CreateAsync(CancellationToken cancellationToken = default)
     {
-        await _lock.WaitAsync(cancellationToken).ConfigureAwait(false);
+        await Lock.WaitAsync(cancellationToken).ConfigureAwait(false);
 
         try
         {
@@ -81,7 +81,7 @@ public async ValueTask CreateAsync(CancellationToken cancellationToken = default
         }
         finally
         {
-            _ = _lock.Release();
+            _ = Lock.Release();
         }
     }
 

src/NetEvolve.ProjectBuilders/Helpers/SharedHttpClient.cs

@@ -38,7 +38,7 @@
 /// </remarks>
 internal static class SharedHttpClient
 {
-    private static readonly Lazy<HttpClient> _instance = new(
+    private static readonly Lazy<HttpClient> InstanceLazy = new(
         CreateHttpClient,
         LazyThreadSafetyMode.ExecutionAndPublication
     );
@@ -53,7 +53,7 @@ internal static class SharedHttpClient
     /// </para>
     /// </remarks>
     /// <value>The shared HttpClient instance configured with retry logic and connection pooling.</value>
-    public static HttpClient Instance { get; } = _instance.Value;
+    public static HttpClient Instance { get; } = InstanceLazy.Value;
 
     [SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "As designed.")]
     private static HttpClient CreateHttpClient()

src/NetEvolve.ProjectBuilders/Models/TargetFramework.cs

@@ -84,8 +84,8 @@ private TargetFramework(string name, string value, TargetPlatform? platform)
         Platform = platform;
     }
 
-    private static readonly HashSet<TargetFramework> _values = [];
-    internal static TargetFramework[] Values => [.. _values];
+    private static readonly HashSet<TargetFramework> ValuesSet = [];
+    internal static TargetFramework[] Values => [.. ValuesSet];
 
     /// <summary>
     /// Creates a custom target framework instance.
@@ -130,7 +130,7 @@ public static TargetFramework Create(string name, string value, TargetPlatform?
 
         var targetFramework = new TargetFramework(name, value, platform);
 
-        if (!_values.Add(targetFramework))
+        if (!ValuesSet.Add(targetFramework))
         {
             throw new ArgumentException("TargetFramework already registered.", nameof(name));
         }

src/NetEvolve.ProjectBuilders/ProjectFactory.cs

@@ -72,7 +72,7 @@ public sealed partial class ProjectFactory : IProjectFactory
     /// <inheritdoc cref="IProjectFactory.DirectoryBuilder" />
     public ISubdirectoryBuilder DirectoryBuilder => _tempDirectory;
 
-    private static readonly string[] _newLineSeparator = ["\r\n", "\r", "\n"];
+    private static readonly string[] NewLineSeparator = ["\r\n", "\r", "\n"];
 
     internal ProjectFactory(
         ITestPackageBuilder? testPackageBuilder,
@@ -205,9 +205,11 @@ await Parallel
 
         EnrichSarifResults(sarif);
 
-        if (!sarif.HasNoErrorsOrWarnings())
+        if (!sarif.HasNoErrorsOrWarnings() && _logger.IsEnabled(LogLevel.Information))
         {
+#pragma warning disable CA1873 // Avoid potentially expensive logging
             LogSarifResult(string.Join('\n', sarif.Results.Select(x => x.ToString())));
+#pragma warning restore CA1873 // Avoid potentially expensive logging
         }
 
         return sarif;
@@ -277,9 +279,9 @@ await Cli.Wrap("dotnet")
     [GeneratedRegex(RulesFilterPattern, RegexOptions.Compiled)]
     public static partial Regex RulesFilter();
 #else
-    public static Regex RulesFilter() => _rulesFilter;
+    public static Regex RulesFilter() => RulesFilterField;
 
-    private static readonly Regex _rulesFilter = new Regex(RulesFilterPattern, RegexOptions.Compiled);
+    private static readonly Regex RulesFilterField = new Regex(RulesFilterPattern, RegexOptions.Compiled);
 #endif
 
     private void EnrichSarifResults(OutputFile? sarif)
@@ -291,7 +293,7 @@ private void EnrichSarifResults(OutputFile? sarif)
 
         var outputLines = _output
             .SelectMany(x =>
-                x.Split(_newLineSeparator, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries)
+                x.Split(NewLineSeparator, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries)
             )
             .ToArray();
         var filteredResults = new List<OutputRunResult>();