OutWit.Common.CommandLine 1.0.0

OutWit.Common.CommandLine

Overview

OutWit.Common.CommandLine is a lightweight library designed to simplify serialization and deserialization of command-line arguments in .NET applications. By leveraging attributes from the CommandLine library, it enables seamless mapping of object properties to command-line options and vice versa.

Features

1. Command-Line Serialization

The library allows converting objects into command-line argument strings based on the OptionAttribute.

Example

using OutWit.Common.CommandLine;
using CommandLine;

public class Options
{
    [Option('n', "name", Required = true, HelpText = "The name of the user.")]
    public string Name { get; set; } = string.Empty;

    [Option('a', "age", HelpText = "The age of the user.")]
    public int Age { get; set; }

    [Option('v', "verbose", HelpText = "Enable verbose mode.")]
    public bool Verbose { get; set; }
}

var options = new Options
{
    Name = "John",
    Age = 30,
    Verbose = true
};

string commandLine = options.SerializeCommandLine();
Console.WriteLine(commandLine); 
// Output: --name John --age 30 --verbose

2. Command-Line Deserialization

Easily parse command-line arguments into strongly typed objects.

Example

string[] args = { "--name", "John", "--age", "30", "--verbose" };

var options = args.DeserializeCommandLine<Options>();
Console.WriteLine(options.Name); // Output: John
Console.WriteLine(options.Age);  // Output: 30
Console.WriteLine(options.Verbose); // Output: True

3. Attribute-Based Configuration

The library uses OptionAttribute from the CommandLine library to define mappings between object properties and command-line options. Supported configurations include:

• Short and long option names
• Required and optional properties
• Help text for documentation

Installation

Install the package via NuGet:

Install-Package OutWit.Common.CommandLine

API Reference

SerializeCommandLine

public static string SerializeCommandLine<T>(this T me)

• Description: Converts an object into a command-line argument string based on OptionAttribute annotations.
• Returns: A string representing the serialized command-line arguments.

DeserializeCommandLine

From String

public static T DeserializeCommandLine<T>(this string me)

• Description: Parses a command-line argument string into an object of type T.
• Returns: An instance of T populated with parsed values.

From String Array

public static T DeserializeCommandLine<T>(this string[] me)

• Description: Parses a string array of command-line arguments into an object of type T.
• Returns: An instance of T populated with parsed values.