feat: Refactor Part3 (#7)

* feat: Refactor Part3

* feat: Refactor Part3

Author: shipengqi

internal/render/template.go

@@ -44,6 +44,7 @@ type Template struct {
 }
 
 type model struct {
+	t     string
 	name  string
 	model ui.Model
 }
@@ -69,10 +70,21 @@ func (t *Template) Run() ([]byte, error) {
 
 	values := map[string]interface{}{}
 	for _, v := range t.models {
-		if _, err := tea.NewProgram(v.model).Run(); err != nil {
+		if _, err = tea.NewProgram(v.model).Run(); err != nil {
 			return nil, err
 		}
-		values[v.name] = v.model.Value()
+		if v.model.Canceled() {
+			return nil, errors.New("canceled")
+		}
+		val := v.model.Value()
+		// hardcode for the select options
+		if v.t == TypeSelect {
+			tokens := strings.Split(val, ":")
+			if len(tokens) > 0 {
+				val = tokens[0]
+			}
+		}
+		values[v.name] = val
 	}
 
 	tmpl, err := template.New("cz").Parse(t.Format)
@@ -114,9 +126,10 @@ func (t *Template) init() error {
 		case TypeTextArea:
 			m = t.createTextAreaItem(item.Name, item.Desc, item.Required)
 		default:
-			return errors.New("unsupported item.type")
+			return fmt.Errorf("unsupported type: %s", item.Type)
 		}
 		t.models = append(t.models, model{
+			t:     item.Type,
 			name:  item.Name,
 			model: m,
 		})
@@ -138,15 +151,15 @@ func (t *Template) createInputItem(name, label string, required bool) *ui.InputM
 	if required {
 		m.WithValidateFunc(NotBlankValidator(name))
 	}
-	return ui.NewInput(label)
+	return m
 }
 
 func (t *Template) createTextAreaItem(name, label string, required bool) *ui.TextAreaModel {
 	m := ui.NewTextArea(label)
 	if required {
 		m.WithValidateFunc(NotBlankValidator(name))
 	}
-	return ui.NewTextArea(label)
+	return m
 }
 
 // NotBlankValidator is a verification function that checks whether the input is empty

internal/ui/help.go

@@ -0,0 +1,35 @@
+package ui
+
+import "github.com/charmbracelet/bubbles/key"
+
+// keyMap defines a set of keybindings. To work for help it must satisfy
+// key.Map. It could also very easily be a map[string]key.Binding.
+type keyMap struct {
+	Save key.Binding
+	Quit key.Binding
+}
+
+// ShortHelp returns keybindings to be shown in the mini help view. It's part
+// of the key.Map interface.
+func (k keyMap) ShortHelp() []key.Binding {
+	return []key.Binding{k.Save, k.Quit}
+}
+
+// FullHelp returns keybindings for the expanded help view. It's part of the
+// key.Map interface.
+func (k keyMap) FullHelp() [][]key.Binding {
+	return [][]key.Binding{
+		{k.Save, k.Quit}, // first column
+	}
+}
+
+var helpKeys = keyMap{
+	Save: key.NewBinding(
+		key.WithKeys("ctrl+q"),
+		key.WithHelp("ctrl+q", "save"),
+	),
+	Quit: key.NewBinding(
+		key.WithKeys("ctrl+c"),
+		key.WithHelp("ctrl+c", "quit"),
+	),
+}

internal/ui/select.go

@@ -10,15 +10,12 @@ import (
 	"github.com/charmbracelet/lipgloss"
 )
 
-const listHeight = 14
-
 var (
 	titleStyle        = lipgloss.NewStyle()
 	itemStyle         = lipgloss.NewStyle().PaddingLeft(4)
 	selectedItemStyle = lipgloss.NewStyle().PaddingLeft(2).Foreground(lipgloss.Color("170"))
 	paginationStyle   = list.DefaultStyles().PaginationStyle.PaddingLeft(4)
 	helpStyle         = list.DefaultStyles().HelpStyle.PaddingBottom(1)
-	quitTextStyle     = lipgloss.NewStyle().Margin(1, 0, 2, 2)
 )
 
 type Choices []Choice
@@ -67,6 +64,7 @@ type SelectModel struct {
 	label    string
 	choice   string
 	finished bool
+	canceled bool
 	err      error
 
 	list list.Model
@@ -109,6 +107,7 @@ func (m *SelectModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 	case tea.KeyMsg:
 		switch keypress := tmsg.String(); keypress {
 		case "q", "ctrl+c":
+			m.canceled = true
 			return m, tea.Quit
 		case "enter":
 			i, ok := m.list.SelectedItem().(Choice)
@@ -129,11 +128,20 @@ func (m *SelectModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 
 func (m *SelectModel) View() string {
 	if m.choice != "" {
-		return quitTextStyle.Render(fmt.Sprintf("%s\n%s", m.label, m.choice))
+		return fmt.Sprintf(
+			"%s %s\n%s\n",
+			FontColor(DefaultValidateOkPrefix, colorValidateOk),
+			m.label,
+			quitValueStyle.Render(fmt.Sprintf(m.Value())),
+		)
 	}
 	return "\n" + m.list.View()
 }
 
 func (m *SelectModel) Value() string {
 	return m.choice
 }
+
+func (m *SelectModel) Canceled() bool {
+	return m.canceled
+}

internal/ui/textarea.go

@@ -2,11 +2,15 @@ package ui
 
 import (
 	"fmt"
-
+	"github.com/charmbracelet/bubbles/help"
+	"github.com/charmbracelet/bubbles/key"
 	"github.com/charmbracelet/bubbles/textarea"
 	tea "github.com/charmbracelet/bubbletea"
+	"github.com/charmbracelet/lipgloss"
 )
 
+var quitValueStyle = lipgloss.NewStyle().Margin(0, 0, 0, 2)
+
 type TextAreaModel struct {
 	label    string
 	canceled bool
@@ -25,7 +29,9 @@ type TextAreaModel struct {
 	// validateErrPrefix is the prompt prefix when the verification is successful
 	validateErrPrefix string
 
-	input textarea.Model
+	helpKeys keyMap
+	help     help.Model
+	input    textarea.Model
 }
 
 func NewTextArea(label string) *TextAreaModel {
@@ -37,6 +43,8 @@ func NewTextArea(label string) *TextAreaModel {
 	return &TextAreaModel{
 		input:             ti,
 		label:             label,
+		helpKeys:          helpKeys,
+		help:              help.New(),
 		validateFunc:      DefaultValidateFunc,
 		validateOkPrefix:  DefaultValidateOkPrefix,
 		validateErrPrefix: DefaultValidateErrPrefix,
@@ -90,13 +98,13 @@ func (m *TextAreaModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 	var cmd tea.Cmd
 
 	switch tmsg := msg.(type) {
+	case tea.WindowSizeMsg:
+		// If we set a width on the help menu it can gracefully truncate
+		// its view as needed.
+		m.help.Width = tmsg.Width
 	case tea.KeyMsg:
-		switch tmsg.Type {
-		case tea.KeyEsc:
-			if m.input.Focused() {
-				m.input.Blur()
-			}
-		case tea.KeyCtrlJ:
+		switch {
+		case key.Matches(tmsg, m.helpKeys.Save):
 			// If the real-time verification function does not return an error,
 			// then the input has been completed
 			if m.err == nil {
@@ -105,10 +113,14 @@ func (m *TextAreaModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 			}
 			// If there is a verification error, the error message should be display
 			m.showErr = true
-		case tea.KeyCtrlC:
+		case key.Matches(tmsg, m.helpKeys.Quit):
 			m.canceled = true
 			return m, tea.Quit
-		case tea.KeyRunes:
+		case tmsg.Type == tea.KeyEsc:
+			if m.input.Focused() {
+				m.input.Blur()
+			}
+		case tmsg.Type == tea.KeyRunes:
 			// Hide verification failure message when entering content again
 			m.showErr = false
 			m.err = nil
@@ -133,7 +145,7 @@ func (m *TextAreaModel) View() string {
 			"%s %s\n%s\n",
 			FontColor(m.validateOkPrefix, colorValidateOk),
 			m.label,
-			m.Value(),
+			quitValueStyle.Render(fmt.Sprintf(m.Value())),
 		)
 	}
 
@@ -143,6 +155,7 @@ func (m *TextAreaModel) View() string {
 	}
 
 	var showMsg, errMsg string
+	helpView := m.help.View(m.helpKeys)
 	if m.err != nil {
 		showMsg = fmt.Sprintf(
 			"%s %s\n%s",
@@ -156,10 +169,11 @@ func (m *TextAreaModel) View() string {
 		}
 	} else {
 		showMsg = fmt.Sprintf(
-			"%s %s\n%s",
+			"%s %s\n%s\n%s",
 			FontColor(m.validateOkPrefix, colorValidateOk),
 			m.label,
 			m.input.View(),
+			helpStyle.Render(helpView),
 		)
 	}
 

internal/ui/textinput.go

@@ -126,7 +126,7 @@ func (m *InputModel) View() string {
 				"%s %s\n%s\n",
 				FontColor(m.validateOkPrefix, colorValidateOk),
 				m.label,
-				m.Value(),
+				quitValueStyle.Render(m.Value()),
 			)
 		case textinput.EchoNone:
 			return fmt.Sprintf(
@@ -139,7 +139,7 @@ func (m *InputModel) View() string {
 				"%s %s\n%s\n",
 				FontColor(m.validateOkPrefix, colorValidateOk),
 				m.label,
-				GenMask(len([]rune(m.Value()))),
+				quitValueStyle.Render(GenMask(len([]rune(m.Value())))),
 			)
 		}
 	}

internal/ui/types.go

@@ -10,6 +10,7 @@ type Model interface {
 	tea.Model
 
 	Value() string
+	Canceled() bool
 }
 
 // EchoMode sets the input behavior of the text input field.
@@ -33,7 +34,7 @@ const (
 	DefaultValidateOkPrefix  = "✔"
 	DefaultValidateErrPrefix = "✘"
 	DefaultTextAreaMaxHeight = 5
-	DefaultTextAreaHeight    = 5
+	DefaultTextAreaHeight    = 2
 	DefaultSelectWidth       = 20
 	DefaultSelectHeight      = 12