Click here to Skip to main content
Click here to Skip to main content

NConsoler - command line parser library for .NET

, 8 Sep 2008 CPOL
Rate this:
Please Sign up or sign in to vote.
Command line parser based on meta information.

Introduction

Usually, parsing arguments in console applications takes a lot of time. You can find a few solutions in the Internet that make it easier to implement this task, however, they are not very simple and flexible. Therefore, I decided to design a new system based on metadata and call it NConsoler.

Using the code

The main idea is to find a way to transform a set of arguments to call a particular method. In case the arguments are wrong, the application must return a human understandable error message, with error details, to provide user friendly behavior for the application. Also, it is easy to provide help information using the metainfo.

Well, to get the required method with a set of arguments, the method should be marked. For this functionality, we could use attributes that ideally suit this job. I implemented an Action attribute:

[Action]
public static void Method(...)...

Also, methods could have required and optional arguments to add flexibility in the development process. This could be realized by including attributes as well as using the Action attribute for a method:

[Action]
public static void Method(
    [Required] string name,
    [Optional(true)] bool flag)...

As far as we know, Method must take a set of input parameters, and for optional parameters, we have to set optional values, by default.

The last thing to do before running the application is to design a Main method:

public static void Main(params string[] args) {
    Consolery.Run(typeof(Program), args);
}

The type that has a method marked as Action should be passed into the Run method and the arguments must be passed as well.

The complete source code is available here:

using System;
using NConsoler;

public class Program {
    public static void Main(params string[] args) {
        Consolery.Run(typeof(Program), args);
    }

    [Action]
    public static void Method(
        [Required] string name,
        [Optional(true)] bool flag) {
        Console.WriteLine('name: {0}, flag: {1}', name, flag);
    }
}

Let’s run our application:

> program.exe Max /flag
name: Max, flag: true

And now, with the inversed flag:

> program.exe Max /-flag
name: Max, flag: false

Certainly, in the definition of the Action method, the user could make a mistake, and in most libraries, the source of the error is not obvious; therefore, an adequate error message is extremely important. I pointed this out at the beginning of the article. Before starting an action method, NConsoler checks meta-information as well as the parameters of the command line and displays a detailed error message with the eventual cause of error. This is a continuation of the “Design by contract” strategy.

More information can be found on the NConsoler site.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Maxim Tihobrazov
Software Developer (Senior) Csharpus
Ukraine Ukraine
I am developing web applications since 2002, and develop .net applications (web, web-services, win, win-services) since 2004

Comments and Discussions

 
GeneralMy vote of 1 PinmemberJoeWirtley18-Feb-09 13:24 
GeneralIdea for extension: Define multiple Actions PinmemberMichael B. Hansen24-Nov-08 1:08 
GeneralYou might not have seen this PinmemberdB.28-Sep-08 9:42 
GeneralAbility to determine if an optional parameter was specified Pinmembere800516-Sep-08 11:19 
GeneralRe: Ability to determine if an optional parameter was specified PinmemberMaxim Tihobrazov16-Sep-08 11:45 
GeneralRe: Ability to determine if an optional parameter was specified [modified] Pinmembere800516-Sep-08 12:21 
GeneralRe: Ability to determine if an optional parameter was specified PinmemberMaxim Tihobrazov17-Sep-08 0:18 
GeneralRe: Ability to determine if an optional parameter was specified Pinmembere800517-Sep-08 4:04 
GeneralVery cool idea PinmemberJean-Paul Mikkers9-Sep-08 4:24 
GeneralRe: Very cool idea PinmemberEgorRubansky10-Sep-08 0:01 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.141015.1 | Last Updated 8 Sep 2008
Article Copyright 2008 by Maxim Tihobrazov
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid