chore: comments everywhere

main.go

@@ -4,7 +4,6 @@ import (
 	"bufio"
 	"fmt"
 	"os"
-	_ "os/exec"
 	"os/user"
 	"syscall"
 	"os/signal"
@@ -25,8 +24,11 @@ import (
 
 const version = "0.2.0-dev"
 var l *lua.LState
+// User's prompt, this will get set when lua side is initialized
 var prompt string
+// Map of builtin/custom commands defined in the commander lua module
 var commands = map[string]bool{}
+// Command aliases
 var aliases = map[string]string{}
 
 func main() {
@@ -41,7 +43,9 @@ func main() {
 	})
 
 	err := parser.Parse(os.Args)
+	// If invalid flags or --help/-h,
 	if err != nil {
+		// Print usage
 		fmt.Print(parser.Usage(err))
 		os.Exit(0)
 	}
@@ -51,10 +55,14 @@ func main() {
 		os.Exit(0)
 	}
 
+	// Set $SHELL if the user wants to
 	if *setshflag { os.Setenv("SHELL", os.Args[0]) }
 
+	// Read config from current directory
+	// (this is assuming the current dir is Hilbish's git)
 	input, err := os.ReadFile(".hilbishrc.lua")
 	if err != nil {
+		// If it wasnt found, go to "real default"
 		input, err = os.ReadFile("/usr/share/hilbish/.hilbishrc.lua")
 		if err != nil {
 			fmt.Println("could not find .hilbishrc.lua or /usr/share/hilbish/.hilbishrc.lua")
@@ -63,9 +71,12 @@ func main() {
 	}
 
 	homedir, _ := os.UserHomeDir()
+	// If user's config doesn't exixt,
 	if _, err := os.Stat(homedir + "/.hilbishrc.lua"); os.IsNotExist(err) {
+		// Create it using either default config we found
 		err = os.WriteFile(homedir + "/.hilbishrc.lua", input, 0644)
 		if err != nil {
+			// If that fails, bail
 			fmt.Println("Error creating config file")
 			fmt.Println(err)
 			return
@@ -77,40 +88,42 @@ func main() {
 
 	readline.Completer = readline.FilenameCompleter
 
-
 	for {
-		//dir, _ := os.Getwd()
-
-		//reader := bufio.NewReader(os.Stdin)
-
-		//fmt.Printf(prompt)
-
 		cmdString, err := readline.String(fmtPrompt())
 		if err == io.EOF {
+			// Exit if user presses ^D (ctrl + d)
 			fmt.Println("")
 			break
 		}
 		if err != nil {
+			// If we get a completely random error, print
 			fmt.Fprintln(os.Stderr, err)
 		}
+
+		// I have no idea if we need this anymore
 		cmdString = strings.TrimSuffix(cmdString, "\n")
+		// First try to run user input in Lua
 		err = l.DoString(cmdString)
 
 		if err == nil {
+			// If it succeeds, add to history and prompt again
 			readline.AddHistory(cmdString)
 			continue
 		}
 
+		// Split up the input
 		cmdArgs, cmdString := splitInput(cmdString)
+		// If there's actually no input, prompt again
 		if len(cmdArgs) == 0 { continue }
 
+		// If alias was found, use command alias
 		if aliases[cmdArgs[0]] != "" {
 			cmdString = aliases[cmdArgs[0]] + strings.Trim(cmdString, cmdArgs[0])
-			//cmdArgs := splitInput(cmdString)
 			execCommand(cmdString)
 			continue
 		}
 
+		// If command is defined in Lua then run it
 		if commands[cmdArgs[0]] {
 			err := l.CallByParam(lua.P{
 				Fn: l.GetField(
@@ -128,12 +141,15 @@ func main() {
 			readline.AddHistory(cmdString)
 			continue
 		}
+
+		// Last option: use sh interpreter
 		switch cmdArgs[0] {
 		case "exit":
 			os.Exit(0)
 		default:
 			err := execCommand(cmdString)
 			if err != nil {
+				// If input is incomplete, start multiline prompting
 				if syntax.IsIncomplete(err) {
 					sb := &strings.Builder{}
 					for {
@@ -150,30 +166,35 @@ func main() {
 	}
 }
 
+// This semi cursed function formats our prompt (obviously)
 func fmtPrompt() string {
 	user, _ := user.Current()
 	host, _ := os.Hostname()
 	cwd, _ := os.Getwd()
+
 	cwd = strings.Replace(cwd, user.HomeDir, "~", 1)
+
 	args := []string{
-		"d",
-		cwd,
-		"h",
-		host,
-		"u",
-		user.Name,
+		"d", cwd,
+		"h", host,
+		"u", user.Name,
 	}
+
 	for i, v := range args {
 		if i % 2 == 0 {
 			args[i] = "%" + v
 		}
 	}
+
 	r := strings.NewReplacer(args...)
 	nprompt := r.Replace(prompt)
+
 	return nprompt
 }
 
 func StartMultiline(prev string, sb *strings.Builder) bool {
+	// sb fromt outside is passed so we can
+	// save input from previous prompts
 	if sb.String() == "" { sb.WriteString(prev + "\n") }
 
 	fmt.Printf("... ")
@@ -182,6 +203,7 @@ func StartMultiline(prev string, sb *strings.Builder) bool {
 
 	cont, err := reader.ReadString('\n')
 	if err == io.EOF {
+		// Exit when ^D
 		fmt.Println("")
 		return true
 	}
@@ -193,7 +215,7 @@ func StartMultiline(prev string, sb *strings.Builder) bool {
 		return false
 	}
 
-	return true
+	return true 
 }
 
 func splitInput(input string) ([]string, string) {
@@ -209,21 +231,32 @@ func splitInput(input string) ([]string, string) {
 
 	for _, r := range input {
 		if r == '"' {
+			// start quoted input
+			// this determines if other runes are replaced
 			quoted = !quoted
 			// dont add back quotes
 			//sb.WriteRune(r)
 		} else if !quoted && r == '~' {
+			// if not in quotes and ~ is found then make it $HOME
 			sb.WriteString(os.Getenv("HOME"))
 		} else if !quoted && r == ' ' {
+			// if not quoted and there's a space then add to cmdargs
 			cmdArgs = append(cmdArgs, sb.String())
 			sb.Reset()
 		} else if !quoted && r == '^' && startlastcmd && !lastcmddone {
+			// if ^ is found, isnt in quotes and is
+			// the second occurence of the character and is
+			// the first time "^^" has been used
 			cmdstr.WriteString(lastcmd)
 			sb.WriteString(lastcmd)
+
 			startlastcmd = !startlastcmd
 			lastcmddone = !lastcmddone
+
 			continue
 		} else if !quoted && r == '^' && !lastcmddone {
+			// if ^ is found, isnt in quotes and is the
+			// first time of starting "^^"
 			startlastcmd = !startlastcmd
 			continue
 		} else {
@@ -239,6 +272,7 @@ func splitInput(input string) ([]string, string) {
 	return cmdArgs, cmdstr.String()
 }
 
+// Run command in sh interpreter
 func execCommand(cmd string) error {
 	file, err := syntax.NewParser().Parse(strings.NewReader(cmd), "")
 	if err != nil {
@@ -252,6 +286,7 @@ func execCommand(cmd string) error {
 	return nil
 }
 
+// do i even have to say
 func HandleSignals() {
 	c := make(chan os.Signal)
 	signal.Notify(c, os.Interrupt, syscall.SIGTERM)
@@ -261,6 +296,7 @@ func HandleSignals() {
 }
 
 func LuaInit() {
+	// TODO: Move to lua.go
 	l = lua.NewState()
 
 	l.OpenLibs()
@@ -268,9 +304,11 @@ func LuaInit() {
 	l.SetGlobal("prompt", l.NewFunction(hshprompt))
 	l.SetGlobal("alias", l.NewFunction(hshalias))
 
+	// Add fs module to Lua
 	l.PreloadModule("fs", lfs.Loader)
 
 	commander := cmds.New()
+	// When a command from Lua is added, register it for use
 	commander.Events.On("commandRegister",
 	func (cmdName string, cmd *lua.LFunction) {
 		commands[cmdName] = true
@@ -283,6 +321,7 @@ func LuaInit() {
 
 	l.PreloadModule("commander", commander.Loader)
 
+	// Add more paths that Lua can require from
 	l.DoString("package.path = package.path .. ';./libs/?/init.lua;/usr/share/hilbish/libs/?/init.lua'")
 
 	err := l.DoFile("/usr/share/hilbish/preload.lua")
@@ -295,6 +334,7 @@ func LuaInit() {
 	}
 
 	homedir, _ := os.UserHomeDir()
+	// Run config
 	err = l.DoFile(homedir + "/.hilbishrc.lua")
 	if err != nil {
 		panic(err)