Allow to define summary for flag options. #756
Labels
--help output
Related to --help output
unlikely
Feature we are unlikely to implement
waiting for interest
Waiting to see if there's strong community interest
Is your feature request related to a problem? Please describe.
If you have a command with a flag that accepts a set of options like this:
https://github.com/salesforcecli/plugin-deploy-retrieve/blob/cf94d9b10d1256e9cad96f75df3452094b9d4865/src/commands/project/deploy/start.ts#L121
you get those in zsh/powershell completion but plugin-autocomplete can't show any summary/description about them:
Describe the solution you'd like
![Screenshot 2023-08-04 at 14 47 48](https://private-user-images.githubusercontent.com/6853656/258494048-461988d6-30e7-4e19-9aa0-cbbe604a0ca8.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkwMDY4MzksIm5iZiI6MTczOTAwNjUzOSwicGF0aCI6Ii82ODUzNjU2LzI1ODQ5NDA0OC00NjE5ODhkNi0zMGU3LTRlMTktOWFhMC1jYmJlNjA0YTBjYTgucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIwOCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMDhUMDkyMjE5WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9NmYxOTI2ODQ1MzJlMjllMmE5MmZiNDVmOWVlMmM2OGQ5ZWQ0ODExMDM1MDYwYjk1ZmIzNzU0NjRjMmVlZTQxMyZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.jWSkrfXNZ0x08lAXRj5pigXFuwtlZs20gM8XsNl_pQA)
Allow to define a summary for each flag option so that plugin-autocomplete can set it in completion functions (natively supported):
Describe alternatives you've considered
make
flag.options
an object containing one 1 object per optionAdditional context
We could also update the help logic so that it renders these summaries, in
sf
we just add all of them in the flag summary:https://github.com/salesforcecli/plugin-deploy-retrieve/blob/cf94d9b10d1256e9cad96f75df3452094b9d4865/messages/deploy.metadata.md#flagstest-leveldescription
The text was updated successfully, but these errors were encountered: