Skip to content

Add multi char support for short names in cli options #74

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

Merged
darthsharp merged 3 commits into from
Jan 31, 2026
Merged

Add multi char support for short names in cli options #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd7841c
Enhance `OptionParameterAttribute` to support multi-character short n…
darthsharp Jan 31, 2026
36df934
Add test case for parsing CLI options with multi-character and single…
darthsharp Jan 31, 2026
30c7f8c
Ensure non-null values for constructor parameters in `OptionParameter…
darthsharp Jan 31, 2026
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
17 changes: 12 additions & 5 deletions source/SysConsole/CreativeCoders.SysConsole.Cli.Parsing/OptionParameterAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System;
using CreativeCoders.Core;
using JetBrains.Annotations;

namespace CreativeCoders.SysConsole.Cli.Parsing;
Expand All @@ -7,23 +8,29 @@ namespace CreativeCoders.SysConsole.Cli.Parsing;
[AttributeUsage(AttributeTargets.Property)]
public sealed class OptionParameterAttribute : OptionBaseAttribute
{
public OptionParameterAttribute(string shortName, string longName)
{
Comment thread
darthsharp marked this conversation as resolved.
ShortName = Ensure.IsNotNullOrWhitespace(shortName);
LongName = Ensure.IsNotNullOrWhitespace(longName);
}

public OptionParameterAttribute(char shortName, string longName)
{
ShortName = shortName;
LongName = longName;
ShortName = shortName.ToString();
LongName = Ensure.IsNotNullOrWhitespace(longName);
}

public OptionParameterAttribute(char shortName)
{
ShortName = shortName;
ShortName = shortName.ToString();
}

public OptionParameterAttribute(string longName)
{
LongName = longName;
LongName = Ensure.IsNotNullOrWhitespace(longName);
}

public char? ShortName { get; }
public string? ShortName { get; }

public string? LongName { get; }
}
18 changes: 8 additions & 10 deletions ...Console/CreativeCoders.SysConsole.Cli.Parsing/OptionProperties/OptionParameterProperty.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using CreativeCoders.Core;

namespace CreativeCoders.SysConsole.Cli.Parsing.OptionProperties;

public class OptionParameterProperty : OptionPropertyBase
public class OptionParameterProperty(
PropertyInfo propertyInfo,
OptionParameterAttribute optionParameterAttribute)
: OptionPropertyBase(propertyInfo, optionParameterAttribute)
{
private readonly OptionParameterAttribute _optionParameterAttribute;

public OptionParameterProperty(PropertyInfo propertyInfo,
OptionParameterAttribute optionParameterAttribute)
: base(propertyInfo, optionParameterAttribute)
{
_optionParameterAttribute = optionParameterAttribute;
}
private readonly OptionParameterAttribute _optionParameterAttribute =
Ensure.NotNull(optionParameterAttribute);

public override bool Read(IEnumerable<OptionArgument> optionArguments, object optionObject)
{
var optionArgument = optionArguments
.FirstOrDefault(x =>
(x.Kind == OptionArgumentKind.ShortName
&& x.OptionName == _optionParameterAttribute.ShortName.ToString()) ||
&& x.OptionName == _optionParameterAttribute.ShortName) ||
(x.Kind == OptionArgumentKind.LongName &&
x.OptionName == _optionParameterAttribute.LongName));

Expand Down
72 changes: 60 additions & 12 deletions tests/CreativeCoders.SysConsole.Cli.Parsing.UnitTests/OptionParserTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public void Parse_ValueAndParameterWithLongName_PropertiesAreSetCorrect()
.Should()
.NotBeNull();

option!.HelloWorld
option.HelloWorld
.Should()
.Be("hello");

Expand All @@ -48,7 +48,7 @@ public void Parse_ValueAndParameterWithShortName_PropertiesAreSetCorrect()
.Should()
.NotBeNull();

option!.HelloWorld
option.HelloWorld
.Should()
.Be("hello");

Expand All @@ -57,6 +57,54 @@ public void Parse_ValueAndParameterWithShortName_PropertiesAreSetCorrect()
.Be("TestText");
}

[Fact]
public void Parse_ValueAndParameterWithMultiCharShortName_PropertiesAreSetCorrect()
{
var args = new[] { "hello", "-te", "TestText" };

var parser = new OptionParser(typeof(TestOptionForParser));

// Act
var option = parser.Parse(args) as TestOptionForParser;

// Assert
option
.Should()
.NotBeNull();

option.HelloWorld
.Should()
.Be("hello");

option.TextValueMultiCharShortName
.Should()
.Be("TestText");
}
Comment thread
darthsharp marked this conversation as resolved.

[Fact]
public void Parse_ValueAndParameterWithMultiCharShortNameAndSingleChar_PropertiesAreSetCorrect()
{
var args = new[] { "hello", "-te", "TestText", "-t", "ShotText" };

var parser = new OptionParser(typeof(TestOptionForParser));

// Act
var option = parser.Parse(args) as TestOptionForParser;

// Assert
option
.Should().NotBeNull();

option.HelloWorld
.Should().Be("hello");

option.TextValue
.Should().Be("ShotText");

option.TextValueMultiCharShortName
.Should().Be("TestText");
}

[Fact]
public void Parse_IntValueAndParameterWithLongName_PropertiesAreSetCorrect()
{
Expand All @@ -76,7 +124,7 @@ public void Parse_IntValueAndParameterWithLongName_PropertiesAreSetCorrect()
.Should()
.NotBeNull();

option!.IntValue
option.IntValue
.Should()
.Be(expectedValue0);

Expand All @@ -103,7 +151,7 @@ public void Parse_IntValueAndParameterWithShortName_PropertiesAreSetCorrect()
.Should()
.NotBeNull();

option!.IntValue
option.IntValue
.Should()
.Be(expectedValue0);

Expand Down Expand Up @@ -158,7 +206,7 @@ public void Parse_BoolValues_PropertiesAreSetCorrect()
.Should()
.NotBeNull();

option!.Verbose
option.Verbose
.Should()
.BeTrue();

Expand All @@ -182,7 +230,7 @@ public void Parse_BoolValuesInvalidFormat_PropertyIsSetFalse()
.Should()
.NotBeNull();

option!.Verbose
option.Verbose
.Should()
.BeTrue();

Expand Down Expand Up @@ -232,7 +280,7 @@ public void Parse_ValueDefaultValue_DefaultValueIsSet()
.Should()
.NotBeNull();

options!.FirstValue
options.FirstValue
.Should()
.Be(null);

Expand Down Expand Up @@ -307,7 +355,7 @@ public void Parse_EnumValue_PropertyIsSetCorrect(string argValue, TestEnum enumV
.Should()
.NotBeNull();

option!.EnumValue
option.EnumValue
.Should()
.Be(enumValue);
}
Expand All @@ -331,7 +379,7 @@ public void Parse_PropertyWithConverter_PropertyIsSetCorrect(string argValue, st
.Should()
.NotBeNull();

option!.Text
option.Text
.Should()
.Be(propertyValue);
}
Expand All @@ -355,7 +403,7 @@ public void Parse_PropertyIsIEnumerableOfInt_PropertyIsSetCorrect(string argValu
.Should()
.NotBeNull();

option!.IntValues
option.IntValues
.Should()
.ContainInOrder(intValues);
}
Expand All @@ -379,7 +427,7 @@ public void Parse_PropertyIsEnumWithFlags_EnumFlagsAreSetCorrect(string argValue
.Should()
.NotBeNull();

option!.EnumValue
option.EnumValue
.Should()
.Be(enumWithFlags);
}
Expand All @@ -406,7 +454,7 @@ public void Parse_NotAllArgsMatch_ThrowsException(params string[] args)
.Should()
.HaveCount(1)
.And
.BeEquivalentTo(new[] { new OptionArgument { Kind = OptionArgumentKind.Value, Value = "test" } });
.BeEquivalentTo([new OptionArgument { Kind = OptionArgumentKind.Value, Value = "test" }]);
}

[Theory]
Expand Down
2 changes: 2 additions & 0 deletions tests/CreativeCoders.SysConsole.Cli.Parsing.UnitTests/TestData/TestOptionForParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,6 @@ public class TestOptionForParser
[OptionValue(0)] public string? HelloWorld { get; [UsedImplicitly] set; }

[OptionParameter('t', "text")] public string? TextValue { get; [UsedImplicitly] set; }

[OptionParameter("te", "text2")] public string? TextValueMultiCharShortName { get; [UsedImplicitly] set; }
}