feat: show success message after creating a flag #134
Conversation
|
This pull request has been linked to Shortcut Story #239299: show success message after creating a flag. |
internal/quickstart/create_flag.go
Outdated
| existingFlagUsed bool | ||
| flagKey string | ||
| success bool |
There was a problem hiding this comment.
these are the new fields - also storing the flag key now to pass into the view
internal/quickstart/create_flag.go
Outdated
| @@ -58,6 +61,14 @@ func (m createFlagModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) { | |||
| default: | |||
| m.textInput, cmd = m.textInput.Update(msg) | |||
| } | |||
| case createdFlagMsg: | |||
| if !m.success { | |||
There was a problem hiding this comment.
i don't love this name so open to suggestions
There was a problem hiding this comment.
Does "success" mean that the user created a new flag or tried to create an existing flag so that we would (over)write the flag key with the one from the message? Maybe instead of "success" it could be something like "shouldUpdateFlag"?
internal/quickstart/create_flag.go
Outdated
| if m.success { | ||
| successMessage := fmt.Sprintf("Flag %q created successfully!", m.flagKey) | ||
| if m.existingFlagUsed { | ||
| successMessage = fmt.Sprintf("Using existing existing flag %q for setup.", m.flagKey) |
internal/quickstart/create_flag.go
Outdated
| @@ -67,6 +78,14 @@ func (m createFlagModel) View() string { | |||
| style := lipgloss.NewStyle(). | |||
| MarginLeft(2) | |||
|
|
|||
| if m.success { | |||
| successMessage := fmt.Sprintf("Flag %q created successfully!", m.flagKey) | |||
There was a problem hiding this comment.
Should we use the flag name instead of the key since that's what the user typed? Otherwise they could be surprised if they type "my flag" and we show "my-flag." If we go that route it may be simpler to create a flag struct for the key and name instead of passing both around.
internal/quickstart/create_flag.go
Outdated
| @@ -58,6 +61,14 @@ func (m createFlagModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) { | |||
| default: | |||
| m.textInput, cmd = m.textInput.Update(msg) | |||
| } | |||
| case createdFlagMsg: | |||
| if !m.success { | |||
There was a problem hiding this comment.
Does "success" mean that the user created a new flag or tried to create an existing flag so that we would (over)write the flag key with the one from the message? Maybe instead of "success" it could be something like "shouldUpdateFlag"?
| if m.showSuccessView { | ||
| successMessage := fmt.Sprintf("Flag %q created successfully!", m.flag.name) | ||
| if m.existingFlagUsed { | ||
| successMessage = fmt.Sprintf("Using existing flag %q for setup.", m.flag.name) | ||
| } | ||
| return successMessage + " Press enter to continue." | ||
| } |
There was a problem hiding this comment.
@dbolson updated the name here - is this doing too much/do I need another message type here to pass around?
There was a problem hiding this comment.
Yeah, maybe we should have a message for when we create a new flag and one where the flag already exists.
There was a problem hiding this comment.
ah I meant for this comment to go on the Update step where I was overloading one message type, but think I've managed to fix
| if m.showSuccessView { | ||
| successMessage := fmt.Sprintf("Flag %q created successfully!", m.flag.name) | ||
| if m.existingFlagUsed { | ||
| successMessage = fmt.Sprintf("Using existing flag %q for setup.", m.flag.name) | ||
| } | ||
| return successMessage + " Press enter to continue." | ||
| } |
There was a problem hiding this comment.
ah I meant for this comment to go on the Update step where I was overloading one message type, but think I've managed to fix
internal/quickstart/create_flag.go
Outdated
| type flagDetail struct { | ||
| key string | ||
| name string | ||
| } | ||
|
|
There was a problem hiding this comment.
added new flagDetail type
| // can only go back if a flag has been created but not confirmed, | ||
| // so let the model handle the Update | ||
| m.currentModel, cmd = m.currentModel.Update(msg) |
There was a problem hiding this comment.
this is new also, to allow going back after a flag has been created (but not before)
internal/quickstart/create_flag.go
Outdated
| m.showSuccessView = true | ||
| m.existingFlagUsed = msg.existingFlagUsed | ||
| m.flag = msg.flag | ||
| return m, cmd |
There was a problem hiding this comment.
I'm not sure this needs to return early.
internal/quickstart/create_flag.go
Outdated
| @@ -14,14 +14,22 @@ import ( | |||
|
|
|||
| const defaultFlagName = "My New Flag" | |||
|
|
|||
| type flagDetail struct { | |||
There was a problem hiding this comment.
We could probably only need to call this flag.
k3llymariee
deleted the
kelly/sc-239299/show-success-message-after-creating-a-flag
branch
Adds an interstitial step to show the user that either a new flag was created, or an existing one was used, during the first step of the setup command.