removing named return values

- avoiding confusion w long functions for naked returns

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 jake
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -51,15 +51,9 @@ func main() {
         },
 	)
 
-	_ = b.Start()
+	//start is a blocking call that handles safe-shutdown, all configuration and setup should be done before calling Start()
-
+	err := b.Start()
-	//set up safe CTRL-C
+	if err != nil {
-	sigChannel := make(chan os.Signal, 1)
-	signal.Notify(sigChannel, syscall.SIGINT)
-	log.Println("bot running")
-	<-sigChannel
-
-	if err := b.Stop(); err != nil {
 		panic(err)
 	}
 }

bolt.go

@@ -4,8 +4,10 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"os/signal"
 	"slices"
 	"strings"
+	"syscall"
 	"time"
 
 	dg "github.com/bwmarrin/discordgo"
@@ -30,7 +32,7 @@ type bolt struct {
 
 type Bolt interface {
 	Start() error
-	Stop() error
+	stop() error
 	AddCommands(cmd Command)
 	messageHandler(s *dg.Session, msg *dg.MessageCreate)
 	createReply(content, message, channel, guild string) *dg.MessageSend
@@ -68,16 +70,32 @@ func New(opts ...Option) *bolt {
 	return b
 }
 
-// adds command handler and starts the bot
+// adds command handler and starts the bot, this is a BLOCKING CALL
+
+// starts the bot, commands are added and the connection to Discord is opened, this is a BLOCKING
+// call and handles safe shutdown of the bot
 func (b *bolt) Start() error {
 	//register commands and open connection
 	b.AddHandler(b.messageHandler)
 
-	return b.Open()
+	err := b.Open()
+	if err != nil {
+		return err
+	}
+
+	sigChannel := make(chan os.Signal, 1)
+	signal.Notify(sigChannel, syscall.SIGINT)
+	<-sigChannel
+
+	if err := b.stop(); err != nil {
+		return err
+	}
+
+	return nil
 }
 
 // stops the bot
-func (b *bolt) Stop() error {
+func (b *bolt) stop() error {
 	return b.Close()
 }
 
@@ -166,7 +184,7 @@ func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
 		res, err := run.Payload(Message{
 			Author:  msg.Author.Username,
 			Words:   words,
-			Message: msg.Content,
+			Content: msg.Content,
 			Channel: channel.Name,
 			Server:  server.Name,
 		})

command.go

@@ -12,13 +12,13 @@ type Command struct {
 
 // payload function type handling commands. The returned error is parsed and, if no error,
 // is detected then the response string (res) will be sent in response to the command message
-type Payload func(msg Message) (res string, err error)
+type Payload func(msg Message) (string, error)
 
 // contains the basic information needed for a message command
 type Message struct {
 	Author  string   //username of message author
 	Words   []string //words from message split on whitespace
-	Message string   //entire message content
+	Content string   //entire message content
 	Channel string   //channel message was sent in
 	Server  string   //guild message was sent in
 }