[aws] Add `help` subcommand

Question

[aws] Add `help` subcommand

AlanSyue opened this issue a year ago · 10 comments

AlanSyue commented a year ago

Sanity checks

My issue relates to a specific CLI completion spec (e.g. git checkout is missing options in git completion spec). If your issue is more general, please create your issue here: withfig/fig
I have searched github.com/withfig/autocomplete/issues and there are no duplicates of my issue
I would like to work on this.

What CLI tool does this relate to?

aws

Which statement makes the most sense?

This completion spec isn't complete

Issue Details

Add the help subcommand

  aws help
  aws <command> help
  aws <command> <subcommand> help

Answer 1 · 2023-06-07T10:44:38.000Z

Hi is this being worked on already ?

Answer 2 · 2023-06-07T11:23:49.000Z

@abhisht51 Nope, welcome to contribute to it😀

Answer 3 · 2023-06-08T06:46:49.000Z

@AlanSyue will be my pleasure. Will take this up

Answer 4 · 2023-06-09T05:57:03.000Z

Hi @AlanSyue, I have started work on this. Just wanted your feedback on the work since its a lot of spec addition, I would like to get it right on the first try.

Also, can you guide me on what you'd mean by aws <command> <subcommand> help because this would be super specific I am assuming?

For now, I have been tackling only. PR here

  aws help
  aws <command> help

Answer 5 · 2023-06-09T13:06:45.000Z

@abhisht51 I think it should have a feature to put help after all commands rather than set it repeatedly, but I have no idea how to do that. Maybe we should ask @fedeci .

AWS CLI allows putting help after the subcommand, you can see the demo video below:

2023-06-09.9.04.50.mov

Answer 6 · 2023-06-09T16:46:46.000Z

@AlanSyue @abhisht51, isPersistent should be the right way, but right now that property is only available for options. I can make it available for commands too later today! For the moment just assume isPersistent is available for subcommands, you can set it to true for the help subcommand and that will make it available for all children too!

ps: ignore typecheck failures and linting errors

Answer 7 · 2023-06-10T07:56:03.000Z

@fedeci I see, then I am assuming it will make my PR very short. I'd just have to set isPersistent:true to the aws.ts file's subcommand and that should be all right? If that is correct, I'd undo most of my changes and issue a new commit!

Answer 8 · 2023-06-10T11:00:53.000Z

Yes! @abhisht51

Answer 9 · 2023-06-10T11:20:17.000Z

@fedeci I have made the change but I cannot test it for child subcommand yet. Would I need to merge some changes from master ? changes here

Answer 10 · 2023-06-12T15:54:33.000Z

We should wait for the Subcommand interface to implement the isPersistent field so that we can use it to complete this feature.
https://github.com/withfig/autocomplete-tools/blob/3c5f3daae19cee8c1bbbe26d41ff19be2b03fff4/types/index.d.ts#L481