refactor(experiment): separate huh and lipgloss changes of charm #411
+168
−128
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,19 +14,29 @@ | |
|
|
||
| package iostreams | ||
|
Member
There was a problem hiding this comment. question: Long-term, is there a more appropriate filename than
Member
Author
There was a problem hiding this comment. @mwbrooks I share this feeling. The terms "charm" or "huh" or "lipgloss" are meaningful for package imports but we might want to refactor this into a different packages once experiments conclude:
I'm not against
Member
There was a problem hiding this comment.
Member
Author
There was a problem hiding this comment. @mwbrooks Cool cool! I'll hold off on changing that for another PR but it might be a good step toward the conclusions of |
||
|
|
||
| // Charm-based prompt implementations using the huh library. | ||
| // These are used when the "huh" experiment is enabled. | ||
|
|
||
| import ( | ||
| "context" | ||
| "slices" | ||
|
|
||
| huh "charm.land/huh/v2" | ||
| "github.com/slackapi/slack-cli/internal/experiment" | ||
| "github.com/slackapi/slack-cli/internal/style" | ||
| ) | ||
|
|
||
| // newForm wraps a field in a huh form, applying the Slack theme when the lipgloss experiment is enabled. | ||
| func newForm(io *IOStreams, field huh.Field) *huh.Form { | ||
| form := huh.NewForm(huh.NewGroup(field)) | ||
| if io != nil && io.config.WithExperimentOn(experiment.Lipgloss) { | ||
| form = form.WithTheme(style.ThemeSlack()) | ||
| } | ||
| return form | ||
| } | ||
|
|
||
| // buildInputForm constructs a huh form for text input prompts. | ||
| func buildInputForm(io *IOStreams, message string, cfg InputPromptConfig, input *string) *huh.Form { | ||
| field := huh.NewInput(). | ||
| Title(message). | ||
| Prompt(style.Chevron() + " "). | ||
|
|
@@ -35,39 +45,39 @@ func buildInputForm(message string, cfg InputPromptConfig, input *string) *huh.F | |
| if cfg.Required { | ||
| field.Validate(huh.ValidateMinLength(1)) | ||
| } | ||
| return newForm(io, field) | ||
| } | ||
|
|
||
| // charmInputPrompt prompts for text input using a charm huh form | ||
| func charmInputPrompt(io *IOStreams, _ context.Context, message string, cfg InputPromptConfig) (string, error) { | ||
| var input string | ||
| err := buildInputForm(io, message, cfg, &input).Run() | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| return input, nil | ||
| } | ||
|
|
||
| // buildConfirmForm constructs a huh form for yes/no confirmation prompts. | ||
| func buildConfirmForm(io *IOStreams, message string, choice *bool) *huh.Form { | ||
| field := huh.NewConfirm(). | ||
| Title(message). | ||
| Value(choice) | ||
| return newForm(io, field) | ||
| } | ||
|
|
||
| // charmConfirmPrompt prompts for a yes/no confirmation using a charm huh form | ||
| func charmConfirmPrompt(io *IOStreams, _ context.Context, message string, defaultValue bool) (bool, error) { | ||
| var choice = defaultValue | ||
| err := buildConfirmForm(io, message, &choice).Run() | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
| return choice, nil | ||
| } | ||
|
|
||
| // buildSelectForm constructs a huh form for single-selection prompts. | ||
| func buildSelectForm(io *IOStreams, msg string, options []string, cfg SelectPromptConfig, selected *string) *huh.Form { | ||
| var opts []huh.Option[string] | ||
| for _, opt := range options { | ||
| key := opt | ||
|
|
@@ -85,13 +95,13 @@ func buildSelectForm(msg string, options []string, cfg SelectPromptConfig, selec | |
| Options(opts...). | ||
| Value(selected) | ||
|
|
||
| return newForm(io, field) | ||
| } | ||
|
|
||
| // charmSelectPrompt prompts the user to select one option using a charm huh form | ||
| func charmSelectPrompt(io *IOStreams, _ context.Context, msg string, options []string, cfg SelectPromptConfig) (SelectPromptResponse, error) { | ||
| var selected string | ||
| err := buildSelectForm(io, msg, options, cfg, &selected).Run() | ||
| if err != nil { | ||
| return SelectPromptResponse{}, err | ||
| } | ||
|
|
@@ -101,7 +111,7 @@ func charmSelectPrompt(_ *IOStreams, _ context.Context, msg string, options []st | |
| } | ||
|
|
||
| // buildPasswordForm constructs a huh form for password (hidden input) prompts. | ||
| func buildPasswordForm(io *IOStreams, message string, cfg PasswordPromptConfig, input *string) *huh.Form { | ||
| field := huh.NewInput(). | ||
| Title(message). | ||
| Prompt(style.Chevron() + " "). | ||
|
|
@@ -110,21 +120,21 @@ func buildPasswordForm(message string, cfg PasswordPromptConfig, input *string) | |
| if cfg.Required { | ||
| field.Validate(huh.ValidateMinLength(1)) | ||
| } | ||
| return newForm(io, field) | ||
| } | ||
|
|
||
| // charmPasswordPrompt prompts for a password (hidden input) using a charm huh form | ||
| func charmPasswordPrompt(io *IOStreams, _ context.Context, message string, cfg PasswordPromptConfig) (PasswordPromptResponse, error) { | ||
| var input string | ||
| err := buildPasswordForm(io, message, cfg, &input).Run() | ||
| if err != nil { | ||
| return PasswordPromptResponse{}, err | ||
| } | ||
| return PasswordPromptResponse{Prompt: true, Value: input}, nil | ||
| } | ||
|
|
||
| // buildMultiSelectForm constructs a huh form for multiple-selection prompts. | ||
| func buildMultiSelectForm(io *IOStreams, message string, options []string, selected *[]string) *huh.Form { | ||
| var opts []huh.Option[string] | ||
| for _, opt := range options { | ||
| opts = append(opts, huh.NewOption(opt, opt)) | ||
|
|
@@ -135,13 +145,13 @@ func buildMultiSelectForm(message string, options []string, selected *[]string) | |
| Options(opts...). | ||
| Value(selected) | ||
|
|
||
| return newForm(io, field) | ||
| } | ||
|
|
||
| // charmMultiSelectPrompt prompts the user to select multiple options using a charm huh form | ||
| func charmMultiSelectPrompt(io *IOStreams, _ context.Context, message string, options []string) ([]string, error) { | ||
| var selected []string | ||
| err := buildMultiSelectForm(io, message, options, &selected).Run() | ||
| if err != nil { | ||
| return []string{}, err | ||
| } | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👌🏻