Merge pull request #759 from adamralph/refactor

adamralph · web-flow · commit c3e341675e1c · 2025-12-25T18:31:21.000Z
refactor private naming, qualification, and captured value type modification
diff --git a/.editorconfig b/.editorconfig
@@ -21,10 +21,10 @@ csharp_style_namespace_declarations                                       = file
 csharp_style_var_elsewhere                                                = true
 csharp_style_var_for_built_in_types                                       = true
 csharp_style_var_when_type_is_apparent                                    = true
-dotnet_style_qualification_for_event                                      = true
-dotnet_style_qualification_for_field                                      = true
-dotnet_style_qualification_for_method                                     = true
-dotnet_style_qualification_for_property                                   = true
+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
 file_header_template                                                      = unset
 indent_size                                                               = 4
 
diff --git a/SimpleExec/Command.cs b/SimpleExec/Command.cs
@@ -10,8 +10,8 @@ namespace SimpleExec;
 /// </summary>
 public static class Command
 {
-    private static readonly Action<IDictionary<string, string?>> defaultAction = _ => { };
-    private static readonly string defaultEchoPrefix = Assembly.GetEntryAssembly()?.GetName().Name ?? "SimpleExec";
+    private static readonly Action<IDictionary<string, string?>> DefaultAction = _ => { };
+    private static readonly string DefaultEchoPrefix = Assembly.GetEntryAssembly()?.GetName().Name ?? "SimpleExec";
 
     /// <summary>
     /// Runs a command without redirecting standard output (stdout) and standard error (stderr) and without writing to standard input (stdin).
@@ -58,9 +58,9 @@ public static void Run(
                 [],
                 workingDirectory,
                 false,
-                configureEnvironment ?? defaultAction,
+                configureEnvironment ?? DefaultAction,
                 createNoWindow)
-            .Run(noEcho, echoPrefix ?? defaultEchoPrefix, handleExitCode, cancellationIgnoresProcessTree, cancellationToken);
+            .Run(noEcho, echoPrefix ?? DefaultEchoPrefix, handleExitCode, cancellationIgnoresProcessTree, cancellationToken);
 
     /// <summary>
     /// Runs a command without redirecting standard output (stdout) and standard error (stderr) and without writing to standard input (stdin).
@@ -106,9 +106,9 @@ public static void Run(
                 args ?? throw new ArgumentNullException(nameof(args)),
                 workingDirectory,
                 false,
-                configureEnvironment ?? defaultAction,
+                configureEnvironment ?? DefaultAction,
                 createNoWindow)
-            .Run(noEcho, echoPrefix ?? defaultEchoPrefix, handleExitCode, cancellationIgnoresProcessTree, cancellationToken);
+            .Run(noEcho, echoPrefix ?? DefaultEchoPrefix, handleExitCode, cancellationIgnoresProcessTree, cancellationToken);
 
     private static void Run(
         this System.Diagnostics.ProcessStartInfo startInfo,
@@ -175,9 +175,9 @@ public static Task RunAsync(
                 [],
                 workingDirectory,
                 false,
-                configureEnvironment ?? defaultAction,
+                configureEnvironment ?? DefaultAction,
                 createNoWindow)
-            .RunAsync(noEcho, echoPrefix ?? defaultEchoPrefix, handleExitCode, cancellationIgnoresProcessTree, cancellationToken);
+            .RunAsync(noEcho, echoPrefix ?? DefaultEchoPrefix, handleExitCode, cancellationIgnoresProcessTree, cancellationToken);
 
     /// <summary>
     /// Runs a command asynchronously without redirecting standard output (stdout) and standard error (stderr) and without writing to standard input (stdin).
@@ -224,9 +224,9 @@ public static Task RunAsync(
                 args ?? throw new ArgumentNullException(nameof(args)),
                 workingDirectory,
                 false,
-                configureEnvironment ?? defaultAction,
+                configureEnvironment ?? DefaultAction,
                 createNoWindow)
-            .RunAsync(noEcho, echoPrefix ?? defaultEchoPrefix, handleExitCode, cancellationIgnoresProcessTree, cancellationToken);
+            .RunAsync(noEcho, echoPrefix ?? DefaultEchoPrefix, handleExitCode, cancellationIgnoresProcessTree, cancellationToken);
 
     private static async Task RunAsync(
         this System.Diagnostics.ProcessStartInfo startInfo,
@@ -291,7 +291,7 @@ private static async Task RunAsync(
                 [],
                 workingDirectory,
                 true,
-                configureEnvironment ?? defaultAction,
+                configureEnvironment ?? DefaultAction,
                 true,
                 encoding)
             .ReadAsync(
@@ -347,7 +347,7 @@ private static async Task RunAsync(
                 args ?? throw new ArgumentNullException(nameof(args)),
                 workingDirectory,
                 true,
-                configureEnvironment ?? defaultAction,
+                configureEnvironment ?? DefaultAction,
                 true,
                 encoding)
             .ReadAsync(
@@ -392,7 +392,7 @@ private static async Task RunAsync(
 #pragma warning disable CA1849 // Call async methods when in an async method
         var output = readOutput.Result;
         var error = readError.Result;
-#pragma warning restore CA1849 // Call async methods when in an async method
+#pragma warning restore CA1849
 
         return (handleExitCode?.Invoke(process.ExitCode) ?? false) || process.ExitCode == 0
             ? (output, error)
diff --git a/SimpleExec/ExitCodeException.cs b/SimpleExec/ExitCodeException.cs
@@ -6,13 +6,13 @@ namespace SimpleExec;
 /// <param name="exitCode">The exit code of the command.</param>
 #pragma warning disable CA1032 // Implement standard exception constructors
 public class ExitCodeException(int exitCode) : Exception
-#pragma warning restore CA1032 // Implement standard exception constructors
+#pragma warning restore CA1032
 {
     /// <summary>
     /// Gets the exit code of the command.
     /// </summary>
     public int ExitCode { get; } = exitCode;
 
     /// <inheritdoc/>
-    public override string Message => $"The command exited with code {this.ExitCode}.";
+    public override string Message => $"The command exited with code {ExitCode}.";
 }
diff --git a/SimpleExec/ExitCodeReadException.cs b/SimpleExec/ExitCodeReadException.cs
@@ -5,17 +5,17 @@ namespace SimpleExec;
 /// </summary>
 #pragma warning disable CA1032 // Implement standard exception constructors
 public class ExitCodeReadException : ExitCodeException
-#pragma warning restore CA1032 // Implement standard exception constructors
+#pragma warning restore CA1032
 {
-    private static readonly string twoNewLines = $"{Environment.NewLine}{Environment.NewLine}";
+    private static readonly string TwoNewLines = $"{Environment.NewLine}{Environment.NewLine}";
 
     /// <summary>
     /// Constructs an instance of a <see cref="ExitCodeReadException"/>.
     /// </summary>
     /// <param name="exitCode">The exit code of the command.</param>
     /// <param name="standardOutput">The contents of standard output (stdout).</param>
     /// <param name="standardError">The contents of standard error (stderr).</param>
-    public ExitCodeReadException(int exitCode, string standardOutput, string standardError) : base(exitCode) => (this.StandardOutput, this.StandardError) = (standardOutput, standardError);
+    public ExitCodeReadException(int exitCode, string standardOutput, string standardError) : base(exitCode) => (StandardOutput, StandardError) = (standardOutput, standardError);
 
     /// <summary>
     /// Gets the contents of standard output (stdout).
@@ -29,5 +29,5 @@ public class ExitCodeReadException : ExitCodeException
 
     /// <inheritdoc/>
     public override string Message =>
-        $"{base.Message}{twoNewLines}Standard output (stdout):{twoNewLines}{this.StandardOutput}{twoNewLines}Standard error (stderr):{twoNewLines}{this.StandardError}";
+        $"{base.Message}{TwoNewLines}Standard output (stdout):{TwoNewLines}{StandardOutput}{TwoNewLines}Standard error (stderr):{TwoNewLines}{StandardError}";
 }
diff --git a/SimpleExec/ProcessExtensions.cs b/SimpleExec/ProcessExtensions.cs
@@ -1,5 +1,6 @@
 using System.Diagnostics;
 using System.Globalization;
+using System.Runtime.CompilerServices;
 using System.Text;
 
 namespace SimpleExec;
@@ -8,7 +9,7 @@ internal static class ProcessExtensions
 {
     public static void Run(this Process process, bool noEcho, string echoPrefix, bool cancellationIgnoresProcessTree, CancellationToken cancellationToken)
     {
-        var cancelled = 0L;
+        var cancelled = new StrongBox<long>(0);
 
         if (!noEcho)
         {
@@ -22,14 +23,14 @@ public static void Run(this Process process, bool noEcho, string echoPrefix, boo
             {
                 if (process.TryKill(cancellationIgnoresProcessTree))
                 {
-                    _ = Interlocked.Increment(ref cancelled);
+                    _ = Interlocked.Increment(ref cancelled.Value);
                 }
             },
             useSynchronizationContext: false);
 
         process.WaitForExit();
 
-        if (Interlocked.Read(ref cancelled) == 1)
+        if (Interlocked.Read(ref cancelled.Value) == 1)
         {
             cancellationToken.ThrowIfCancellationRequested();
         }
@@ -102,7 +103,7 @@ private static bool TryKill(this Process process, bool ignoreProcessTree)
         }
 #pragma warning disable CA1031 // Do not catch general exception types
         catch (Exception)
-#pragma warning restore CA1031 // Do not catch general exception types
+#pragma warning restore CA1031
         {
             return false;
         }
diff --git a/SimpleExecTests/Infra/Capture.cs b/SimpleExecTests/Infra/Capture.cs
@@ -2,7 +2,7 @@ namespace SimpleExecTests.Infra;
 
 internal static class Capture
 {
-    private static readonly Lazy<TextWriter> @out = new(() => new StringWriter());
+    private static readonly Lazy<TextWriter> LazyOut = new(() => new StringWriter());
 
-    public static TextWriter Out => @out.Value;
+    public static TextWriter Out => LazyOut.Value;
 }
diff --git a/SimpleExecTests/RunningCommands.cs b/SimpleExecTests/RunningCommands.cs
@@ -9,7 +9,7 @@ namespace SimpleExecTests;
 
 public static class RunningCommands
 {
-    private static readonly string command = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? "hello-world.cmd" : "ls";
+    private static readonly string Command = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? "hello-world.cmd" : "ls";
     private static CancellationToken Ct => TestContext.Current.CancellationToken;
 
     public static bool OsPlatformIsWindows => RuntimeInformation.IsOSPlatform(OSPlatform.Windows);
@@ -18,7 +18,7 @@ public static class RunningCommands
     public static void RunningASucceedingCommand()
     {
         // act
-        var exception = Record.Exception(() => Command.Run(command, cancellationToken: Ct));
+        var exception = Record.Exception(() => SimpleExec.Command.Run(Command, cancellationToken: Ct));
 
         // assert
         Assert.Null(exception);
@@ -28,7 +28,7 @@ public static void RunningASucceedingCommand()
     public static void RunningASucceedingCommandWithArgs()
     {
         // act
-        var exception = Record.Exception(() => Command.Run("dotnet", $"exec {Tester.Path} hello world", cancellationToken: Ct));
+        var exception = Record.Exception(() => SimpleExec.Command.Run("dotnet", $"exec {Tester.Path} hello world", cancellationToken: Ct));
 
         // assert
         Assert.Null(exception);
@@ -38,7 +38,7 @@ public static void RunningASucceedingCommandWithArgs()
     public static async Task RunningASucceedingCommandAsync()
     {
         // act
-        var exception = await Record.ExceptionAsync(() => Command.RunAsync(command, cancellationToken: Ct));
+        var exception = await Record.ExceptionAsync(() => SimpleExec.Command.RunAsync(Command, cancellationToken: Ct));
 
         // assert
         Assert.Null(exception);
@@ -48,7 +48,7 @@ public static async Task RunningASucceedingCommandAsync()
     public static void RunningAFailingCommand()
     {
         // act
-        var exception = Record.Exception(() => Command.Run("dotnet", $"exec {Tester.Path} 1 hello world", cancellationToken: Ct));
+        var exception = Record.Exception(() => SimpleExec.Command.Run("dotnet", $"exec {Tester.Path} 1 hello world", cancellationToken: Ct));
 
         // assert
         Assert.Equal(1, Assert.IsType<ExitCodeException>(exception).ExitCode);
@@ -58,7 +58,7 @@ public static void RunningAFailingCommand()
     public static async Task RunningAFailingCommandAsync()
     {
         // act
-        var exception = await Record.ExceptionAsync(() => Command.RunAsync("dotnet", $"exec {Tester.Path} 1 hello world", cancellationToken: Ct));
+        var exception = await Record.ExceptionAsync(() => SimpleExec.Command.RunAsync("dotnet", $"exec {Tester.Path} 1 hello world", cancellationToken: Ct));
 
         // assert
         Assert.Equal(1, Assert.IsType<ExitCodeException>(exception).ExitCode);
@@ -68,7 +68,7 @@ public static async Task RunningAFailingCommandAsync()
     public static void RunningACommandInANonExistentWorkDirectory()
     {
         // act
-        var exception = Record.Exception(() => Command.Run("dotnet", $"exec {Tester.Path}", "non-existent-working-directory", cancellationToken: Ct));
+        var exception = Record.Exception(() => SimpleExec.Command.Run("dotnet", $"exec {Tester.Path}", "non-existent-working-directory", cancellationToken: Ct));
 
         // assert
         _ = Assert.IsType<Win32Exception>(exception);
@@ -78,7 +78,7 @@ public static void RunningACommandInANonExistentWorkDirectory()
     public static async Task RunningACommandAsyncInANonExistentWorkDirectory()
     {
         // act
-        var exception = await Record.ExceptionAsync(() => Command.RunAsync("dotnet", $"exec {Tester.Path}", "non-existent-working-directory", cancellationToken: Ct));
+        var exception = await Record.ExceptionAsync(() => SimpleExec.Command.RunAsync("dotnet", $"exec {Tester.Path}", "non-existent-working-directory", cancellationToken: Ct));
 
         // assert
         _ = Assert.IsType<Win32Exception>(exception);
@@ -88,7 +88,7 @@ public static async Task RunningACommandAsyncInANonExistentWorkDirectory()
     public static void RunningANonExistentCommand()
     {
         // act
-        var exception = Record.Exception(() => Command.Run("simple-exec-tests-non-existent-command", cancellationToken: Ct));
+        var exception = Record.Exception(() => SimpleExec.Command.Run("simple-exec-tests-non-existent-command", cancellationToken: Ct));
 
         // assert
         _ = Assert.IsType<Win32Exception>(exception);
@@ -98,7 +98,7 @@ public static void RunningANonExistentCommand()
     public static async Task RunningANonExistentCommandAsync()
     {
         // act
-        var exception = await Record.ExceptionAsync(() => Command.RunAsync("simple-exec-tests-non-existent-command", cancellationToken: Ct));
+        var exception = await Record.ExceptionAsync(() => SimpleExec.Command.RunAsync("simple-exec-tests-non-existent-command", cancellationToken: Ct));
 
         // assert
         _ = Assert.IsType<Win32Exception>(exception);
@@ -110,7 +110,7 @@ public static async Task RunningANonExistentCommandAsync()
     public static void RunningNoCommand(string name)
     {
         // act
-        var exception = Record.Exception(() => Command.Run(name, cancellationToken: Ct));
+        var exception = Record.Exception(() => SimpleExec.Command.Run(name, cancellationToken: Ct));
 
         // assert
         Assert.Equal(nameof(name), Assert.IsType<ArgumentException>(exception).ParamName);
@@ -122,7 +122,7 @@ public static void RunningNoCommand(string name)
     public static async Task RunningNoCommandAsync(string name)
     {
         // act
-        var exception = await Record.ExceptionAsync(() => Command.RunAsync(name, cancellationToken: Ct));
+        var exception = await Record.ExceptionAsync(() => SimpleExec.Command.RunAsync(name, cancellationToken: Ct));
 
         // assert
         Assert.Equal(nameof(name), Assert.IsType<ArgumentException>(exception).ParamName);
@@ -155,7 +155,7 @@ public static async Task RunningCommandsInPathOnWindows()
             EnvironmentVariableTarget.Process);
 
         // act
-        var exception = Record.Exception(() => Command.Run(name, cancellationToken: Ct));
+        var exception = Record.Exception(() => SimpleExec.Command.Run(name, cancellationToken: Ct));
 
         // assert
         Assert.Null(exception);
@@ -199,7 +199,7 @@ public static async Task RunningCommandsInPathOnWindowsWithSpecificPathExt(
             EnvironmentVariableTarget.Process);
 
         // act
-        var actual = (await Command.ReadAsync(name, cancellationToken: Ct)).StandardOutput.Trim();
+        var actual = (await SimpleExec.Command.ReadAsync(name, cancellationToken: Ct)).StandardOutput.Trim();
 
         // assert
         Assert.Equal(expected, actual);

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System.Diagnostics;`
`2`	`2`	`using System.Globalization;`
	`3`	`+using System.Runtime.CompilerServices;`
`3`	`4`	`using System.Text;`
`4`	`5`
`5`	`6`	`namespace SimpleExec;`
`@@ -8,7 +9,7 @@ internal static class ProcessExtensions`
`8`	`9`	`{`
`9`	`10`	`public static void Run(this Process process, bool noEcho, string echoPrefix, bool cancellationIgnoresProcessTree, CancellationToken cancellationToken)`
`10`	`11`	`{`
`11`		`- var cancelled = 0L;`
	`12`	`+ var cancelled = new StrongBox<long>(0);`
`12`	`13`
`13`	`14`	`if (!noEcho)`
`14`	`15`	`{`
`@@ -22,14 +23,14 @@ public static void Run(this Process process, bool noEcho, string echoPrefix, boo`
`22`	`23`	`{`
`23`	`24`	`if (process.TryKill(cancellationIgnoresProcessTree))`
`24`	`25`	`{`
`25`		`- _ = Interlocked.Increment(ref cancelled);`
	`26`	`+ _ = Interlocked.Increment(ref cancelled.Value);`
`26`	`27`	`}`
`27`	`28`	`},`
`28`	`29`	`useSynchronizationContext: false);`
`29`	`30`
`30`	`31`	`process.WaitForExit();`
`31`	`32`
`32`		`- if (Interlocked.Read(ref cancelled) == 1)`
	`33`	`+ if (Interlocked.Read(ref cancelled.Value) == 1)`
`33`	`34`	`{`
`34`	`35`	`cancellationToken.ThrowIfCancellationRequested();`
`35`	`36`	`}`
`@@ -102,7 +103,7 @@ private static bool TryKill(this Process process, bool ignoreProcessTree)`
`102`	`103`	`}`
`103`	`104`	`#pragma warning disable CA1031 // Do not catch general exception types`
`104`	`105`	`catch (Exception)`
`105`		`-#pragma warning restore CA1031 // Do not catch general exception types`
	`106`	`+#pragma warning restore CA1031`
`106`	`107`	`{`
`107`	`108`	`return false;`
`108`	`109`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ namespace SimpleExecTests.Infra;`
`2`	`2`
`3`	`3`	`internal static class Capture`
`4`	`4`	`{`
`5`		`- private static readonly Lazy<TextWriter> @out = new(() => new StringWriter());`
	`5`	`+ private static readonly Lazy<TextWriter> LazyOut = new(() => new StringWriter());`
`6`	`6`
`7`		`- public static TextWriter Out => @out.Value;`
	`7`	`+ public static TextWriter Out => LazyOut.Value;`
`8`	`8`	`}`