Feat: Update Readme

Author: AnnaSasDev

.editorconfig

@@ -9,7 +9,7 @@ indent_size = 4
 # Microsoft .NET properties
 csharp_new_line_before_members_in_object_initializers = false
 csharp_new_line_before_open_brace = none
-csharp_preferred_modifier_order = internal, protected, public, sealed, file, new, private, override, static, required, readonly, abstract, extern, unsafe, volatile, async, virtual:suggestion
+csharp_preferred_modifier_order = public, internal, protected, private, async, virtual, file, new, sealed, override, required, abstract, extern, static, volatile, unsafe, readonly:suggestion
 csharp_style_prefer_utf8_string_literals = true:suggestion
 csharp_style_var_elsewhere = false:none
 csharp_style_var_for_built_in_types = false:suggestion
@@ -25,6 +25,12 @@ dotnet_naming_rule.private_instance_fields_rule.resharper_guid = 4a98fdf6-7d98-4
 dotnet_naming_rule.private_instance_fields_rule.severity = warning
 dotnet_naming_rule.private_instance_fields_rule.style = lower_camel_case_style
 dotnet_naming_rule.private_instance_fields_rule.symbols = private_instance_fields_symbols
+dotnet_naming_rule.private_instance_fields_rule_1.import_to_resharper = True
+dotnet_naming_rule.private_instance_fields_rule_1.resharper_description = Instance fields (private)
+dotnet_naming_rule.private_instance_fields_rule_1.resharper_guid = 4a98fdf6-7d98-4f5a-afeb-ea44ad98c70c
+dotnet_naming_rule.private_instance_fields_rule_1.severity = warning
+dotnet_naming_rule.private_instance_fields_rule_1.style = lower_camel_case_style
+dotnet_naming_rule.private_instance_fields_rule_1.symbols = private_instance_fields_symbols_1
 dotnet_naming_rule.private_static_fields_rule.import_to_resharper = True
 dotnet_naming_rule.private_static_fields_rule.resharper_description = Static fields (private)
 dotnet_naming_rule.private_static_fields_rule.resharper_exclusive_prefixes_suffixes = true
@@ -44,6 +50,12 @@ dotnet_naming_rule.unity_serialized_field_rule.resharper_guid = 5f0fdb63-c892-4d
 dotnet_naming_rule.unity_serialized_field_rule.severity = warning
 dotnet_naming_rule.unity_serialized_field_rule.style = lower_camel_case_style_1
 dotnet_naming_rule.unity_serialized_field_rule.symbols = unity_serialized_field_symbols
+dotnet_naming_rule.unity_serialized_field_rule_1.import_to_resharper = True
+dotnet_naming_rule.unity_serialized_field_rule_1.resharper_description = Unity serialized field
+dotnet_naming_rule.unity_serialized_field_rule_1.resharper_guid = 5f0fdb63-c892-4d2c-9324-15c80b22a7ef
+dotnet_naming_rule.unity_serialized_field_rule_1.severity = warning
+dotnet_naming_rule.unity_serialized_field_rule_1.style = lower_camel_case_style_1
+dotnet_naming_rule.unity_serialized_field_rule_1.symbols = unity_serialized_field_symbols_1
 dotnet_naming_style.lower_camel_case_style.capitalization = camel_case
 dotnet_naming_style.lower_camel_case_style.required_prefix = _
 dotnet_naming_style.lower_camel_case_style_1.capitalization = camel_case
@@ -57,6 +69,10 @@ dotnet_naming_symbols.private_instance_fields_symbols.applicable_accessibilities
 dotnet_naming_symbols.private_instance_fields_symbols.applicable_kinds = field
 dotnet_naming_symbols.private_instance_fields_symbols.resharper_applicable_kinds = field, readonly_field
 dotnet_naming_symbols.private_instance_fields_symbols.resharper_required_modifiers = instance
+dotnet_naming_symbols.private_instance_fields_symbols_1.applicable_accessibilities = private
+dotnet_naming_symbols.private_instance_fields_symbols_1.applicable_kinds = field
+dotnet_naming_symbols.private_instance_fields_symbols_1.resharper_applicable_kinds = field,readonly_field
+dotnet_naming_symbols.private_instance_fields_symbols_1.resharper_required_modifiers = instance
 dotnet_naming_symbols.private_static_fields_symbols.applicable_accessibilities = private
 dotnet_naming_symbols.private_static_fields_symbols.applicable_kinds = field
 dotnet_naming_symbols.private_static_fields_symbols.required_modifiers = static
