Questions about undocumented Option.Action vs Command.SetAction

[joshuapetryk]

Hello - I am trying to familiarize myself with this library and I noticed Option.Action https://github.com/dotnet/command-line-api/blob/main/src/System.CommandLine/Option.cs#L131 but it is not documented anywhere (as far as I can tell) in the MSDN docs here: https://learn.microsoft.com/en-us/dotnet/standard/commandline/

Is this feature deprecated? If not - are there examples anywhere of how it can/should be used?

I find it confusing when compared to the well documented Command.SetAction() examples - are these two action delegate systems at odds or complimentary?

[joshuapetryk]

I see @jalfd has opened several issues as well regarding Option actions #2772 #2771 #2768 - perhaps this indicates option actions are not the way forward?

[KalleOlaviNiemitalo]

There is API reference at https://learn.microsoft.com/en-us/dotnet/api/system.commandline.option.action?view=net-10.0-pp.

You could set Option.Action to customise what HelpOption or VersionOption does.

[jalfd]

perhaps this indicates option actions are not the way forward?

For what it's worth, I do find Option actions to be quite convenient (aside from the bugs I've reported) because they allow me to centralize the code for each option: you can create the Option, populate it and attach an action to it which, when invoked, sets the corresponding properties on your app's Config object, and the whole thing is easily wrapped in a single helper function.

But at the moment they do feel a bit like an afterthought

[jonsequitur]

They're not an afterthought but they were added late with the goal of making --help and --verbose fully supportable by the public API rather than special cases. Aside from the lack of a SetAction method, are the other reasons you feel like the feature is incomplete?

[joshuapetryk]

I'm mostly looking for examples on how to implement it. It's not covered in the docs and typed as an abstract class rather than a delegate so how would I write an action for it? And how would that action be invoked in relation to the command's action? Before? After?

Is there some way to set, read, or pass data/results from option action to command action?

Lots of questions around intended behavior.

[KalleOlaviNiemitalo]

It's not covered in the docs and typed as an abstract class rather than a delegate so how would I write an action for it?

Derive your own class from either SynchronousCommandLineAction (and override Invoke) or AsynchronousCommandLineAction (and override InvokeAsync).