TJC.ConsoleApplication 0.10.0

Table of Contents

• Console Setup
• Header
• Arguments
• Prompts
• Exit

Console Setup

• Used to setup the console application with exceptions handling, logging, etc.

ConsoleSetup.Setup(ConsoleSettings? consoleSettings = null, ProcessExitOptions? processExitSettings = null)

• Allows setting up the console application with a variety of options.

ConsoleSetup.Setup();

ConsoleSetup.SetupSilent()

• Sets up the console application to be silent (no output to console) unless an exception occurs.

ConsoleSetup.SetupSilent();

Header

ConsoleHeaderExtensions.WriteConsoleHeader();

• Will write a header to the console with the application title, version, copyright, & description.
• Note: This is built into ConsoleSetup.Setup() by default.

Arguments

Arguments Parsing

• Use ConsoleArguments to configure the arguments that the program will accept.
• If any required arguments are missing or invalid, an error & help message will be displayed.

Example

In the main program, call the Arguments.Parse(args); to parse the arguments.

internal class Arguments
{
    internal static void Parse(string[] args) =>
        ConsoleArguments.ParseAndValidate(args, Assembly.GetCallingAssembly().GetName().Name);

    internal static DryRunArgument DryRun => DryRunArgument.Default;
    internal static bool Item1 { get; private set; }
    internal static string? Item2 { get; private set; }

    internal static readonly ConsoleArguments ConsoleArguments = new(flagRequired: true, logParsedOptions: true)
    {
        DryRun,
        { "item1", v => Item1 = !string.IsNullOrEmpty(v), "Example Item 1" },
        { "item2", v => Item2 = v, "Example Item 2" }
    };
}

Prompts

Yes/No

bool ConsolePrompt.GetYesNo(string message)

• Prompts the user with the message and waits for a 'Y' or 'N' input (case-insensitive)
• Outputs error message and waits for input again if input is invalid
• Returns true if 'Y' and false if 'N'

var result = ConsolePrompt.GetYesNo("Do you want to continue?");
// Outputs: Do you want to continue? (Y/N): 

Text

string ConsolePrompt.GetString(string message)

• Prompts the user with the message and waits for a string input

var result = ConsolePrompt.GetString("Enter your name:");
// Outputs: Enter your name:

string ConsolePrompt.GetStringChange(string message, string original)

• Prompts the user to choose whether to change from original value or not

var original = "John"
var result = ConsolePrompt.GetStringChange("MyName", original);
// Outputs: Do you want to change MyName from [John]? (Y/N):
// Waits for user input of 'Y' or 'N' (case-insensitive)
// Returns the original value if 'N' otherwise prompts for a new value like so:
// Outputs: MyName:

ConsolePrompt.GetStringChange(string message, ref string value)

• Prompts the user to choose whether to change from original value or not

var original = "John"
ConsolePrompt.GetStringChange("MyName", ref original);
// Outputs: Do you want to change MyName from [John]? (Y/N):
// Waits for user input of 'Y' or 'N' (case-insensitive)
// Returns the original value if 'N' otherwise prompts for a new value like so
// Outputs: MyName:

Numbers

int ConsolePrompt.GetInt(string message)

• Prompts the user to enter an integer
• Outputs error message and waits for input again if input is invalid

ConsolePrompt.GetInt("Enter Value");

int ConsolePrompt.GetIntRange(string message, int max, int min, bool inclusive)

• Prompts the user to enter an integer within a specified range (inclusive or exclusive)
• Outputs error message and waits for input again if input is invalid

ConsolePrompt.GetInt("Enter Value", 10, 1);

Choices

int ConsolePrompt.GetChoiceIndex(string message, IEnumerable<string> choices, int offset = 1)

• Prompts the user to select an option from a list of choices
• Returns the index of the selected choice

var options = new List<string> { "Option 1", "Option 2", "Option 3" };
var index = ConsolePrompt.GetChoiceIndex("Choose", options);
// Outputs:
// Choose:
// 1. Option 1
// 2. Option 2
// 3. Option 3

string ConsolePrompt.GetChoice(string message, IEnumerable<string> choices, int offset = 1)

• Prompts the user to select an option from a list of choices
• Returns the string of the selected choice

var options = new List<string> { "Option 1", "Option 2", "Option 3" };
var choice = ConsolePrompt.GetChoice("Choose", options);
// Outputs:
// Choose:
// 1. Option 1
// 2. Option 2
// 3. Option 3

T ConsolePrompt.GetChoice<T>(string message) where T: Enum

• Prompts the user to select an option from an enum

var choice = ConsolePrompt.GetChoice<MyEnum>("Choose");
// Outputs:
// Choose:
// 1. EnumItem1
// 2. EnumItem2
// 3. EnumItem3

T? ConsolePrompt.GetChoiceDone<T>(string message) where T: Enum

• Prompts the user to select an option from an enum
• If the first option is selected, it returns null

var choice = ConsolePrompt.GetChoiceDone<MyEnum>("Choose");
// Outputs:
// Choose:
// 0. Done
// 1. EnumItem1
// 2. EnumItem2
// 3. EnumItem3

T ConsolePrompt.GetChoiceChange<T>(string message, T current, T? defaultChoice) where T: Enum

• Prompts the user if they want to change from the currently selected enum

var choice = MyEnum.EnumItem1
choice = ConsolePrompt.GetChoiceChange<MyEnum>("choice", choice);
// Outputs:
// Change choice from [EnumItem1]? (Y/N): Y
// 1. EnumItem1
// 2. EnumItem2
// 3. EnumItem3

Collections

ICollection<string> ConsolePrompt.GetCollection(string message, string messageIndividual = "")

• Prompts the user to enter a collection of strings
• If messageIndividual is provided, it will be used as the prompt for each item in the collection
• If no value is provided, the collection ends, and the response(s) are returned

var collection = ConsolePrompt.GetCollection("Enter a collection of strings", "str");
// Outputs: Enter a collection of strings (press enter after each item | press enter on an empty line to complete the list):
// Outputs: str:

ICollection<int> ConsolePrompt.GetCollectionInt(string message, string messageIndividual = "")

• Prompts the user to enter a collection of integers

var collection = ConsolePrompt.GetCollection("Enter a collection of ints");

ICollection<double> ConsolePrompt.GetCollectionDouble(string message, string messageIndividual = "")

• Prompts the user to enter a collection of doubles

var collection = ConsolePrompt.GetCollection("Enter a collection of doubles");

ICollection<T> ConsolePrompt.GetCollectionEnum<T>(string message, string messageIndividual = "")

• Prompts the user to enter a collection of enums

var collection = ConsolePrompt.GetCollectionEnum<MyEnum>("Enter a collection of enums");

Exit

ProcessExitExtensions.ConfigureProcessExitEvent(ProcessExitSettings settings)

• Configures the process to display run time & error messages on exit