chore: dotnet format PRs (#3097)

Author: bitsandfoxes

.github/workflows/format-code.yml

@@ -0,0 +1,38 @@
+name: format code
+on:
+  pull_request:
+    paths:
+      - 'src/**'
+      - 'test/**'
+      - 'samples/**'
+      - '.github/workflows/format-code.yml'
+
+jobs:
+  format-code:
+    name: Format Code
+    runs-on: macos-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup Environment
+        uses: ./.github/actions/environment
+
+      - name: Restore .NET Dependencies
+        run: dotnet restore Sentry.sln --nologo
+
+      - name: Install dotnet format
+        run: dotnet tool install -g dotnet-format
+
+      - name: Format Code
+        # We're excluding `./**/*OptionsSetup.cs` from the format because the tool struggles with 
+        # source generators
+        run: dotnet format Sentry.sln --no-restore --exclude ./modules --exclude ./**/*OptionsSetup.cs
+
+      # actions/checkout fetches only a single commit in a detached HEAD state. Therefore
+      # we need to pass the current branch, otherwise we can't commit the changes.
+      # GITHUB_HEAD_REF is the name of the head branch. GitHub Actions only sets this for PRs.
+      - name: Commit Formatted Code
+        run: ./scripts/commit-formatted-code.sh $GITHUB_HEAD_REF

GlobalUsings.cs

@@ -12,8 +12,8 @@
 global using System.IO.Compression;
 global using System.IO.MemoryMappedFiles;
 global using System.Net;
-global using System.Net.Http.Headers;
 global using System.Net.Http;
+global using System.Net.Http.Headers;
 global using System.Net.NetworkInformation;
 global using System.Net.Sockets;
 global using System.Reflection;

benchmarks/Sentry.Benchmarks/SdkInitBenchmarks.cs

@@ -1,6 +1,6 @@
-using BenchmarkDotNet.Attributes;
-using BenchmarkDotNet.Engines;
+using BenchmarkDotNet.Attributes;
 using BenchmarkDotNet.Diagnostics.Windows.Configs;
+using BenchmarkDotNet.Engines;
 
 namespace Sentry.Benchmarks;
 

samples/Sentry.Samples.AspNetCore.Mvc/ExampleEventProcessor.cs

@@ -15,4 +15,4 @@ public SentryEvent Process(SentryEvent @event)
         @event.SetExtra("Response:HasStarted", _httpContext.HttpContext?.Response.HasStarted);
         return @event;
     }
-}
+}

samples/Sentry.Samples.AspNetCore.Mvc/SpecialExceptionProcessor.cs

@@ -12,4 +12,4 @@ protected override void ProcessException(
 
         sentryEvent.SetTag("IsSpecial", exception.IsSpecial.ToString());
     }
-}
+}

samples/Sentry.Samples.Azure.Functions.Worker/BadApple.cs

@@ -1,4 +1,4 @@
-namespace Sentry.Samples.Azure.Functions.Worker;
+namespace Sentry.Samples.Azure.Functions.Worker;
 
 internal static class BadApple
 {

samples/Sentry.Samples.Azure.Functions.Worker/SampleHttpTrigger.cs

@@ -1,4 +1,4 @@
-using System.Net;
+using System.Net;
 using Microsoft.Azure.Functions.Worker;
 using Microsoft.Azure.Functions.Worker.Http;
 using Microsoft.Extensions.Logging;

samples/Sentry.Samples.Azure.Functions.Worker/SampleTimerTrigger.cs

@@ -1,4 +1,4 @@
-using Microsoft.Azure.Functions.Worker;
+using Microsoft.Azure.Functions.Worker;
 using Microsoft.Extensions.Logging;
 
 namespace Sentry.Samples.Azure.Functions.Worker;

samples/Sentry.Samples.Console.Metrics/Program.cs

@@ -1,4 +1,4 @@
-using System.Diagnostics.Metrics;
+using System.Diagnostics.Metrics;
 using System.Text.RegularExpressions;
 
 namespace Sentry.Samples.Console.Metrics;
@@ -30,15 +30,15 @@ private static async Task Main()
                    // Initialize some (non null) ExperimentalMetricsOptions to enable Sentry Metrics,
                    options.ExperimentalMetrics = new ExperimentalMetricsOptions
                    {
-                        EnableCodeLocations = true, // Set this to false if you don't want to track code locations
-                        CaptureSystemDiagnosticsInstruments = [
+                       EnableCodeLocations = true, // Set this to false if you don't want to track code locations
+                       CaptureSystemDiagnosticsInstruments = [
                             // Capture System.Diagnostics.Metrics matching the name "HatCo.HatStore", which is the name
                             // of the custom HatsMeter defined above
                             "hats-sold"
                         ],
-                        // Capture all built in metrics (this is the default - you can override this to capture some or
-                        // none of these if you prefer)
-                        CaptureSystemDiagnosticsMeters = BuiltInSystemDiagnosticsMeters.All
+                       // Capture all built in metrics (this is the default - you can override this to capture some or
+                       // none of these if you prefer)
+                       CaptureSystemDiagnosticsMeters = BuiltInSystemDiagnosticsMeters.All
                    };
                }))
         {

samples/Sentry.Samples.Console.Native/Program.cs

@@ -28,7 +28,7 @@ async Task FirstFunctionAsync()
 async Task SecondFunctionAsync()
 {
     await Task.Delay(100);
-    #pragma warning disable CS0618
+#pragma warning disable CS0618
     SentrySdk.CauseCrash(CrashType.Native);
-    #pragma warning restore CS0618
+#pragma warning restore CS0618
 }