Slide 1

Slide 1 text

Using Charm CLI Build a glamorous Habits Tracker Donia Chaiehloudj | @doniacld GopherCon Chicago, 2024 Software Engineer @Isovalent by Cisco Co-author of β€œLearn Go with Pocket-Sized Projects”

Slide 2

Slide 2 text

Agenda_ My ideal Habit Tracker What is Charm_ ? Demo 🀞 Charm_ Cheatsheet @doniacld

Slide 3

Slide 3 text

My ideal Habit Tracker Why? @doniacld

Slide 4

Slide 4 text

My ideal Habit Tracker Why? @doniacld

Slide 5

Slide 5 text

My ideal Habit Tracker Why? @doniacld

Slide 6

Slide 6 text

My ideal Habit Tracker In a terminal @doniacld

Slide 7

Slide 7 text

Display strings Print logs in a file Handle errors properly Terminal UI @doniacld Constraints

Slide 8

Slide 8 text

Charm_ Making the command line glamourous, powerful, fun and modern. glamourous @doniacld

Slide 9

Slide 9 text

Libs Charm_ Making the command line glamourous, powerful, fun and modern. glamourous @doniacld Stylesheet mardown renderer Terminal style toolkit Some components for Bubble Tea apps Terminal UI framework

Slide 10

Slide 10 text

Libs Charm_ Making the command line glamourous, powerful, fun and modern. glamourous @doniacld Stylesheet mardown renderer Terminal style toolkit Some components for Bubble Tea apps Terminal UI framework Apps Render markdown on the CLI Self-host your Git server for CLI Write terminal GIFs as code

Slide 11

Slide 11 text

Model β€” the state of your application View β€” render your model in your terminal as string Update β€” a way to update your state based on messages Bubble Tea @doniacld Based on the Elm Architecture Architecture

Slide 12

Slide 12 text

Bubble Tea @doniacld Architecture

Slide 13

Slide 13 text

Bubble Tea @doniacld Architecture

Slide 14

Slide 14 text

Bubbles @doniacld Bubble = Component = Model Spinner, Text input, Text area, Table, Progress, List, Paginator, ...

Slide 15

Slide 15 text

Habits Tracker @doniacld

Slide 16

Slide 16 text

Habits Tracker @doniacld

Slide 17

Slide 17 text

Habits Tracker @doniacld

Slide 18

Slide 18 text

Habits Tracker @doniacld

Slide 19

Slide 19 text

@doniacld List Habits Habit Define a Habit 1. // pkg/habit/habit.go

Slide 20

Slide 20 text

@doniacld List Habits Habit Define a Habit 1. 2. Implement Item Interface // pkg/habit/habit.go

Slide 21

Slide 21 text

@doniacld List Habits Habit Define a Habit 1. 2. Implement Item Interface 3. Define main Model // pkg/habittracker/model.go // pkg/habit/habit.go

Slide 22

Slide 22 text

@doniacld List Habits // pkg/habittracker/model.go

Slide 23

Slide 23 text

@doniacld List Habits // pkg/habittracker/model.go

Slide 24

Slide 24 text

List Habits @doniacld Model interface // pkg/habittracker/model.go

Slide 25

Slide 25 text

List Habits @doniacld Model interface Check the message type 1. // pkg/habittracker/model.go

Slide 26

Slide 26 text

List Habits @doniacld Model interface Check the message type 1. Update the pagination at resize 2. // pkg/habittracker/model.go

Slide 27

Slide 27 text

List Habits @doniacld Model interface Check the message type 1. Update the pagination at resize 2. Check input keyboard 3. // pkg/habittracker/model.go

Slide 28

Slide 28 text

List Habits @doniacld Model interface Check the message type 1. Update the pagination at resize 2. Check input keyboard 3. Delegate update to Bubbletea 4. // pkg/habittracker/model.go

Slide 29

Slide 29 text

@doniacld Demo List Habits πŸ“‹

Slide 30

Slide 30 text

func (m Model) View() string { var details string if m.habits.SelectedItem() != nil { current := m.habits.SelectedItem().(habit) details = fmt.Sprintf("\nDetails: \nAchieved %d/%d", current.ticksCount, current.target) } return lipgloss.JoinHorizontal(lipgloss.Top, m.habits.View(), details) } List Habits @doniacld Put some Lipgloss // pkg/habittracker/model.go

Slide 31

Slide 31 text

List Habits @doniacld Put some Lipgloss // pkg/habittracker/model.go

Slide 32

Slide 32 text

@doniacld Demo List Habits πŸ’„

Slide 33

Slide 33 text

@doniacld Tick Habit Custom command // pkg/habittracker/cmd.go

Slide 34

Slide 34 text

@doniacld Tick Habit Custom command // pkg/habittracker/cmd.go

Slide 35

Slide 35 text

@doniacld Tick Habit Custom command // pkg/habittracker/cmd.go

Slide 36

Slide 36 text

@doniacld Tick Habit Custom command // pkg/habittracker/model.go

Slide 37

Slide 37 text

@doniacld Demo Tick Habit βœ…

Slide 38

Slide 38 text

@doniacld Progression Bar Add new Model // pkg/habittracker/model.go

Slide 39

Slide 39 text

@doniacld Progression Bar Create new command Add new Model // pkg/habittracker/model.go // pkg/habittracker/cmd.go

Slide 40

Slide 40 text

@doniacld Demo Progression Bar πŸ“Š

Slide 41

Slide 41 text

@doniacld Add a Habit Create new nested Model // pkg/form/model.go

Slide 42

Slide 42 text

@doniacld Add a Habit Introduce session state Create new nested Model // pkg/form/model.go // pkg/habittracker/model.go

Slide 43

Slide 43 text

@doniacld Add a Habit Introduce session state Create new nested Model // pkg/form/model.go // pkg/habittracker/model.go // pkg/habittracker/model.go Add to main Model

Slide 44

Slide 44 text

@doniacld Add a Habit // pkg/habittracker/cmd.go

Slide 45

Slide 45 text

@doniacld Add a Habit // pkg/habittracker/cmd.go

Slide 46

Slide 46 text

@doniacld Add a Habit // pkg/habittracker/cmd.go

Slide 47

Slide 47 text

@doniacld Add a Habit Catch create key input

Slide 48

Slide 48 text

@doniacld Add a Habit Delegate Update to textinput.Model Catch create key input

Slide 49

Slide 49 text

Demo Add a Habit + @doniacld

Slide 50

Slide 50 text

Key Takeaways Build your Model and combine: list, table, text, form, etc. Model interface: Init, Update, View Put some lipstick πŸ’„ Create new commands Apply to your everyday boring CLI && Have fun! 🀩 @doniacld xxxCmd(msg tea.Msg) tea.Cmd

Slide 51

Slide 51 text

Key Takeaways Build your Model and combine: list, table, text, form, etc. Model interface: Init, Update, View Put some lipstick πŸ’„ Create new commands Apply to your everyday boring CLI && Have fun! 🀩 https://charm.sh https://github.com/bashbunni/pjs/ @doniacld xxxCmd(msg tea.Msg) tea.Cmd

Slide 52

Slide 52 text

Thanks @doniacld github.com/doniacld/charmify speakerdeck/doniacld manning.com/learn-go-with-pocket-sized-projects Recorded with VHS