@@ -68,9 +84,13 @@ dotnet_naming_symbols.private_static_readonly_symbols.required_modifiers = reado
 dotnet_naming_symbols.private_static_readonly_symbols.resharper_applicable_kinds = readonly_field
 dotnet_naming_symbols.private_static_readonly_symbols.resharper_required_modifiers = static
 dotnet_naming_symbols.unity_serialized_field_symbols.applicable_accessibilities = *
-dotnet_naming_symbols.unity_serialized_field_symbols.applicable_kinds =
+dotnet_naming_symbols.unity_serialized_field_symbols.applicable_kinds = 
 dotnet_naming_symbols.unity_serialized_field_symbols.resharper_applicable_kinds = unity_serialised_field
 dotnet_naming_symbols.unity_serialized_field_symbols.resharper_required_modifiers = instance
+dotnet_naming_symbols.unity_serialized_field_symbols_1.applicable_accessibilities = *
+dotnet_naming_symbols.unity_serialized_field_symbols_1.applicable_kinds = 
+dotnet_naming_symbols.unity_serialized_field_symbols_1.resharper_applicable_kinds = unity_serialised_field
+dotnet_naming_symbols.unity_serialized_field_symbols_1.resharper_required_modifiers = instance
 dotnet_sort_system_directives_first = false
 dotnet_style_parentheses_in_arithmetic_binary_operators = never_if_unnecessary:none
 dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:none
@@ -89,56 +109,61 @@ resharper_align_multiline_statement_conditions = false
 resharper_arguments_anonymous_function = named
 resharper_arguments_skip_single = true
 resharper_autodetect_indent_settings = true
-resharper_blank_lines_after_block_statements = 0
 resharper_blank_lines_after_control_transfer_statements = 1
 resharper_blank_lines_after_file_scoped_namespace_directive = 0
 resharper_blank_lines_after_start_comment = 0
+resharper_blank_lines_around_auto_property = 0
 resharper_blank_lines_around_block_case_section = 1
 resharper_blank_lines_around_property = 0
+resharper_braces_for_for = required
 resharper_braces_for_foreach = required_for_multiline_statement
-resharper_braces_for_ifelse = required_for_multiline_statement
+resharper_braces_for_ifelse = not_required
+resharper_braces_for_while = required_for_multiline
 resharper_braces_redundant = false
+resharper_cpp_insert_final_newline = true
+resharper_csharp_blank_lines_around_field = 0
+resharper_csharp_blank_lines_around_invocable = 0
 resharper_csharp_blank_lines_around_region = 0
 resharper_csharp_blank_lines_inside_region = 0
-resharper_csharp_empty_block_style = together
 resharper_csharp_insert_final_newline = true
-resharper_csharp_max_line_length = 1445
+resharper_csharp_keep_blank_lines_in_declarations = 100
+resharper_csharp_max_line_length = 505
 resharper_csharp_remove_blank_lines_near_braces_in_code = false
 resharper_csharp_remove_blank_lines_near_braces_in_declarations = false
 resharper_csharp_space_around_alias_eq = false
+resharper_csharp_space_before_trailing_comment = false
 resharper_csharp_stick_comment = false
-resharper_csharp_wrap_arguments_style = chop_if_long
+resharper_csharp_wrap_after_declaration_lpar = true
 resharper_csharp_wrap_before_binary_opsign = true
+resharper_csharp_wrap_before_declaration_rpar = true
 resharper_csharp_wrap_extends_list_style = chop_if_long
 resharper_formatter_off_tag = @formatter:off
 resharper_formatter_on_tag = @formatter:on
 resharper_formatter_tags_enabled = true
-resharper_indent_inside_namespace = false
-resharper_indent_pars = outside_and_inside
 resharper_indent_preprocessor_if = usual_indent
 resharper_indent_preprocessor_other = do_not_change
 resharper_indent_raw_literal_string = indent
