-v flag conflict between additional commands and default command

[BCoskun]

Information

• V0.47 and 0.48 behavior change for -v flag.

Describe the bug I was using -v short hand flag for sub command and it was working until V0.48 . With Version 0.48 parsing behavior changed and when we use -v for subcommand, it print application version directly.

To Reproduce With Version 0.47 ConsoleApp.exe -v and ConsoleApp.exe subcommand -v has different behavior. With Version 0.48 ConsoleApp.exe -v and ConsoleApp.exe subcommand -v has same behavior.

Expected behavior The sub command -v should be parsed for the sub command context

---

Please upvote :+1: this issue if you are interested in it.

[JKamsker]

Can you provide an unit test for this? This would help understanding the problem and having a definition of "done"

Similar bug in the past https://github.com/spectreconsole/spectre.console/issues/1400 My issue probably caused this change 😅

I guess there is no absolute right answer, and if it is it is harder to do than it may first look like

[FrankRay78]

I introduced the bug @JKamsker, unfortunately. I knew it was a breaking change, and flagged it as such, but I think the change in functionality is probably now best described as a regression. I'll add this to my stack to review/address.

https://github.com/spectreconsole/spectre.console/issues/1400#issuecomment-1866784986

And

FYI. I've submitted the PR above to revert this to existing behaviour @JKamsker

https://github.com/spectreconsole/spectre.console/issues/1400#issuecomment-1879765957

Background Apologies for creating this problem. The above issue description is exactly correct, we changed this behaviour between 0.47 and 0.48.

It had worked as per the current 0.48 earlier than 0.47, then I did some refactoring, changed it to the behaviour in 0.47, flagged it as a breaking change (thinking it was fine to make breaking changes, if warranted, as we are still < version 1.0), which was accepted by the maintainer team and merged.

Then we found a number of unhappy users of spectre.console (because we broke their apps), and so on further consideration, we reverted the change. Unfortunately, I doubt we'd be looking to revert it once again.

[FrankRay78]

This appears fixed in 0.49.1 @BCoskun

I've created the following console application to test the behaviour:

using Spectre.Console;
using Spectre.Console.Cli;
using System.ComponentModel;

public class HelloCommandSettings : CommandSettings
{
    [CommandOption("-v|--version")]
    [DefaultValue("Hello world")]
    public string Message { get; set; }
}

public class HelloCommand : Command<HelloCommandSettings>
{
    public override int Execute(CommandContext context, HelloCommandSettings settings)
    {
        AnsiConsole.MarkupLine(settings.Message);
        return 0;
    }
}

public static class Program
{
    public static int Main(string[] args)
    {
        var app = new CommandApp();

        app.Configure(config =>
        {
            config.AddCommand<HelloCommand>("hello");
        });

        return app.Run(args);
    }

Behaviour under different spectre.console versions

0.47

0.48

0.49.1

[FrankRay78]

There is still a bug, however, as when I add in the application version using the following configuration line:

            config.SetApplicationVersion("1.0");

The help text for the hello command erroneously includes the -v, --version associated at the application root:

At least the application behaviour is now functioning correctly.

[FrankRay78]

Hey @JKamsker, if you have a minute, I'd love to hear your thoughts on the following test I'm authoring to address this issue, particularly the explanation given in the summary:

            /// <summary>
            /// When a command with a version flag in the settings is set as the application default command,
            /// then override the in-built Application Version flag with the command version flag instead.
            /// Rationale: This behaviour makes the most sense because the other flags for the default command
            /// will be shown in the help output and the user can set any of these when executing the application.
            /// </summary>
            [Theory]
            [InlineData("-?")]
            [InlineData("-h")]
            [InlineData("--help")]
            public void Help_Should_Include_Command_Version_Flag_For_Default_Command(string helpOption)
            {
                // Given
                var fixture = new CommandAppTester();
                fixture.SetDefaultCommand<Spectre.Console.Tests.Data.VersionCommand>();
                fixture.Configure(configurator =>
                {
                    configurator.SetApplicationVersion("1.0");
                });

                // When
                var result = fixture.Run(helpOption);

                // Then
                result.Output.ShouldContain("-v, --version    The command version");
                result.Output.ShouldNotContain("-v, --version    Prints version information");
            }