Some work on documentation for the project. Still need to update ReadMe with objects for new config

Author: ProgrammerAL

README.md

@@ -1,30 +1,35 @@
 # Code Updater
 
-The purpose of this project is to update all code versioning and dependencies below a directory. This is useful when you have a large number of projects that you want to update all at once. This application is assumed to run on a local machine, and then the changes are manually committed to source control. This allows for a more controlled update process, because a developer is meant to manually check the changes before committing them.
+The purpose of this project is to update specific aspects of code below a directory. This is useful when you have a large number of projects that you want to update all at once. This application is assumed to run on a local machine, and then the changes are manually committed to source control. This allows for a more controlled update process, because a developer is meant to manually check the changes before committing them.
 
-It would be great to get this to work for all kinds of languages/frameworks someday, but for now it's just .NET and NPM.
+It would be great to get this to work for all kinds of languages/frameworks someday, but for now it's just .NET and a little bit for NPM.
 
-## What Updates Are Done
+## What Updates Cane Be Done
 
-- Updates .NET *.csproj files to use a specified C# Language Version
-- Updates .NET *.csproj files to use a specified .NET SDK Version (AKA TargetFramework element)
-- Updates all NuGet packages in all *.csproj files to the latest version
-- Updates all NPM packages in all package.json files to the latest version
+- Update .NET *.csproj files to use a specified C# Language Version
+- Update .NET *.csproj files to use a specified .NET SDK Version (AKA TargetFramework element)
+- Enable/Disable .NET Analyzers in all *.csproj files
+- Run `dotnet format` command on all *.csproj files
+- Update all NuGet packages in all *.csproj files to the latest version
+- Add Nuget auditing properties to all *.csproj files 
+- Update all NPM packages in all package.json files to the latest version
 
 ## How to Use It
 
-Remember, the purpose of this is to update code. It is assumed, and recommended, a developer runs this locally and verifies the changes before comitting to source control. Below are the steps assumed steps a user would follow.
+Remember, the purpose of this is to update code. It is assumed, and recommended, a developer runs this locally and verifies the changes before comitting to source control. Below are the assumed steps a user would follow.
 
 There are 2 ways to run this. As a .NET Tool installed on your machine, or downloading the repository and running the code yourself.
 
 1. Install the application. Choose one:
-  - Install the tool globally by running `dotnet tool install --global ProgrammerAL.Tools.CodeUpdater --version 1.0.0`
+  - Install the tool globally by running `dotnet tool install --global ProgrammerAL.Tools.CodeUpdater --version <<version number>>`
   - Or clone this repository locally
 2. Run the application
   - If you installed the tool, run it with the command: `code-updater --config "C:/my-repos/my-app-1"`
   - If you downloaded the code, open a terminal to the `~/src/CodeUpdater/CodeUpdater` directory and run the application using dotnet run while passing in the required arguments. Example: `dotnet run -- --config "C:/my-repos/my-app-1"`
 3. Wait for the application to finish. It will output the number of projects updated, and the number of projects that failed to update.
 4. Manually check a diff of all the file changes to ensure everything is as you expect
+  - Make any manual changes you feel you need to
+  - If there were any build failures that were caused by the updates, fix those
 5. Commit the code changes to source control. Wait for a CI/CD pipeline to run and ensure everything is still working as expected.
 
 ## CLI Options
@@ -108,7 +113,7 @@ Below are the list of properties in the config file.
 
 The Code Updater application has a default set of paths to ignore. The list is below. Note that all paths are in the list using both forwardslashes and backslashes. These are in addition to any skip paths passed in with the `IgnorePatterns` config file property. As of right now, there is no way to remove these.
 
-Ignore all obj and bin folders:
+Ignore all C# `obj` and `bin` folders:
 - /obj/Debug/
 - /obj/Release/
 - /bin/Debug/
@@ -142,3 +147,14 @@ PowerShell is required as a workaround. The NPM executable on Windows doesn't ru
 When updating *.csproj files to a specific `TargetFramework` version, the project is skipped if using .NET Standard. Those are usually set for a specific level of API compatibility so we don't want to mess with those.
 
 
+## Update Script Sample
+
+You can create a script to make it easy to run Code Updater on a regular basis. A sample PowerShell script to do that is in the `/code-update-runner-sample` directory of this repo. It has the below files:
+
+- `code-updater-config.json`
+  - Example config file to use when running Code Updater
+- `run-code-updater.ps1`
+  - PowerShell script that runs Code Updater one directory up in the tree, using the given `code-updater-config.json` file as config
+ 
+Feel free to use those files as a base, and modify them for your repositories as needed. For extra points, commit them to your repository too.
+

code-update-runner-sample/code-updater-config.json

@@ -0,0 +1,34 @@
+{
+  "RootDirectory": "./",
+  "IgnorePatterns": [],
+  "CSharpOptions": {
+    "CsProjVersioningOptions": {
+      "TreatWarningsAsErrors": true,
+      "TargetFramework": "net8.0",
+      "LangVersion": "latest"
+    },
+    "CsProjDotNetAnalyzerOptions": {
+      "EnableNetAnalyzers": true,
+      "EnforceCodeStyleInBuild": true
+    },
+    "CSharpStyleOptions": {
+      "RunDotnetFormat": true
+    },
+    "NugetAuditOptions": {
+      "NuGetAudit": true,
+      "AuditMode": "all",
+      "AuditLevel": "low"
+    },
+    "NuGetUpdateOptions": {
+      "UpdateTopLevelNugetsInCsProj": true,
+      "UpdateTopLevelNugetsNotInCsProj": true
+    }
+  },
+  "NpmOptions": {
+    "NpmBuildCommand": "publish"
+  },
+  "LoggingOptions": {
+    "LogLevel": "Verbose",
+    "OutputFile": "./code-updater-output.txt"
+  }
+}

code-update-runner-sample/run-code-updater.ps1

@@ -0,0 +1,14 @@
+
+$configPath = "$PSScriptRoot/code-updater-config.json"
+$runLocation = "$PSScriptRoot/../"
+
+$startPath = Get-Location
+
+# Change path so the updater runs 1 directory higher, not inside this directory
+Set-Location $runLocation
+& "code-updater" --config "$configPath"
+
+# Go back to the original path
+Set-Location $startPath
+
+Read-Host "Press enter to exit..."

src/CodeUpdater/CodeUpdater/Options/UpdateOptions.cs

@@ -67,12 +67,12 @@ public class CSharpOptions
     /// Settings to use for configuring Nuget Audit settings in csproj files.
     /// You can read more at https://learn.microsoft.com/en-us/nuget/concepts/auditing-packages#configuring-nuget-audit
     /// </summary>
-    public NugetAuditOptions? NugetAudit { get; set; }
+    public NugetAuditOptions? NugetAuditOptions { get; set; }
 
     /// <summary>
     /// Settings to use for updating NuGet packages in csproj files
     /// </summary>
-    public NuGetUpdateOptions? NuGetUpdates { get; set; }
+    public NuGetUpdateOptions? NuGetUpdateOptions { get; set; }
 }
 
 public class CsProjVersioningOptions

src/CodeUpdater/CodeUpdater/Updaters/CSharpUpdater.cs

@@ -61,13 +61,13 @@ private async ValueTask<NugetUpdateResults> UpdateNugetPackagesAsync(string csPr
     {
         try
         {
-            if (cSharpOptions.NuGetUpdates is null)
+            if (cSharpOptions.NuGetUpdateOptions is null)
             {
                 _logger.Information("No NuGet options provided, skipping NuGet updates");
                 return new NugetUpdateResults(RetrievedPackageListSuccessfully: true, ImmutableArray<NugetUpdateResult>.Empty);
             }
 
-            return await _nugetUpdater.UpdateNugetPackagesAsync(csProjFilePath, cSharpOptions.NuGetUpdates);
+            return await _nugetUpdater.UpdateNugetPackagesAsync(csProjFilePath, cSharpOptions.NuGetUpdateOptions);
         }
         catch (Exception ex)
         {

src/CodeUpdater/CodeUpdater/Updaters/CsProjUpdater.cs

@@ -61,9 +61,9 @@ private ImmutableArray<ImmutableArray<CsprojUpdateGroupTracker>> DetermineProjec
             }
         }
 
-        if (cSharpOptions.NugetAudit is object)
+        if (cSharpOptions.NugetAuditOptions is object)
         {
-            var nugetAuditUpdates = GenerateUpdateGroupForNugetAudit(cSharpOptions.NugetAudit);
+            var nugetAuditUpdates = GenerateUpdateGroupForNugetAudit(cSharpOptions.NugetAuditOptions);
 
             if (nugetAuditUpdates.Any())
             {

src/CodeUpdater/CodeUpdater/sampleUpdateOptions.json

@@ -14,12 +14,12 @@
     "CSharpStyleOptions": {
       "RunDotnetFormat": true
     },
-    "NugetAudit": {
+    "NugetAuditOptions": {
       "NuGetAudit": true,
       "AuditMode": "all",
       "AuditLevel": "low"
     },
-    "NuGetUpdates": {
+    "NuGetUpdateOptions": {
       "UpdateTopLevelNugetsInCsProj": true,
       "UpdateTopLevelNugetsNotInCsProj": true
     }