-resharper_instance_members_qualify_declared_in =
+resharper_instance_members_qualify_declared_in = 
 resharper_keep_existing_attribute_arrangement = true
 resharper_keep_existing_declaration_block_arrangement = true
 resharper_keep_existing_embedded_block_arrangement = true
 resharper_max_attribute_length_for_same_line = 70
 resharper_method_or_operator_body = expression_body
 resharper_parentheses_redundancy_style = remove
-resharper_place_accessorholder_attribute_on_same_line = true
-resharper_place_accessor_attribute_on_same_line = true
+resharper_place_accessorholder_attribute_on_same_line = false
 resharper_place_expr_accessor_on_single_line = true
 resharper_place_expr_property_on_single_line = true
-resharper_place_record_field_attribute_on_same_line = true
 resharper_place_simple_accessor_on_single_line = false
 resharper_place_simple_anonymousmethod_on_single_line = false
+resharper_place_simple_case_statement_on_same_line = true
 resharper_place_simple_embedded_statement_on_same_line = true
 resharper_place_simple_initializer_on_single_line = false
+resharper_place_simple_list_pattern_on_single_line = false
+resharper_place_type_attribute_on_same_line = if_owner_is_single_line
 resharper_qualified_using_at_nested_scope = true
 resharper_space_within_empty_braces = false
+resharper_treat_case_statement_with_break_as_simple = false
 resharper_use_indent_from_vs = false
-resharper_wrap_before_primary_constructor_declaration_rpar = true
-resharper_wrap_chained_binary_expressions = chop_if_long
 resharper_wrap_list_pattern = chop_always
 resharper_wrap_object_and_collection_initializer_style = chop_always
 
@@ -149,6 +174,7 @@ resharper_arrange_type_member_modifiers_highlighting = hint
 resharper_arrange_type_modifiers_highlighting = hint
 resharper_built_in_type_reference_style_for_member_access_highlighting = hint
 resharper_built_in_type_reference_style_highlighting = hint
+resharper_html_path_error_highlighting = none
 resharper_mvc_action_not_resolved_highlighting = warning
 resharper_mvc_area_not_resolved_highlighting = warning
 resharper_mvc_controller_not_resolved_highlighting = warning

README.md

@@ -1,133 +1,81 @@
-# CliArgsParser
+# CodeOfChaos.CliArgsParser
 
