Add condition field to custom command prompts#5364
Open
mrt181 wants to merge 1 commit intojesseduffield:masterfrom
Open
Add condition field to custom command prompts#5364mrt181 wants to merge 1 commit intojesseduffield:masterfrom
mrt181 wants to merge 1 commit intojesseduffield:masterfrom
Conversation
mrt181
force-pushed
the
add-conditional-prompts
branch
from
cfd9c66 to
e934c7c
Compare
mrt181
force-pushed
the
add-conditional-prompts
branch
from
e934c7c to
4040756
Compare
mrt181
force-pushed
the
add-conditional-prompts
branch
2 times, most recently
from
78c0266 to
a51be39
Compare
When building multi-step custom command forms, some prompts are only relevant depending on earlier answers. Without conditional logic, users must dismiss irrelevant prompts manually. Prompts now accept a `condition` field with a template expression evaluated against prior form values. Skipped prompts default to an empty string.
mrt181
force-pushed
the
add-conditional-prompts
branch
from
a51be39 to
b117f12
Compare
Collaborator
stefanhaller
left a comment
stefanhaller
left a comment
There was a problem hiding this comment.
Thanks, looks reasonable overall. A few things below.
| if resolved { | ||
| return showPrompt() | ||
| } | ||
| if _, exists := form[prompt.Key]; !exists { |
Collaborator
There was a problem hiding this comment.
Why do we need the !exists condition here? How can form[prompt.Key] be set when we get here, and why would we want to keep its value in that case?
| expr = strings.TrimPrefix(expr, "{{") | ||
| expr = strings.TrimSuffix(expr, "}}") | ||
| } | ||
| ifTemplate := fmt.Sprintf("{{ if %s }}1{{ end }}", expr) |
Collaborator
There was a problem hiding this comment.
I'm not an expert at go templates, but this looks really hacky to me. Isn't there a cleaner way to evaluate a boolean template expression?
| | type | One of 'input', 'confirm', 'menu', 'menuFromCommand' | yes | | ||
| | 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 | | ||
| | condition | A Go template expression; if it resolves to empty string or `false`, the prompt is skipped. See [Conditional prompts](#conditional-prompts) | no | |
Collaborator
There was a problem hiding this comment.
All changes in this file need to be moved to docs-master.
Comment on lines
+238
to
+244
| }, | ||
| "condition": { | ||
| "type": "string", | ||
| "description": "A Go template expression evaluated against the current form state. If it resolves to empty string or 'false', the prompt is skipped.", | ||
| "examples": [ | ||
| "{{ eq .Form.Choice \"yes\" }}" | ||
| ] |
Collaborator
There was a problem hiding this comment.
This shouldn't be here, we only want to touch schema-master/config.json. Also, we never manually edit it; if you want examples to appear in the schema, you need to add jsonschema:"example=..." to the entry in user_config.go.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When building multi-step custom command forms, some prompts are only relevant depending on earlier answers. Without conditional logic, users must dismiss irrelevant prompts manually.
Prompts now accept a
conditionfield with a template expression evaluated against prior form values. Skipped prompts default to an empty string.PR Description
Please check if the PR fulfills these requirements
go generate ./...)