bryanapellanes / bam.console

Bam.Console

Simple menuing system for dotnet console apps.

Menu (Attribute)

Adorn a class with the [Menu] attribute and specify the attribute type that adorns the methods you wish to show in that menu.

[Menu<MenuItemAttribute>]
public class MenuExample
{
    [MenuItem]
    public void ThisIsTheFirstMenuItem()
    {
        System.Console.WriteLine("Executed {0}", nameof(ThisIsTheFirstMenuItem));
    }
    
    [MenuItem]
    public void ThisIsTheSecondMenuItem()
    {
        System.Console.WriteLine("Executed {0}", nameof(ThisIsTheFirstMenuItem));
    }
    
    [MenuItem("Menu item with a name")]
    public void ThisMenuItemHasAName()
    {
        System.Console.WriteLine("Executed {0}", nameof(ThisIsTheFirstMenuItem));
    }
}

The preceding class definition renders the following menu:

MenuExample

Select an option below:
> 1. [:titfmi] ThisIsTheFirstMenuItem
  2. [:titsmi] ThisIsTheSecondMenuItem
  3. [:tmihan] Menu item with a name
-----------------------------------
[:me] MenuExample
-----------------------------------
 me > 

You may use the up and down arrow keys to navigate the menu items. You may also type one of the selectors shown in square brackets prefixed by a colon : to jump directly to the item of your choice. Press Enter to execute the currently selected item.

Note: The selectors are a camel cased acronym of the method name, adjust your method names accordingly to get the selector you desire.

Named Menu

You may specify an optional name for your menu by providing a name to the Menu attribute.

[Menu<MenuItemAttribute>("A named Menu")]
public class MenuExample
{
    [MenuItem]
    public void ThisIsTheFirstMenuItem()
    {
        System.Console.WriteLine("Executed {0}", nameof(ThisIsTheFirstMenuItem));
    }
    
    [MenuItem]
    public void ThisIsTheSecondMenuItem()
    {
        System.Console.WriteLine("Executed {0}", nameof(ThisIsTheFirstMenuItem));
    }
    
    [MenuItem("Menu item with a name")]
    public void ThisMenuItemHasAName()
    {
        System.Console.WriteLine("Executed {0}", nameof(ThisIsTheFirstMenuItem));
    }
}

The preceding class definition renders the following menu.

A named Menu

Select an option below:
> 1. [:titfmi] ThisIsTheFirstMenuItem
  2. [:titsmi] ThisIsTheSecondMenuItem
  3. [:tmihan] Menu item with a name
-----------------------------------
[:anm] A named Menu
-----------------------------------
 anm >

InputCommand (Attribute)

Adorn a method with the InputCommand attribute and specify the name of the command you'd like to use to execute the command from the menu prompt.

[Menu<MenuItemAttribute>("Input Command Menu")]
public class InputCommandExample
{
    [MenuItem]
    public void MenuItem()
    {
        System.Console.WriteLine("Execute {0}", nameof(MenuItem));
    }
    
    [InputCommand("input command one")]
    public void InputCommandOne()
    {
        System.Console.WriteLine("Executed {0}", nameof(InputCommandOne));
        System.Console.WriteLine("Calling MenuItem method from input command...");
        MenuItem();
    }
}

The preceding example defines the InputCommandOne method which may be executed from the menu prompt by entering input command one.

Note: Methods adorned with the InputCommand attribute are not displayed in the menu unless also adorned with the attribute specified in the Menu attribute which adorns the class.

Note: For a method adorned with the InputCommand attribute to be accessable, there must be at least one valid menu item in the menu, whether it is the InputCommand itself or another method addorned with a MenuItem attribute.

The preceding class definition renders the following menu.

Input Command Menu

Select an option below:
> 1. [:mi] MenuItem
-----------------------------------
[:icm] Input Command Menu
-----------------------------------
"input command one" -- Execute the input command
-----------------------------------
 icm > 

ConsoleCommand (Attribute)

[ConsoleCommand]
public void MethodName(string value, string value2)
{
    Console.WriteLine("You entered {0} for value and {1} for value 2", value, value2)
}