-![NuGet Downloads](https://img.shields.io/nuget/dt/CliArgsParser)
-![NuGet Version](https://img.shields.io/nuget/v/CliArgsParser?link=https%3A%2F%2Fwww.nuget.org%2Fpackages%2FCliArgsParser)
+## Overview
+CodeOfChaos.CliArgsParser is a library designed to simplify the process of creating command-line applications in .NET projects. It provides developers with attributes, structures, and tools to quickly define, parse, and execute CLI commands with minimal boilerplate code. The library is focused on flexibility, clarity, and ease of use, utilizing C#'s powerful features like attributes and partial classes.
 
-CliArgsParser is a library built around Dependency Injection to allow you to create Cli tools with ease.
-This is particularly useful in scenarios where your application requires a large amount of commands,
-with specific arguments.
-
-```shell
-dotnet add package CliArgsParser --version 2.2.7
-```
+---
 
 ## Features
+- **Easy Command Definition**: Define commands using attributes like `[CliArgsCommand]` and `[CliArgsParameter]` directly in your application.
+- **Automatic Parsing**: Command-line arguments are parsed and mapped to parameters automatically.
+- **Description Metadata**: Add meaningful descriptions to commands and parameters using `[CliArgsDescription]` for better documentation.
+- **Support for Flags and Complex Types**: Easily handle flags, strings, arrays, and even optional/default values.
+- **Asynchronous Execution**: Built-in support for asynchronous methods to handle complex operations.
 
-Here are the key features of Cli Args Parser:
-
-- **Command Declaration and Registration**: Commands are declaratively defined within a class using the `ICommandAtlas`
-  interface.
-  This arrangement provides a well-structured, easy-to-maintain way of defining and locating command handling logic.
-- **Asynchronous Command Execution**: CliArgsParser allows for asynchronous execution of commands.
-  This can provide major performance benefits, especially when commands involve IO-bound operations.
-  The library also exposes the `ArgsParser.ParseAsyncParallel` method for parallel async execution of cli tools.
-- **Argument Mapping**: CliArgsParser allows property-based argument mapping.
-  Properties of a class implementing the ICommandParameters interface can be used as the target of argument mapping from
-  command line input.
-  Argument mapping is further simplified through the use of the `ArgValue` and `ArgFlag` attributes which takes the
-  argument name as a parameter.
-- **Dependency Injection approach**: The library is built around using DI in your workflow. `ICommandAtlas` classes
-  allow constructors to fully utilize dependency injection.
-  Yet you are not required to have a `IServiceCollection`, by using the `CliParser.CreateStandalone()` or
-  `ArgsParser.CreateStandalone()` methods.
+---
 
-## F.A.Q:
+## Getting Started
+To use CodeOfChaos.CliArgsParser in your project, follow these steps:
 
-> **"I tried to create a atlas with async commands, but they did not execute when called"**
->
-> This is due to the parser trying to execute the commands as non-async, because the parser was most likely called
-> without using the async methods.
-> To resolve this, always run the parsers through their async methods.
-
-## Quick Start
-
-The following section is a basic example on how to get started with CliArgsParser.
-For in-code examples, they can be found in the repo under
-examples : https://github.com/code-of-chaos/CliArgsParser-cs/tree/core/examples
+### 1. Install the Library
+Add the library to your project via NuGet:
+```bash
+dotnet add package CodeOfChaos.CliArgsParser
+```
 
-### Dependency Injected approach
+---
 
+### 2. Define a Command
+Commands are defined as partial classes and annotated with metadata. For example:
 ```csharp
-using CliArgsParser;
-
-// Define a class for mapping arguments
-public class ArgsTest : ICommandParameters  {
-    [ArgValue("name"), Description("Defines the name of the user")] 
-    public string Name { get; set; } = "Default Name";
-}
-
-public class MyAppCommands : ICommandAtlas {
-    [Command("hello"), Description("Greets everyone")]
-    public void CommandHello() {
-        Console.Writeline("Hello there!");    
-        /* Or your command' implementation, without arguments, goes here... */
-    }
-
-    [Command<ArgsTest>("greet"), Description("Greets you specificly")]
-    public void CommandGreet(ArgsTest argsTest)  {
-        Console.Writeline($"Hello there and welcome, {argsTest.Name}");  
-        /* Or Your command implementation goes here... */
-    }
-}
-
-internal static class Program {
-    public async static Task Main(string[] args) {
-        IServiceCollection serviceCollection = new ServiceCollection();
-
-        serviceCollection.AddCliArgsParser(configuration =>
-            configuration
-                .SetConfig(new CliArgsParserConfig {
-                    Overridable = true,
-                    GenerateShortNames = true
-                })
-                .AddFromType<HelloAtlas>()
-        );
+[CliArgsCommand("example")]
+[CliArgsDescription("This is a test command")]
+public partial class ExampleCommand : ICommand<ExampleCommandParameters> {
+    public async Task ExecuteAsync(ExampleCommandParameters parameters) {
+        Console.WriteLine($"Running example command with TestValue: {parameters.TestValue}");
 
-        ServiceProvider provider = serviceCollection.BuildServiceProvider();
+        if (parameters.Verbose) {
+            Console.WriteLine("Verbose mode enabled.");
+        }
 
-        var cliParser =  provider.GetRequiredService<ICliParser>();
-        await cliParser.StartParsingAsync();
+        await Task.Delay(100); // Simulating async work
     }
 }
 ```
 
-### Standalone Approach
+---
 
+### 3. Define Parameters
+Parameters for a command are defined using partial structs with annotated attributes:
 ```csharp
-using CliArgsParser;
-
-// Define a class for mapping arguments
-public class ArgsTest : ICommandParameters  {
-    [ArgValue("name"), Description("Defines the name of the user")] 
-    public string Name { get; set; } = "Default Name";
+public readonly partial struct ExampleCommandParameters : IParameters
+{
+    [CliArgsParameter("test", "t")]
+    [CliArgsDescription("A required test parameter")]
+    public required string TestValue { get; init; }
+
+    [CliArgsParameter("verbose", "v", ParameterType.Flag)]
+    [CliArgsDescription("Enable verbose logging")]
+    public bool Verbose { get; init; }
+    
+    [CliArgsParameter("optional-parameter", "o")]
+    [CliArgsDescription("An optional parameter")]
+    public string? OptionalValue { get; init; } = "default";
 }
+```
 
-public class MyAppCommands : ICommandAtlas {
-    [Command("hello"), Description("Greets everyone")]
-    public void CommandHello() {
-        Console.Writeline("Hello there!");    
-        /* Or your command' implementation, without arguments, goes here... */
-    }
+---
 
-    [Command<ArgsTest>("greet"), Description("Greets you specificly")]
-    public void CommandGreet(ArgsTest argsTest)  {
-        Console.Writeline($"Hello there and welcome, {argsTest.Name}");  
-        /* Or Your command implementation goes here... */
-    }
-}
+### 4. Register and Run Commands
+Typically, this is performed in your `Program.cs` or entry point:
+```csharp
+using CodeOfChaos.CliArgsParser;
 
-internal static class Program {
-    public async static Task Main(string[] args) {
-        ICliParser parser = CliParser.CreateStandalone(
-            configuration =>
-                configuration
-                    .SetConfig(new CliArgsParserConfig {
-                        Overridable = true,
-                        GenerateShortNames = true
-                    })
-                    .AddFromType<HelloAtlas>()
-        );
-        await cliParser.StartParsingAsync();
+CliArgsParser parser = CliArgsBuilder.CreateFromConfig(
+    config => {
+        config.AddCommand<ExampleCommand>();
     }
-}
+).Build();
+
+await parser.ParseAsync(args);
 ```

src/CodeOfChaos.CliArgsParser.Generators.Sample/Example.cs

@@ -1,8 +1,6 @@
 // ---------------------------------------------------------------------------------------------------------------------
 // Imports
 // ---------------------------------------------------------------------------------------------------------------------
-using CodeOfChaos.CliArgsParser.Attributes;
-using CodeOfChaos.CliArgsParser.Contracts;
 using System;
 using System.Threading.Tasks;
 

src/CodeOfChaos.CliArgsParser.Library/CommandAtlases/DownloadIcon/DownloadIconCommand.cs

@@ -2,8 +2,6 @@
 // Imports
 // ---------------------------------------------------------------------------------------------------------------------
 using AterraEngine.Unions;
-using CodeOfChaos.CliArgsParser.Attributes;
-using CodeOfChaos.CliArgsParser.Contracts;
 using CodeOfChaos.CliArgsParser.Library.Shared;
 using System.Text.RegularExpressions;
 using System.Xml.Linq;

src/CodeOfChaos.CliArgsParser.Library/CommandAtlases/DownloadIcon/DownloadIconParameters.cs

@@ -1,9 +1,6 @@
 // ---------------------------------------------------------------------------------------------------------------------
 // Imports
 // ---------------------------------------------------------------------------------------------------------------------
-using CodeOfChaos.CliArgsParser.Attributes;
-using CodeOfChaos.CliArgsParser.Contracts;
-
 namespace CodeOfChaos.CliArgsParser.Library.CommandAtlases.DownloadIcon;
 // ---------------------------------------------------------------------------------------------------------------------
 // Code

src/CodeOfChaos.CliArgsParser.Library/CommandAtlases/VersionBump/VersionBumpCommand.cs

@@ -2,8 +2,6 @@
 // Imports
 // ---------------------------------------------------------------------------------------------------------------------
 using AterraEngine.Unions;
-using CodeOfChaos.CliArgsParser.Attributes;
-using CodeOfChaos.CliArgsParser.Contracts;
 using CodeOfChaos.CliArgsParser.Library.Shared;
 using System.Xml.Linq;
 

src/CodeOfChaos.CliArgsParser.Library/CommandAtlases/VersionBump/VersionBumpParameters.cs

@@ -1,9 +1,6 @@
 // ---------------------------------------------------------------------------------------------------------------------
 // Imports
 // ---------------------------------------------------------------------------------------------------------------------
-using CodeOfChaos.CliArgsParser.Attributes;
-using CodeOfChaos.CliArgsParser.Contracts;
-
 namespace CodeOfChaos.CliArgsParser.Library.CommandAtlases.VersionBump;
 // ---------------------------------------------------------------------------------------------------------------------
 // Code