Added .NET Format to list of actions

Author: ProgrammerAL

.editorconfig

@@ -11,6 +11,11 @@ indent_size = 4
 indent_style = space
 tab_width = 4
 
+# Organize usings
+dotnet_separate_import_directive_groups = true
+dotnet_sort_system_directives_first = true
+file_header_template = unset
+
 # New line preferences
 end_of_line = crlf
 insert_final_newline = true

README.md

@@ -29,10 +29,10 @@ There are 2 ways to run this. As a .NET Tool installed on your machine, or downl
 
 ## CLI Options
 
-- --config-file, -d
+- `-d|--config-file`
 	- Required
 	- Path to the file to use for config values when updating code
-- --help, -h
+- `-h|--help`
   - Outputs CLI help
 
 ## Config File

src/CodeUpdater/CodeUpdater/Helpers/RunProcessHelper.cs

@@ -5,10 +5,9 @@
 using System.Text;
 using System.Threading.Tasks;
 
-using Serilog;
-
 using ProgrammerAl.SourceGenerators.PublicInterfaceGenerator.Attributes;
-using static ProgrammerAL.Tools.CodeUpdater.Helpers.RunProcessHelper;
+
+using Serilog;
 
 namespace ProgrammerAL.Tools.CodeUpdater.Helpers;
 

src/CodeUpdater/CodeUpdater/Options/UpdateOptions.cs

@@ -56,6 +56,12 @@ public class UpdateOptions
     [Required]
     public required bool EnforceCodeStyleInBuild { get; set; }
 
+    /// <summary>
+    /// True to run the `dotnet format` command
+    /// </summary>
+    [Required]
+    public required bool RunDotnetFormat { get; set; }
+
     /// <summary>
     /// If this is set, it will be the file to write logs to, in addition to the console
     /// </summary>

src/CodeUpdater/CodeUpdater/Program.cs

@@ -29,7 +29,7 @@ static async ValueTask RunAsync(CommandOptions commandOptions)
     var workLocator = new WorkLocator(logger);
     var validator = new PreRunValidator(logger, runProcessHelper);
     var cSharpUpdater = new CSharpUpdater(logger, runProcessHelper, updateOptions);
-    var npmUpdater = new NpmUpdater(runProcessHelper);
+    var npmUpdater = new NpmUpdater(logger, runProcessHelper);
     var compileRunner = new CompileRunner(logger, runProcessHelper);
 
     var skipPaths = workLocator.DetermineSkipPaths(updateOptions.IgnorePatterns);

src/CodeUpdater/CodeUpdater/Results.cs

@@ -7,12 +7,18 @@
 
 namespace ProgrammerAL.Tools.CodeUpdater;
 
-public record CSharpUpdateResult(string CsprojFile, NugetUpdateResults NugetUpdates, CsprojValueUpdateResultType LangVersionUpdate, CsprojValueUpdateResultType TargetFrameworkUpdate);
+public record CSharpUpdateResult(
+    string CsprojFile, 
+    NugetUpdateResults NugetUpdates, 
+    CsprojValueUpdateResultType LangVersionUpdate, 
+    CsprojValueUpdateResultType TargetFrameworkUpdate,
+    DotnetFormatResult DotnetFormatUpdate);
 
 public record NugetUpdateResults(bool RetrievedPackageListSuccessfully, ImmutableArray<NugetUpdateResult> Updates);
 public record NugetUpdateResult(string CsProjFile, string PackageId, bool UpdatedSuccessfully);
 
 public record CsProjUpdateResult(string CsProjFile, CsprojValueUpdateResultType LangVersionUpdate, CsprojValueUpdateResultType TargetFrameworkUpdate);
+public record DotnetFormatResult(string CsProjFile, DotnetFormatResultType Result);
 
 public record NpmUpdates(ImmutableArray<string> NpmDirectories);
 
@@ -30,7 +36,7 @@ public enum CompileResultType
     ProcessDidNotStart,
     BuildTimeout,
     BuildErrors
-} 
+}
 
 public enum CsprojValueUpdateResultType
 {
@@ -41,3 +47,11 @@ public enum CsprojValueUpdateResultType
     Updated,
     AddedElement
 }
+
+public enum DotnetFormatResultType
+{
+    Unknown,
+    DidNotRun,
+    RanSuccessfully,
+    Erroreded
+}

src/CodeUpdater/CodeUpdater/Updaters/CSharpUpdater.cs

