Skip to content

Expose argument name and value in parse exceptions #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
drmathias wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Expose argument name and value in parse exceptions #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion src/ConsoleAppFramework.Abstractions/ConsoleApp.Abstractions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,22 @@ public sealed class ConsoleAppFilterAttribute<T> : Attribute
{
}

public sealed class ArgumentParseFailedException(string message) : Exception(message)
public class ArgumentParseFailedException : Exception
{
public ArgumentParseFailedException(string message, string argumentName) : base(message)
{
ArgumentName = argumentName;
}

public string ArgumentName { get; }
}

public sealed class ArgumentParseInvalidValueException : ArgumentParseFailedException
{
public ArgumentParseInvalidValueException(string message, string argumentName, string argumentValue) : base(message, argumentName)
{
ArgumentValue = argumentValue;
}

public string ArgumentValue { get; }
}
28 changes: 22 additions & 6 deletions src/ConsoleAppFramework/ConsoleAppBaseCode.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,24 @@ internal sealed class ConsoleAppFilterAttribute<T> : Attribute
{
}

internal sealed class ArgumentParseFailedException(string message) : Exception(message)
internal class ArgumentParseFailedException : Exception
{
public ArgumentParseFailedException(string message, string argumentName) : base(message)
{
ArgumentName = argumentName;
}

public string ArgumentName { get; }
}

internal sealed class ArgumentParseInvalidValueException : ArgumentParseFailedException
{
public ArgumentParseInvalidValueException(string message, string argumentName, string argumentValue) : base(message, argumentName)
{
ArgumentValue = argumentValue;
}

public string ArgumentValue { get; }
}

#endif
Expand Down Expand Up @@ -254,23 +270,23 @@ public static Task RunAsync(string[] args, Delegate command)

static void ThrowArgumentParseFailed(string argumentName, string value)
{
throw new ArgumentParseFailedException($"Argument '{argumentName}' failed to parse, provided value: {value}");
throw new ArgumentParseInvalidValueException($"Argument '{argumentName}' failed to parse, provided value: {value}", argumentName, value);
}

static void ThrowArgumentParseFailedEnum(Type enumType, string argumentName, string value)
{
var values = string.Join(", ", Enum.GetNames(enumType));
throw new ArgumentParseFailedException($"Argument '{argumentName}' is invalid. Provided value: {value}. Valid values: {values}");
throw new ArgumentParseInvalidValueException($"Argument '{argumentName}' is invalid. Provided value: {value}. Valid values: {values}", argumentName, value);
}

static void ThrowRequiredArgumentNotParsed(string name)
{
throw new ArgumentParseFailedException($"Required argument '{name}' was not specified.");
throw new ArgumentParseFailedException($"Required argument '{name}' was not specified.", name);
}

static void ThrowArgumentNameNotFound(string argumentName)
static void ThrowArgumentNameNotFound(string name)
{
throw new ArgumentParseFailedException($"Argument '{argumentName}' is not recognized.");
throw new ArgumentParseFailedException($"Argument '{name}' is not recognized.", name);
}

[MethodImpl(MethodImplOptions.AggressiveInlining)]
Expand Down