clean up #16

Author: prime-run

.gitignore

@@ -1,3 +1,4 @@
 bin/
 go-typer
 run
+colorschemes

cmd/fetch.go

@@ -1,5 +1,4 @@
-// NOTE:QUTE FETCHER
-// .. maybe cache using a free edge run-time and store in an S3 bucket?
+// NOTE: maybe cache using a free edge run-time and store in an S3 bucket?
 package cmd
 
 import (
@@ -13,12 +12,12 @@ import (
 )
 
 const (
-	ModeDefault   types.Mode = "default"   // default mode
-	ModeWords     types.Mode = "words"     // word mode
-	ModeSentences types.Mode = "sentences" // sentence mode
+	ModeDefault   types.Mode = "default"
+	ModeWords     types.Mode = "words"
+	ModeSentences types.Mode = "sentences"
 
-	zenQuotesAPIURL = "https://zenquotes.io/api/random" // ZenQuotes API URL
-	bibleAPIURL     = "https://bible-api.com/john+3:16" // Bible API URL
+	zenQuotesAPIURL = "https://zenquotes.io/api/random"
+	bibleAPIURL     = "https://bible-api.com/john+3:16"
 )
 
 func init() {
@@ -94,7 +93,6 @@ var fetchCmd = &cobra.Command{
 	},
 }
 
-// formatForGameMode formats the text based on the specified game mode.
 func formatForGameMode(text string, mode types.Mode) string {
 	text = utils.FormatText(text)
 
@@ -108,14 +106,11 @@ func formatForGameMode(text string, mode types.Mode) string {
 	}
 }
 
-// formatForWords formats the text for word mode by splitting it into lines based on spaces.
-// Each word is placed on a new line.
 func formatForWords(text string) string {
 	words := strings.Fields(text)
 	return strings.Join(words, "\n")
 }
 
-// formatForSentences formats the text for sentence mode by splitting it into lines based on punctuation.
 func formatForSentences(text string) string {
 	text = strings.ReplaceAll(text, ".", ".\n")
 	text = strings.ReplaceAll(text, "!", "!\n")

cmd/main.go

@@ -13,20 +13,19 @@ import (
 )
 
 var (
-	cursorType string // Cursor type (block or underline)
-	themeName  string // Theme name or path to custom theme file
-	listThemes bool   // List available themes and exit
-	debugMode  bool   // Enable debug mode for performance analysis
-	customText string // Custom text to display in the game
-	filePath   string // Custom text file to read from
+	cursorType string
+	themeName  string
+	listThemes bool
+	debugMode  bool
+	customText string
+	filePath   string
 )
 
 var startCmd = &cobra.Command{
 	Use:   "start",
 	Short: "Start a new game",
 	Long:  "Start a new game of Go Typer. This command will initialize a new game session.",
 	Run: func(cmd *cobra.Command, args []string) {
-		// check if the debug mode is enabled and set the log level accordingly
 		if debugMode {
 			devlog.DebugEnabled = true
 			devlog.InitLog()
@@ -35,7 +34,6 @@ var startCmd = &cobra.Command{
 			cmd.Printf("Debug mode enabled, logging to %s\n", filepath.Join(utils.GetConfigDirPath(), "debug.log"))
 		}
 
-		// check if listThemes is enabled and list available themes
 		if listThemes {
 			themes := ui.ListAvailableThemes()
 			fmt.Println("Available themes:")
@@ -45,7 +43,6 @@ var startCmd = &cobra.Command{
 			return
 		}
 
-		// check for theme name and load the theme
 		if themeName != "" {
 			fmt.Printf("Theme name provided: %s", themeName)
 			if strings.HasPrefix(themeName, "-") {
@@ -65,41 +62,36 @@ var startCmd = &cobra.Command{
 			}
 		}
 
-		// check for custom text and set it
 		if filePath != "" {
 			data, err := os.ReadFile(filePath)
 			if err != nil {
-				cmd.Printf("Warning: Could not read custom text file '%s': %v\n", filePath, err)
+				cmd.Printf("Could not read custom text file %s: \n", filePath)
+				os.Exit(0)
+
 			} else {
 				customText = string(data)
 			}
 		}
 
-		// check for cursor type and set it
 		if cursorType != "" {
 			ui.CurrentSettings.CursorType = cursorType
 		}
 
-		// apply settings and start loading
 		ui.ApplySettings()
 		ui.StartLoadingWithOptions(ui.CurrentSettings.CursorType, customText)
 	},
 }
 
 func init() {
-	// Cursor and theme configuration
 	startCmd.Flags().StringVarP(&cursorType, "cursor", "c", "block", "Cursor type (block or underline)")
 	startCmd.Flags().StringVarP(&themeName, "theme", "t", "", "Theme name or path to custom theme file (default: default)")
 	startCmd.Flags().BoolVar(&listThemes, "list-themes", false, "List available themes and exit")
 
-	// Debug and logging options
 	startCmd.Flags().BoolP("verbose", "v", false, "Enable verbose output")
 	startCmd.Flags().BoolVar(&debugMode, "debug", false, "Enable debug mode for performance analysis")
 
-	// Custom text option
 	startCmd.Flags().StringVarP(&customText, "text", "x", "", "Custom text to display in the game (default: random text)")
 	startCmd.Flags().StringVarP(&filePath, "file", "f", "", "Custom text file to read from")
 
-	// Add command to root
 	rootCmd.AddCommand(startCmd)
 }

colorschemes/dark.yml

@@ -11,14 +11,11 @@ import (
 )
 
 var (
-	DebugEnabled = false   // Enable debug logging
-	debugFile    *os.File  // File handle for the debug log
-	lastFlush    time.Time // Last time the log was flushed
+	DebugEnabled = false
+	debugFile    *os.File
+	lastFlush    time.Time
 )
 
-// InitDebugLog initializes the debug log file. It creates a new file in the
-// application's config directory and writes initial debug information.
-// It also logs the current OS, architecture, number of CPUs, and goroutines.
 func InitLog() {
 	if !DebugEnabled {
 		return
@@ -44,8 +41,6 @@ func InitLog() {
 		runtime.GOOS, runtime.GOARCH, runtime.NumCPU(), runtime.NumGoroutine())
 }
 
-// DebugLog writes a debug message to the debug log file. It includes a timestamp and the number of goroutines.
-// The message is formatted using fmt.Sprintf, and the log is flushed every second.
 func Log(format string, args ...interface{}) {
 	if !DebugEnabled || debugFile == nil {
 		return
@@ -65,7 +60,6 @@ func Log(format string, args ...interface{}) {
 	}
 }
 
-// CloseDebugLog closes the debug log file if it is open.
 func CloseLog() {
 	if debugFile != nil {
 		Log("Closing debug log")

colorschemes/default.yml

@@ -7,15 +7,13 @@ import (
 	"time"
 )
 
-type Mode string // Mode is a type that represents the different modes of text formatting.
-// TextSource is a struct that represents a source of text.
-// It contains a URL to fetch the text from and a parser function to process the response.
+type Mode string
+
 type TextSource struct {
-	URL    string                       // URL to fetch text from
-	Parser func([]byte) (string, error) // Parser function to process the response
+	URL    string
+	Parser func([]byte) (string, error)
 }
 
-// FetchText fetches text from the specified URL and parses it using the provided parser function.
 func (s *TextSource) FetchText() (string, error) {
 	client := &http.Client{
 		Timeout: 10 * time.Second,

colorschemes/monochrome.yml

@@ -1,26 +1,24 @@
 package ui
 
-type CursorType int // CursorType represents the type of cursor to be used in the UI.
+type CursorType int
 
 const (
-	BlockCursor     CursorType = iota // Block cursor
-	UnderlineCursor                   // Underline cursor
+	BlockCursor CursorType = iota
+	UnderlineCursor
 )
 
-var DefaultCursorType CursorType = BlockCursor // Default cursor type
+var DefaultCursorType CursorType = BlockCursor
 
 type Cursor struct {
 	style CursorType
 }
 
-// NewCursor creates a new cursor with the specified style.
 func NewCursor(style CursorType) *Cursor {
 	return &Cursor{
 		style: style,
 	}
 }
 
-// render returns the string representation of the cursor based on its style.
 func (c *Cursor) Render(char rune) string {
 	switch c.style {
 	case BlockCursor:

log/debug.go

@@ -8,12 +8,10 @@ import (
 
 type GlobalTickMsg time.Time
 
-// InitGlobalTick initializes the global tick command with the current refresh interval.
 func InitGlobalTick() tea.Cmd {
 	return GlobalTickCmd(GetRefreshInterval())
 }
 
-// HandleGlobalTick processes the global tick message and returns the new tick time,
 func HandleGlobalTick(lastTick time.Time, msg GlobalTickMsg) (time.Time, bool, tea.Cmd) {
 	newTick := time.Time(msg)
 
@@ -22,15 +20,13 @@ func HandleGlobalTick(lastTick time.Time, msg GlobalTickMsg) (time.Time, bool, t
 	return newTick, true, cmd
 }
 
-// GlobalTickCmd creates a command that ticks at the specified interval.
 func GlobalTickCmd(interval time.Duration) tea.Cmd {
 	return tea.Tick(interval, func(t time.Time) tea.Msg {
 		return GlobalTickMsg(t)
 	})
 }
 
-// GetRefreshInterval calculates the refresh interval based on the current settings.
-// If the refresh rate is set to 0, it defaults to 10 FPS (100ms).
+// if set to > 0,  defaults to 10 (100ms).
 func GetRefreshInterval() time.Duration {
 	fps := 10
 	if CurrentSettings.RefreshRate > 0 {