docs(custom-command): note on .PromptResponses

as `.PromptResponses` is still commonly used [as demonstrated in the command compendium](https://github.com/jesseduffield/lazygit/wiki/Custom-Commands-Compendium), it would be wise to let users know of its disadvantages
This commit is contained in:
Minh Tran 2025-04-05 14:53:26 +07:00 committed by GitHub
parent facc73a88b
commit d60d1068e2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -104,6 +104,9 @@ These fields are applicable to all prompts.
| title | The title to display in the popup panel | no |
| key | Used to reference the entered value from within the custom command. E.g. a prompt with `key: 'Branch'` can be referred to as `{{.Form.Branch}}` in the command | yes |
> [!TIP]
> Fetching `key` via `.PromptResponses` is not encouraged, see https://github.com/jesseduffield/lazygit/issues/2103
### Input
| _field_ | _description_ | _required_ |