MiJenner.ConsoleUtils 0.14.0

MiJenner.ConsoleUtils

ConsoleUtils offer cross-platform utilities for easy interaction with a user.

There are methods for persistent reading of values of a certain data type from the console user. Pattern is Read<datatype>(). They prompt the user, and keep asking user for a value of a certain data type until she/he enters a correct data type. It offers methods for integers, doubles, decimals, boolean, dates, and enums.

There is a method for reading in multiple lines of text from the user StringReadMultipleLines().

There are methods for removing non-letters from strings: StringRemoveNonLettersENG(...) and StringRemoveNonLettersAll(...).

Finally there are methods for opening file explorer in current directory OpenExplorerFinder()

Method Signatures

Below is listed the signatures of the methods:

public static void OpenExplorerFinder()
public static void OpenExplorerFinderPath(string folderPath)
public static bool ReadBoolean(string prompt, string errorMessage, string trueValue = "j", string falseValue = "n")
public static DateTime ReadDate(string prompt, string errorMessage)
public static decimal ReadDecimal(string prompt, string errorMessage)
public static double ReadDouble(string prompt, string errorMessage)
public static int ReadInt(string prompt, string errorMessage)
static public string ReadLineWithEdit(string origText)
public static string ReadStringFromArray(string prompt, string errorMessage, string[] strings)
public static string ReadStringFromList(string prompt, string errorMessage, List<string> strings)
public static T ReadEnum<T>(string prompt, string errorMessage) where T : struct, Enum
public static TKey ReadDictKey<TKey, TValue>(string prompt, string errorMessage, Dictionary<TKey, TValue> dict, bool DisplayOptions = true, string OptionText = "Options: ")
public static string StringRemoveNonLettersENG(string input)
public static string StringRemoveNonLettersAll(string input)
public static string StringReadMultipleLines(string prompt, string instruction = "Type 3 empty lines to end")
public static bool TryReadDataType<T>(out T result)

Examples

First, remember to to add a using instruction:

using MiJenner;

Below are examples on how the library can be used:

ConsoleUtils.OpenExplorerFinder();
ConsoleUtils.OpenExplorerFinderPath("."); 
var a = ConsoleUtils.ReadInt("Please provide an integer", "No, please provide an integer");
var b = ConsoleUtils.ReadDouble("Please provide a floating point number", "No, please provide a floating point number");
var c = ConsoleUtils.ReadDate("Please provide a date", "No, please provide a date");
var d = ConsoleUtils.ReadBoolean("Please provide a boolean", "No, please provide a boolean", "t", "f");
var e = ConsoleUtils.ReadEnum<MyEnum>("Please provide an enum, MyEnum", "No, please provide an enum, MyEnum");

var choicesString = new Dictionary<string, string>
   {  {"Left", "Option 1" }, {"Right", "Option 2" }, {"Back", "Option 3" } };

var f = ConsoleUtils.ReadDictKey<string, string>("Type dict key (string)", "Nope", choicesString);

var choicesInt = new Dictionary<int, string>
   { {1, "Option 1" }, {2, "Option 2" }, {3, "Option 3" } };

var g = ConsoleUtils.ReadDictKey<int, string>("Type dict key (int)", "Nope", choicesInt);

string text = "Here is some text";
Console.WriteLine("Original text : " + text);
Console.Write("Edit the text : ");
text = ConsoleUtils.ReadLineWithEdit(text);
Console.WriteLine("After editing : " + text);

Nuget package

There is a nuget package available for easy usage.