Fix: Quick code cleanup

AnnaSasDev · AnnaSasDev · commit 30eca5fa4248 · 2024-12-18T19:59:52.000+01:00
diff --git a/src/CodeOfChaos.CliArgsParser.Generators.Sample/Example.cs b/src/CodeOfChaos.CliArgsParser.Generators.Sample/Example.cs
@@ -43,7 +43,7 @@ public async Task ExecuteAsync(CommandParameters parameters) {
         }
 
         // Simulate some asynchronous work
-        await Task.Delay(100);// Example of an asynchronous operation
+        await Task.Delay(100); // Example of an asynchronous operation
 
         Console.WriteLine("Command executed successfully.");
     }
diff --git a/src/CodeOfChaos.CliArgsParser.Generators/CodeOfChaos.CliArgsParser.Generators.csproj b/src/CodeOfChaos.CliArgsParser.Generators/CodeOfChaos.CliArgsParser.Generators.csproj
@@ -24,22 +24,22 @@
         <PackageReadmeFile>README.md</PackageReadmeFile>
         <PackageIcon>icon.png</PackageIcon>
     </PropertyGroup>
-    
+
     <ItemGroup>
-        <None Include="..\..\LICENSE" Pack="true" PackagePath="" />
-        <None Include="..\..\README.md" Pack="true" PackagePath="" />
-        <None Include="../../assets/icon.png" Pack="true" PackagePath="" />
+        <None Include="..\..\LICENSE" Pack="true" PackagePath=""/>
+        <None Include="..\..\README.md" Pack="true" PackagePath=""/>
+        <None Include="../../assets/icon.png" Pack="true" PackagePath=""/>
     </ItemGroup>
-    
+
     <ItemGroup>
         <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.11.0">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
-        <PackageReference Include="Microsoft.CodeAnalysis.Common" Version="4.12.0" />
-        <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.12.0" />
+        <PackageReference Include="Microsoft.CodeAnalysis.Common" Version="4.12.0"/>
+        <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.12.0"/>
     </ItemGroup>
     <ItemGroup>
-        <None Include="$(OutputPath)\$(AssemblyName).dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />
+        <None Include="$(OutputPath)\$(AssemblyName).dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false"/>
     </ItemGroup>
 </Project>
