kdheath.Application.Helper 2.0.1

About

The Application.Helper package is a light-weight platform for .NET console applications.

See Change Log for release notes.

Key Features

• Supports .NET Framework, .NET Core, and .NET 5.0+

It provides:

• The title of the program from the assembly attributes.
• The name of the configuration file (if it can be determined).
• The elapsed time of the starting and stopping of the program.
• Methods to suspend and resume elapse time recording are available.
• Indication of whether the program is running in debug mode.
• Indication of whether help was requested from the command line arguments.

How to Use

To provide help information about the program:

• Create a new class and use the ConsoleApp class as the base class.
• Override the ShowProgramInfo() method. This is called during the start process and is triggered by the user providing a question mark (?) anywhere in the first argument.

To use in a C# program:

using Application.Helper;

private static readonly ConsoleApp sApp = new();

The main entry point method would look like:

static void Main( string[] args )
{
  var result = false;
  try
  {
    sApp.StartApp( args );
    Console.WriteLine( sApp.FormatTitleLine( " Starting " + sApp.Title + " " ) );
    result = Processing();
  }
  catch( Exception ex )
  {
    // Do something to log the error
  }
  finally
  {
    sApp.StopApp( result );
  }
  Environment.Exit( Environment.ExitCode );
}

The output looks like this:

Start..: 20:16:31.8915290

------------------- Starting Test Harness [Version 1.0.1.1] --------------------

Runtime: 00:00:00.2836824
Result.: Success

Press any key to continue . . .

Main Types

• ConsoleApp - Helper class for Console Applications.
• GenericException - Represents errors that occur during application execution.

Feedback

This is provided as open source under the MIT license.
Bug reports and contributions are welcome at the GitHub repository.