refactor: clean up unused code

frontend/constants/const.go → tui/constants/const.go

@@ -5,7 +5,10 @@ import (
 	"github.com/charmbracelet/lipgloss"
 )
 
+// DocStyle styling for viewports
 var DocStyle = lipgloss.NewStyle().Margin(1, 2)
+
+// HelpStyle styling for help context menu
 var HelpStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("241")).Render
 
 type keymap struct {
@@ -16,6 +19,7 @@ type keymap struct {
 	Back   key.Binding
 }
 
+// Keymap reusable key mappings shared across models
 var Keymap = keymap{
 	Create: key.NewBinding(
 		key.WithKeys("c"),

frontend/entryui/entry_view.go → tui/entryui/entry_view.go

@@ -2,7 +2,7 @@ package entryui
 
 import (
 	"github.com/bashbunni/project-management/entry"
-	"github.com/bashbunni/project-management/frontend/constants"
+	"github.com/bashbunni/project-management/tui/constants"
 	"github.com/charmbracelet/bubbles/key"
 	"github.com/charmbracelet/bubbles/viewport"
 	tea "github.com/charmbracelet/bubbletea"
@@ -15,8 +15,10 @@ var (
 	cmds []tea.Cmd
 )
 
+// BackMsg change state back to project view
 type BackMsg bool
 
+// Model entryui model
 type Model struct {
 	viewport        viewport.Model
 	er              *entry.GormRepository
@@ -26,10 +28,12 @@ type Model struct {
 	error           string
 }
 
+// Init run any intial IO on program start
 func (m Model) Init() tea.Cmd {
 	return nil
 }
 
+// New initialize the entryui model for your program
 func New(er *entry.GormRepository, activeProjectID uint, p *tea.Program) *Model {
 	m := Model{er: er, activeProjectID: activeProjectID}
 	vp := viewport.New(8, 8)
@@ -53,6 +57,7 @@ func New(er *entry.GormRepository, activeProjectID uint, p *tea.Program) *Model
 	return &m
 }
 
+// Update handle IO and commands
 func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 	switch msg := msg.(type) {
 	case tea.WindowSizeMsg:
@@ -84,6 +89,7 @@ func (m Model) helpView() string {
 	return constants.HelpStyle("\n ↑/↓: navigate  • esc: back • c: create entry • d: delete entry • q: quit\n")
 }
 
+// View return the text UI to be output to the terminal
 func (m Model) View() string {
 	return constants.DocStyle.Render(m.viewport.View() + m.helpView())
 }

frontend/projectui/project_view.go → tui/projectui/project_view.go

@@ -4,8 +4,8 @@ import (
 	"log"
 
 	"github.com/bashbunni/project-management/entry"
-	"github.com/bashbunni/project-management/frontend/constants"
 	"github.com/bashbunni/project-management/project"
+	"github.com/bashbunni/project-management/tui/constants"
 	"github.com/charmbracelet/bubbles/key"
 	"github.com/charmbracelet/bubbles/list"
 	"github.com/charmbracelet/bubbles/textinput"
@@ -14,17 +14,20 @@ import (
 
 // TODO: add multi-page navigation
 
+// SelectMsg the message to change the view to the selected entry
 type SelectMsg struct {
 	ActiveProjectID uint
 }
 
+// Model the entryui model definition
 type Model struct {
 	mode  string
 	list  list.Model
 	input textinput.Model
 	pr    *project.GormRepository
 }
 
+// New initialize the projectui model for your program
 func New(pr *project.GormRepository, er *entry.GormRepository) tea.Model {
 	input := textinput.New()
 	input.Prompt = "$ "
@@ -52,13 +55,14 @@ func newProjectList(pr *project.GormRepository) []list.Item {
 		log.Fatal(err)
 	}
 	return projectsToItems(projects)
-
 }
 
+// Init run any intial IO on program start
 func (m Model) Init() tea.Cmd {
 	return nil
 }
 
+// Update handle IO and commands
 func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 	var cmd tea.Cmd
 	var cmds []tea.Cmd
@@ -123,6 +127,7 @@ func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 	return m, tea.Batch(cmds...)
 }
 
+// View return the text UI to be output to the terminal
 func (m Model) View() string {
 	if m.input.Focused() {
 		return constants.DocStyle.Render(m.list.View() + "\n" + m.input.View())
@@ -131,7 +136,7 @@ func (m Model) View() string {
 }
 
 // TODO: use generics
-// convert []model.Project to []list.Item
+// projectsToItems convert []model.Project to []list.Item
 func projectsToItems(projects []project.Project) []list.Item {
 	items := make([]list.Item, len(projects))
 	for i, proj := range projects {

frontend/tui.go → tui/tui.go

@@ -5,9 +5,9 @@ import (
 	"os"
 
 	"github.com/bashbunni/project-management/entry"
-	"github.com/bashbunni/project-management/frontend/entryui"
-	"github.com/bashbunni/project-management/frontend/projectui"
 	"github.com/bashbunni/project-management/project"
+	"github.com/bashbunni/project-management/tui/entryui"
+	"github.com/bashbunni/project-management/tui/projectui"
 	tea "github.com/charmbracelet/bubbletea"
 )
 
@@ -22,8 +22,8 @@ const (
 	entryView
 )
 
-// implements tea.Model (Init, Update, View)
-type mainModel struct {
+// MainModel the main model of the program; holds other models and bubbles
+type MainModel struct {
 	state           sessionState
 	project         tea.Model
 	entry           tea.Model
@@ -52,20 +52,23 @@ func StartTea(pr project.GormRepository, er entry.GormRepository) {
 	}
 }
 
-func New(pr *project.GormRepository, er *entry.GormRepository) mainModel {
-	return mainModel{
+// New initialize the main model for your program
+func New(pr *project.GormRepository, er *entry.GormRepository) MainModel {
+	return MainModel{
 		state:   projectView,
 		project: projectui.New(pr, er),
 		pr:      pr,
 		er:      er,
 	}
 }
 
-func (m mainModel) Init() tea.Cmd {
+// Init run any intial IO on program start
+func (m MainModel) Init() tea.Cmd {
 	return nil
 }
 
-func (m mainModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+// Update handle IO and commands
+func (m MainModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 	var cmd tea.Cmd
 	var cmds []tea.Cmd
 	switch msg := msg.(type) {
@@ -99,7 +102,8 @@ func (m mainModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 	return m, tea.Batch(cmds...)
 }
 
-func (m mainModel) View() string {
+// View return the text UI to be output to the terminal
+func (m MainModel) View() string {
 	switch m.state {
 	case entryView:
 		return m.entry.View()