@@ -14,6 +14,7 @@ public class CSharpUpdater
 {
     private readonly NugetUpdater _nugetUpdater;
     private readonly CsProjUpdater _csProjUpdater;
+    private readonly CsCodeUpdater _csCodeUpdater;
 
     private readonly ILogger _logger;
     private readonly IRunProcessHelper _runProcessHelper;
@@ -29,6 +30,7 @@ public CSharpUpdater(
         _updateOptions = updateOptions;
         _nugetUpdater = new NugetUpdater(_logger, _runProcessHelper);
         _csProjUpdater = new CsProjUpdater(_logger, updateOptions);
+        _csCodeUpdater = new CsCodeUpdater(_logger, _runProcessHelper, updateOptions);
     }
 
     public async ValueTask<ImmutableArray<CSharpUpdateResult>> UpdateAllCSharpProjectsAsync(UpdateWork updateWork)
@@ -38,15 +40,16 @@ public async ValueTask<ImmutableArray<CSharpUpdateResult>> UpdateAllCSharpProjec
         {
             _logger.Information($"Updating '{csProjFilePath}'");
 
-
             var nugetUpdates = await UpdateNugetPackagesAsync(csProjFilePath);
             var csProjUpdates = UpdateCsProjPropertyValues(csProjFilePath);
+            var dotnetFormatUpdate = await RunDotnetFormatAsync(csProjFilePath);
 
             builder.Add(new CSharpUpdateResult(
                 csProjFilePath,
                 NugetUpdates: nugetUpdates,
                 LangVersionUpdate: csProjUpdates.LangVersionUpdate,
-                TargetFrameworkUpdate: csProjUpdates.TargetFrameworkUpdate));
+                TargetFrameworkUpdate: csProjUpdates.TargetFrameworkUpdate,
+                DotnetFormatUpdate: dotnetFormatUpdate));
         }
 
         return builder.ToImmutableArray();
@@ -77,4 +80,17 @@ private CsProjUpdateResult UpdateCsProjPropertyValues(string csProjFilePath)
             return new CsProjUpdateResult(csProjFilePath, CsprojValueUpdateResultType.Unknown, CsprojValueUpdateResultType.Unknown);
         }
     }
+
+    private async Task<DotnetFormatResult> RunDotnetFormatAsync(string csProjFilePath)
+    {
+        try
+        {
+            return await _csCodeUpdater.RunDotnetFormatAsync(csProjFilePath);
+        }
+        catch (Exception ex)
+        {
+            _logger.Error("Error running dotnet format on csproj file '{CsProjFilePath}'. {Ex}", csProjFilePath, ex.ToString());
+            return new DotnetFormatResult(csProjFilePath, DotnetFormatResultType.Erroreded);
+        }
+    }
 }

src/CodeUpdater/CodeUpdater/Updaters/CsCodeUpdater.cs

@@ -0,0 +1,40 @@
+using System;
+using System.Collections.Generic;
+using System.Collections.Immutable;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using System.Xml.Linq;
+
+using ProgrammerAL.Tools.CodeUpdater.Helpers;
+
+using Serilog;
+
+namespace ProgrammerAL.Tools.CodeUpdater.Updaters;
+
+public class CsCodeUpdater(ILogger Logger, IRunProcessHelper RunProcessHelper, UpdateOptions UpdateOptions)
+{
+    public async ValueTask<DotnetFormatResult> RunDotnetFormatAsync(string csProjFilePath)
+    {
+        if (!UpdateOptions.RunDotnetFormat)
+        {
+            return new DotnetFormatResult(csProjFilePath, DotnetFormatResultType.DidNotRun);
+        }
+
+        string commandArgs = $"format \"{csProjFilePath}\"";
+        try
+        {
+            var processResult = await RunProcessHelper.RunProcessToCompletionAndGetOutputAsync("dotnet", commandArgs);
+            if (processResult.CompletedSuccessfully)
+            {
+                return new DotnetFormatResult(csProjFilePath, DotnetFormatResultType.RanSuccessfully);
+            }
+        }
+        catch (Exception ex)
+        {
+            Logger.Error(ex, "Error running dotnet format with command args '{CommandArgs}'", commandArgs);
+        }
+
+        return new DotnetFormatResult(csProjFilePath, DotnetFormatResultType.Erroreded);
+    }
+}

src/CodeUpdater/CodeUpdater/Updaters/CsProjUpdater.cs

@@ -197,7 +197,7 @@ private void UpdateTargetFrameworksValue(XElement childElm, CsprojUpdateTracker
         }
     }
 
-    public class CsprojUpdateTracker
+    private class CsprojUpdateTracker
     {
         public const string TargetFramework = "TargetFramework";
         public const string TargetFrameworks = "TargetFrameworks";

src/CodeUpdater/CodeUpdater/Updaters/NpmUpdater.cs

@@ -13,7 +13,7 @@
 using Serilog;
 
 namespace ProgrammerAL.Tools.CodeUpdater.Updaters;
-public class NpmUpdater(IRunProcessHelper RunProcessHelper)
+public class NpmUpdater(ILogger Logger, IRunProcessHelper RunProcessHelper)
 {
     public NpmUpdates UpdateNpmPackages(UpdateWork updateWork)
     {
@@ -33,7 +33,7 @@ public NpmUpdates UpdateNpmPackages(UpdateWork updateWork)
             }
             catch (Exception ex)
             {
-                Log.Error(ex, "Error updating npm packages at path'{ProjectPath}'. Command was '{Command}'", projectPath, command);
+                Logger.Error(ex, "Error updating npm packages at path'{ProjectPath}'. Command was '{Command}'", projectPath, command);
             }
         }