diff --git a/src/CodeOfChaos.CliArgsParser.Generators/Content/CommandGenerator/ClassDto.cs b/src/CodeOfChaos.CliArgsParser.Generators/Content/CommandGenerator/ClassDto.cs
@@ -27,7 +27,7 @@ public class ClassDto(ISymbol symbol, ClassDeclarationSyntax syntax) {
 
     private string CommandName =>
         _commandNameAttribute?.ConstructorArguments.ElementAtOrDefault(0).Value?.ToString()
-        ?? ClassName.Replace("Command", "").ToLowerInvariant();// Maybe create a ToKebabCase method?
+        ?? ClassName.Replace("Command", "").ToLowerInvariant(); // Maybe create a ToKebabCase method?
 
     private string Description => _descriptionAttribute?.ConstructorArguments.ElementAtOrDefault(0).Value?.ToString() ?? string.Empty;
 
diff --git a/src/CodeOfChaos.CliArgsParser.Library/CodeOfChaos.CliArgsParser.Library.csproj b/src/CodeOfChaos.CliArgsParser.Library/CodeOfChaos.CliArgsParser.Library.csproj
@@ -21,20 +21,20 @@
         <PackageReadmeFile>README.md</PackageReadmeFile>
         <PackageIcon>icon.png</PackageIcon>
     </PropertyGroup>
-    
+
     <ItemGroup>
-        <None Include="..\..\LICENSE" Pack="true" PackagePath="" />
-        <None Include="..\..\README.md" Pack="true" PackagePath="" />
-        <None Include="..\..\assets/icon.png" Pack="true" PackagePath="" />
+        <None Include="..\..\LICENSE" Pack="true" PackagePath=""/>
+        <None Include="..\..\README.md" Pack="true" PackagePath=""/>
+        <None Include="..\..\assets/icon.png" Pack="true" PackagePath=""/>
     </ItemGroup>
-    
+
     <ItemGroup>
-        <ProjectReference Include="..\CodeOfChaos.CliArgsParser.Generators\CodeOfChaos.CliArgsParser.Generators.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
-        <ProjectReference Include="..\CodeOfChaos.CliArgsParser\CodeOfChaos.CliArgsParser.csproj" />
+        <ProjectReference Include="..\CodeOfChaos.CliArgsParser.Generators\CodeOfChaos.CliArgsParser.Generators.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false"/>
+        <ProjectReference Include="..\CodeOfChaos.CliArgsParser\CodeOfChaos.CliArgsParser.csproj"/>
     </ItemGroup>
-    
+
     <ItemGroup>
-        <PackageReference Include="AterraEngine.Unions" Version="2.5.0" />
-        <PackageReference Include="CodeOfChaos.Ansi" Version="0.1.7" />
+        <PackageReference Include="AterraEngine.Unions" Version="2.5.0"/>
+        <PackageReference Include="CodeOfChaos.Ansi" Version="0.1.7"/>
     </ItemGroup>
 </Project>
diff --git a/src/CodeOfChaos.CliArgsParser.Library/CommandAtlases/DownloadIcon/DownloadIconCommand.cs b/src/CodeOfChaos.CliArgsParser.Library/CommandAtlases/DownloadIcon/DownloadIconCommand.cs
@@ -16,6 +16,9 @@ namespace CodeOfChaos.CliArgsParser.Library.CommandAtlases.DownloadIcon;
 [CliArgsDescription("Downloads and assigns the icon, to be used as nuget package's icon, for the specified project.")]
 public partial class DownloadIconCommand : ICommand<DownloadIconParameters> {
 
+    [GeneratedRegex(@"^[^/\\\s]+$")]
+    private static partial Regex IsEmptyFolderNameRegex { get; }
+
     // -----------------------------------------------------------------------------------------------------------------
     // Methods
     // -----------------------------------------------------------------------------------------------------------------
@@ -25,7 +28,7 @@ public async Task ExecuteAsync(DownloadIconParameters parameters) {
         if (getResult is { IsFailure: true, AsFailure.Value: var getError }) {
             Console.WriteLine(getError);
         }
-        
+
         Console.WriteLine("Icon downloaded successfully.");
         SuccessOrFailure applyResult = await ApplyIcon(parameters);
         if (applyResult is { IsFailure: true, AsFailure.Value: var applyError }) {
@@ -41,7 +44,7 @@ private static async Task<SuccessOrFailure> ApplyIcon(DownloadIconParameters arg
         }
 
         await foreach (XDocument document in CsProjHelpers.GetProjectFiles(projectFiles)) {
-           
+
             // Loop through each project file's XML document
             foreach (XElement propertyGroup in document.Root?.Elements("PropertyGroup")!) {
                 XElement? iconElement = propertyGroup.Element("PackageIcon");
@@ -55,7 +58,7 @@ private static async Task<SuccessOrFailure> ApplyIcon(DownloadIconParameters arg
                     // Update the value to ensure it's "icon.png"
                     iconElement.Value = "icon.png";
                 }
-                
+
                 // Look for ItemGroup containing Packable items
                 XElement? packableItemGroup = document.Root?
                     .Elements("ItemGroup")
@@ -76,11 +79,11 @@ private static async Task<SuccessOrFailure> ApplyIcon(DownloadIconParameters arg
 
                 IEnumerable<string> indents = Enumerable.Repeat(
                     "../",
-                    1 
+                    1
                     + (IsEmptyFolderNameRegex.IsMatch(args.SourceFolder) ? 1 : 0)
                     + args.SourceFolder.Count(c => c is '/' or '\\')
                 );
-                string includeString = Path.Combine(string.Join(string.Empty,indents),args.IconFolder, "icon.png");
+                string includeString = Path.Combine(string.Join(string.Empty, indents), args.IconFolder, "icon.png");
 
                 // Add the icon.png reference if it doesn't exist
                 var newIconElement = new XElement("None",
@@ -90,7 +93,7 @@ private static async Task<SuccessOrFailure> ApplyIcon(DownloadIconParameters arg
                 packableItemGroup.Add(newIconElement);
             }
         }
-        
+
         return new Success();
     }
 
@@ -139,10 +142,7 @@ private static async Task<SuccessOrFailure> TryGetIcon(DownloadIconParameters pa
         }
         catch (Exception ex) {
             // Return any unexpected errors
-            return$"Unexpected error: {ex.Message}";
+            return $"Unexpected error: {ex.Message}";
         }
     }
-
-    [GeneratedRegex(@"^[^/\\\s]+$")]
-    private static partial Regex IsEmptyFolderNameRegex { get; }
 }
diff --git a/src/CodeOfChaos.CliArgsParser.Library/CommandAtlases/VersionBump/VersionBumpCommand.cs b/src/CodeOfChaos.CliArgsParser.Library/CommandAtlases/VersionBump/VersionBumpCommand.cs
@@ -73,7 +73,7 @@ private static async Task<SuccessOrFailure<SemanticVersionDto>> BumpVersion(Vers
                 .FirstOrDefault();
 
             if (versionElement == null) {
-                return new Failure<string>($"File did not contain a version element");
+                return new Failure<string>("File did not contain a version element");
             }
 
             if (versionDto is null) {
diff --git a/src/CodeOfChaos.CliArgsParser.Library/CommandAtlases/VersionBump/VersionBumpParameters.cs b/src/CodeOfChaos.CliArgsParser.Library/CommandAtlases/VersionBump/VersionBumpParameters.cs
@@ -14,6 +14,7 @@ namespace CodeOfChaos.CliArgsParser.Library.CommandAtlases.VersionBump;
 
     [CliArgsParameter("section", "s")] [CliArgsDescription("The section of the version to bump. One of: Major, Minor, Patch")]
     public required string? SectionStringValue { get; init; }
+
     public VersionSection Section => Enum.Parse<VersionSection>(SectionStringValue ?? "None", true);
 
     [CliArgsParameter("push", "p", ParameterType.Flag)] [CliArgsDescription("Push the changes to the remote repository")]
diff --git a/src/CodeOfChaos.CliArgsParser.Library/Shared/CsProjHelpers.cs b/src/CodeOfChaos.CliArgsParser.Library/Shared/CsProjHelpers.cs
@@ -5,15 +5,14 @@
 using System.Xml.Linq;
 
 namespace CodeOfChaos.CliArgsParser.Library.Shared;
-
 // ---------------------------------------------------------------------------------------------------------------------
 // Code
 // ---------------------------------------------------------------------------------------------------------------------
 public static class CsProjHelpers {
     public static string[] AsProjectPaths(string root, string sourcefolder, string[] projectNames) {
         return projectNames.Select(x => Path.Combine(root, sourcefolder, x, x + ".csproj")).ToArray();
     }
-    
+
     public static async IAsyncEnumerable<XDocument> GetProjectFiles(string[] projectPaths) {
         var settings = new XmlWriterSettings {
             Indent = true,
@@ -22,7 +21,7 @@ public static async IAsyncEnumerable<XDocument> GetProjectFiles(string[] project
             OmitXmlDeclaration = true,
             NewLineOnAttributes = false // Keeps attributes on the same line
         };
-        
+
         foreach (string path in projectPaths) {
             if (!File.Exists(path)) {
                 throw new FileNotFoundException($"Could not find project file {path}");
@@ -33,9 +32,9 @@ public static async IAsyncEnumerable<XDocument> GetProjectFiles(string[] project
             await using (var stream = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read, 4096, true)) {
                 document = await XDocument.LoadAsync(stream, LoadOptions.PreserveWhitespace, CancellationToken.None);
             }
-            
+
             yield return document;
-            
+
             // Save using XmlWriter to apply consistent indentation, but preserve empty lines
             await using (var stream = new FileStream(path, FileMode.Create, FileAccess.Write, FileShare.None, 4096, true)) {
                 await using var writer = XmlWriter.Create(stream, settings);
diff --git a/src/CodeOfChaos.CliArgsParser.Library/Shared/GitHelpers.cs b/src/CodeOfChaos.CliArgsParser.Library/Shared/GitHelpers.cs
@@ -6,7 +6,6 @@
 using System.Diagnostics;
 
 namespace CodeOfChaos.CliArgsParser.Library.Shared;
-
 // ---------------------------------------------------------------------------------------------------------------------
 // Code
 // ---------------------------------------------------------------------------------------------------------------------
diff --git a/src/CodeOfChaos.CliArgsParser/Attributes/CliArgsCommandAttribute.cs b/src/CodeOfChaos.CliArgsParser/Attributes/CliArgsCommandAttribute.cs
@@ -6,6 +6,6 @@ namespace CodeOfChaos.CliArgsParser.Attributes;
 // Code
 // ---------------------------------------------------------------------------------------------------------------------
 [AttributeUsage(AttributeTargets.Class)]
-#pragma warning disable CS9113// Parameter is unread.
+#pragma warning disable CS9113 // Parameter is unread.
 public class CliArgsCommandAttribute(string name) : Attribute;
-#pragma warning restore CS9113// Parameter is unread.
+#pragma warning restore CS9113 // Parameter is unread.
diff --git a/src/CodeOfChaos.CliArgsParser/Attributes/CliArgsDescriptionAttribute.cs b/src/CodeOfChaos.CliArgsParser/Attributes/CliArgsDescriptionAttribute.cs
@@ -6,6 +6,6 @@ namespace CodeOfChaos.CliArgsParser.Attributes;
 // Code
 // ---------------------------------------------------------------------------------------------------------------------
 [AttributeUsage(AttributeTargets.Property | AttributeTargets.Class)]
-#pragma warning disable CS9113// Parameter is unread.
+#pragma warning disable CS9113 // Parameter is unread.
 public class CliArgsDescriptionAttribute(string description) : Attribute;
-#pragma warning restore CS9113// Parameter is unread.
+#pragma warning restore CS9113 // Parameter is unread.
diff --git a/src/CodeOfChaos.CliArgsParser/Attributes/CliArgsParameterAttribute.cs b/src/CodeOfChaos.CliArgsParser/Attributes/CliArgsParameterAttribute.cs
@@ -6,9 +6,9 @@ namespace CodeOfChaos.CliArgsParser.Attributes;
 // Code
 // ---------------------------------------------------------------------------------------------------------------------
 [AttributeUsage(AttributeTargets.Property)]
-#pragma warning disable CS9113// Parameter is unread.
+#pragma warning disable CS9113 // Parameter is unread.
 public class CliArgsParameterAttribute(string name, string shortName, ParameterType type = ParameterType.Value) : Attribute {
-#pragma warning restore CS9113// Parameter is unread.
+#pragma warning restore CS9113 // Parameter is unread.
 }
 
 public enum ParameterType : uint {
diff --git a/src/CodeOfChaos.CliArgsParser/CliArgsBuilderConfig.cs b/src/CodeOfChaos.CliArgsParser/CliArgsBuilderConfig.cs
@@ -39,11 +39,11 @@ public void AddCommandsFromAssembly(Assembly assembly) {
         // Get all types in the provided assembly
         IEnumerable<Type> commandTypes = assembly.GetTypes()
             .Where(type =>
-                type.IsClass// Must be a class
-                && !type.IsAbstract// Must not be abstract
-                && type.IsDefined(typeof(CliArgsCommandAttribute), false)// Must have CliArgsCommandAttribute
+                type.IsClass // Must be a class
+                && !type.IsAbstract // Must not be abstract
+                && type.IsDefined(typeof(CliArgsCommandAttribute), false) // Must have CliArgsCommandAttribute
                 && type.GetInterfaces().Any(i =>
-                        i.IsGenericType && i.GetGenericTypeDefinition() == typeof(ICommand<>)// Must implement ICommand<T>
+                        i.IsGenericType && i.GetGenericTypeDefinition() == typeof(ICommand<>) // Must implement ICommand<T>
                 )
             );
 
diff --git a/src/CodeOfChaos.CliArgsParser/CliArgsParser.cs b/src/CodeOfChaos.CliArgsParser/CliArgsParser.cs
@@ -24,6 +24,7 @@ public partial class CliArgsParser {
     // Methods
     // -----------------------------------------------------------------------------------------------------------------
     public Task ParseAsync(string[] args) => ParseAsync(InputHelper.ToOneLine(args));
+
     public async Task ParseAsync(string args) {
         if (string.IsNullOrWhiteSpace(args)) {
             throw new ArgumentException("Arguments cannot be null or empty.", nameof(args));
@@ -52,6 +53,7 @@ public async Task ParseAsync(string args) {
     }
 
     public Task ParseStartupArgs(string[] args) => ParseStartupArgs(string.Join(" ", args));
+
     public async Task ParseStartupArgs(string args) {
         if (StartupCommand is not { CommandObject: var commandObject }) throw new Exception("No startup command set.");
 
diff --git a/src/CodeOfChaos.CliArgsParser/CodeOfChaos.CliArgsParser.csproj b/src/CodeOfChaos.CliArgsParser/CodeOfChaos.CliArgsParser.csproj
@@ -20,11 +20,11 @@
         <PackageReadmeFile>README.md</PackageReadmeFile>
         <PackageIcon>icon.png</PackageIcon>
     </PropertyGroup>
-    
+
     <ItemGroup>
-        <None Include="..\..\LICENSE" Pack="true" PackagePath="" />
-        <None Include="..\..\README.md" Pack="true" PackagePath="" />
-        <None Include="../../assets/icon.png" Pack="true" PackagePath="" />
+        <None Include="..\..\LICENSE" Pack="true" PackagePath=""/>
+        <None Include="..\..\README.md" Pack="true" PackagePath=""/>
+        <None Include="../../assets/icon.png" Pack="true" PackagePath=""/>
     </ItemGroup>
-    
+
 </Project>
diff --git a/src/CodeOfChaos.CliArgsParser/UserInputRegistry.cs b/src/CodeOfChaos.CliArgsParser/UserInputRegistry.cs
@@ -93,7 +93,7 @@ public T GetParameterByPossibleNames<T>(string name, string shortName) {
             return (T)Convert.ChangeType(parameter, targetType);
         }
         catch {
-            return default;// Return default if conversion fails
+            return default; // Return default if conversion fails
         }
     }
 
diff --git a/src/Tools.CodeOfChaos.CliArgsParser/Properties/launchSettings.json b/src/Tools.CodeOfChaos.CliArgsParser/Properties/launchSettings.json
@@ -16,7 +16,6 @@
       "commandName": "Project",
       "commandLineArgs": "git-version-bump --section=\"preview\" --projects=\"CodeOfChaos.CliArgsParser;CodeOfChaos.CliArgsParser.Library;CodeOfChaos.CliArgsParser.Generators;\" --push"
     },
-    
     "Download Icon": {
       "commandName": "Project",
       "commandLineArgs": "nuget-download-icon --origin=\"https://avatars.githubusercontent.com/u/102103683?s=400&u=b0dc0cb37882f73ef59b0ed9fd11ee9de5213d0f&v=4\" --projects=\"CodeOfChaos.CliArgsParser;CodeOfChaos.CliArgsParser.Library;CodeOfChaos.CliArgsParser.Generators;\""

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public async Task ExecuteAsync(CommandParameters parameters) {`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`// Simulate some asynchronous work`
`46`		`- await Task.Delay(100);// Example of an asynchronous operation`
	`46`	`+ await Task.Delay(100); // Example of an asynchronous operation`
`47`	`47`
`48`	`48`	`Console.WriteLine("Command executed successfully.");`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ private static async Task<SuccessOrFailure<SemanticVersionDto>> BumpVersion(Vers`
`73`	`73`	`.FirstOrDefault();`
`74`	`74`
`75`	`75`	`if (versionElement == null) {`
`76`		`- return new Failure<string>($"File did not contain a version element");`
	`76`	`+ return new Failure<string>("File did not contain a version element");`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`if (versionDto is null) {`