CommandPatternLib 1.0.2

CommandApp Library

CommandApp is a powerful framework for building interactive console applications with command-based architecture. It simplifies command registration, parameter handling, and execution while maintaining flexibility and extensibility.

📦 Installation

Install the package via NuGet:

dotnet add package CommandApp

Getting Started
Step 1: Implement ICommandRepository
CommandApp relies on an ICommandRepository implementation for managing commands. Implement this interface as needed for your application:

csharp 
Copy code
public class CustomCommandRepository : ICommandRepository
{
    // Implement methods to manage commands, categories, and execution.
}
Step 2: Initialize CommandApp
Create an instance of CommandApp and provide your command repository:

csharp
Copy code
var commandRepository = new CustomCommandRepository();
var commandApp = new CommandApp(commandRepository);

Step 3: Register Commands
Synchronous Commands
csharp
Copy code
commandApp.RegisterCommand("greet", args =>
{
    Console.WriteLine($"Hello, {args[0]}!");
}, "Greets the user with their name.", "default");
Asynchronous Commands
csharp
Copy code
commandApp.RegisterCommand("delayed-greet", async args =>
{
    await Task.Delay(2000);
    Console.WriteLine($"Hello after delay, {args[0]}!");
}, "Greets the user with a delay.", "default");
Commands with Parameters
csharp
Copy code
commandApp.RegisterCommand("sum", args =>
{
    int a = int.Parse(args[0]);
    int b = int.Parse(args[1]);
    Console.WriteLine($"The sum is: {a + b}");
}, "Calculates the sum of two numbers.", "default", "a:int,b:int");
Step 4: Run the Application
Start the application loop to process user input:

csharp
Copy code
await commandApp.RunAsync();
📋 Features
Built-In Commands
Command	Description
help or ?	Displays available commands and their usage.
clear or cls	Clears the console screen.
exit or quit	Exits the application.
changecategory	Switches to a different command category.
Parameter Definitions
Parameters are defined using a structured format:

Syntax: name:type[options]
type: int, double, bool, string, or regex.
Options:
[optional] – Makes the parameter optional.
... – Indicates a continuous parameter.
Examples:

text
Copy code
username:string
age:int[optional]
data:regex'\d+'
🌟 Advanced Usage
Command Categories
Organize commands into categories for better management:

csharp Copy code

commandApp.CurrentCategory = "inventory";

commandApp.RegisterCommand("list", args =>
{
    Console.WriteLine("Listing items...");
}, "Lists items in the inventory.", "inventory");
Dynamic Command Registration
Register commands dynamically based on user input or external data:

csharp
Copy code
commandApp.RegisterCommand("dynamic", args =>
{
    Console.WriteLine("This is a dynamically registered command.");
}, "A dynamically registered command.");
🛠 Sample Application
csharp
Copy code
var commandRepository = new CustomCommandRepository();
var commandApp = new CommandApp(commandRepository);

// Register commands
commandApp.RegisterCommand("greet", args =>
{
    Console.WriteLine($"Hello, {args[0]}!");
}, "Greets the user with their name.");

commandApp.RegisterCommand("sum", args =>
{
    int a = int.Parse(args[0]);
    int b = int.Parse(args[1]);
    Console.WriteLine($"Sum: {a + b}");
}, "Calculates the sum of two numbers.", "default", "a:int,b:int");

// Run the app
await commandApp.RunAsync();
❓ FAQ
1. How do I register a command without parameters?
csharp
Copy code
commandApp.RegisterCommand("simple", args =>
{
    Console.WriteLine("This command requires no parameters.");
}, "A command with no parameters.");
2. Can I override built-in commands?
Yes, register a new command with the same name:

csharp
Copy code
commandApp.RegisterCommand("clear", args =>
{
    Console.WriteLine("Custom clear command logic.");
}, "Overrides the built-in clear command.");