Displaying help documention about powerargs HOT 7 CLOSED

For question 1, yes, but not yet. The next update I publish will add a [HelpHook] attribute to your help property (more on that below). I added this in part because of your question (thanks). I will probably publish within a couple of weeks. I'll leave this issue open until then.

For question 2, boolean properties already work that way.

If the user doesn't specify '-help' at all then the Help Property will have a value of false.
If the user types '-help' then it will have a value of true.
If the user types '-help true' then it will have a value of true.
If the user types '-help false' then it will have a value of false.

If you use the new [HelpHook] I talk about above then whenever the user indicates 'true' for the help property then it will not only have a value of true, but it will stop processing so the system does not try to invoke an action. It will finally print the help automatically for you (which you can turn off if you want to print it yourself).

from powerargs.

Looks good!

Is there a way though, that you could change the context if an action is specified?

e.g.

superencoder -help

Writes the full usage text - context = SuperEncoderArgs

superencoder encode -help

Only writes the usage text of EncoderArgs, not SuperEncoderArgs

superencoder clip -help

Similarly, only writes the usage text of ClipArgs.

from powerargs.

That's a good idea for a feature. I've thought of it before, but nobody asked for it until now. Let's leave this issue open until I can get to it.

from powerargs.

Looking at how git behaves, I wonder if the behaviour could be:

superencoder -help

Shows the list of Actions and their ArgDescriptions only ([Optionally or otherwise] does not recursively drill down into their properties)

superencoder encode -help

Shows the usage text of EncodeArgs, as mentioned before.

What do you think?

from powerargs.

Sorry for the delay. I think that sounds good. Another person opened a similar issue recently. Hopefully I can get to this soon.

from powerargs.

This is now working. Below is an example that shows how to manually use the usage API to set the specified action in the context of an exception. The default exception behavior now works like you asked in your last message. That is, if you're using the Args.InvokeAction() method, and you are using the [ArgExceptionBehavior(ArgExceptionPolicy.StandardExceptionHandling)] attribute on your main class then by default only the action specific usage will be printed when the error is in the context of an action. I'll leave the issue open until the next NuGet publish,

    public void TestActionSpecificUsage()
    {
        try
        {
            Args.InvokeAction<ArgsForActionSpecificUsage>("Foo");
        }
        catch (ArgException ex)
        {
            var usage = ArgUsage.GetStyledUsage<ArgsForActionSpecificUsage>("test", new ArgUsageOptions()
            {
                SpecifiedActionOverride = ex.Context.SpecifiedAction
            });
            Assert.IsTrue(usage.Contains("Foo"));
            Assert.IsFalse(usage.Contains("Bar"));
        }
    }

from powerargs.

Fixed

from powerargs.