refactor: reduce duplication and reorganize code in doc gen

aliases.go

@@ -9,40 +9,40 @@ import (
 	rt "github.com/arnodel/golua/runtime"
 )
 
-var aliases *aliasHandler
+var aliases *aliasModule
 
-type aliasHandler struct {
+type aliasModule struct {
 	aliases map[string]string
 	mu *sync.RWMutex
 }
 
 // initialize aliases map
-func newAliases() *aliasHandler {
+func newAliases() *aliasModule {
-	return &aliasHandler{
+	return &aliasModule{
 		aliases: make(map[string]string),
 		mu: &sync.RWMutex{},
 	}
 }
 
-func (a *aliasHandler) Add(alias, cmd string) {
+func (a *aliasModule) Add(alias, cmd string) {
 	a.mu.Lock()
 	defer a.mu.Unlock()
 
 	a.aliases[alias] = cmd
 }
 
-func (a *aliasHandler) All() map[string]string {
+func (a *aliasModule) All() map[string]string {
 	return a.aliases
 }
 
-func (a *aliasHandler) Delete(alias string) {
+func (a *aliasModule) Delete(alias string) {
 	a.mu.Lock()
 	defer a.mu.Unlock()
 
 	delete(a.aliases, alias)
 }
 
-func (a *aliasHandler) Resolve(cmdstr string) string {
+func (a *aliasModule) Resolve(cmdstr string) string {
 	a.mu.RLock()
 	defer a.mu.RUnlock()
 
@@ -66,7 +66,9 @@ func (a *aliasHandler) Resolve(cmdstr string) string {
 
 // lua section
 
-func (a *aliasHandler) Loader(rtm *rt.Runtime) *rt.Table {
+// #interface
+// ALIAS LOADER TEST
+func (a *aliasModule) Loader(rtm *rt.Runtime) *rt.Table {
 	// create a lua module with our functions
 	hshaliasesLua := map[string]util.LuaExport{
 		"add": util.LuaExport{hlalias, 2, false},
@@ -81,7 +83,7 @@ func (a *aliasHandler) Loader(rtm *rt.Runtime) *rt.Table {
 	return mod
 }
 
-func (a *aliasHandler) luaList(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
+func (a *aliasModule) luaList(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 	aliasesList := rt.NewTable()
 	for k, v := range a.All() {
 		aliasesList.Set(rt.StringValue(k), rt.StringValue(v))
@@ -90,7 +92,7 @@ func (a *aliasHandler) luaList(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 	return c.PushingNext1(t.Runtime, rt.TableValue(aliasesList)), nil
 }
 
-func (a *aliasHandler) luaDelete(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
+func (a *aliasModule) luaDelete(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 	if err := c.Check1Arg(); err != nil {
 		return nil, err
 	}
@@ -103,7 +105,7 @@ func (a *aliasHandler) luaDelete(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 	return c.Next(), nil
 }
 
-func (a *aliasHandler) luaResolve(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
+func (a *aliasModule) luaResolve(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 	if err := c.Check1Arg(); err != nil {
 		return nil, err
 	}

api.go

@@ -159,10 +159,10 @@ func hilbishLoad(rtm *rt.Runtime) (rt.Value, func()) {
 	mod.Set(rt.StringValue("jobs"), rt.TableValue(jobModule))
 
 	// hilbish.timers table
-	timers = newTimerHandler()
+	timers = newTimersModule()
-	timerModule := timers.loader(rtm)
+	timersModule := timers.loader(rtm)
-	util.Document(timerModule, "Timer interface, for control of all intervals and timeouts.")
+	util.Document(timersModule, "Timer interface, for control of all intervals and timeouts.")
-	mod.Set(rt.StringValue("timers"), rt.TableValue(timerModule))
+	mod.Set(rt.StringValue("timers"), rt.TableValue(timersModule))
 
 	editorModule := editorLoader(rtm)
 	util.Document(editorModule, "")

cmd/docgen/docgen.go

@@ -26,9 +26,10 @@ type emmyPiece struct {
 }
 
 type module struct {
-	Docs []docPiece
+	Docs map[string]docPiece
 	ShortDescription string
 	Description string
+	Interface bool
 }
 type docPiece struct {
 	Doc []string
@@ -36,6 +37,57 @@ type docPiece struct {
 	FuncName string
 }
 
+
+var docs = make(map[string]module)
+var emmyDocs = make(map[string][]emmyPiece)
+var prefix = map[string]string{
+	"main": "hl",
+	"hilbish": "hl",
+	"fs": "f",
+	"commander": "c",
+	"bait": "b",
+	"terminal": "term",
+}
+
+func setupDoc(mod string, fun *doc.Func) *docPiece {
+	if !strings.HasPrefix(fun.Name, "hl") && mod == "main" {
+		return nil
+	}
+	if !strings.HasPrefix(fun.Name, prefix[mod]) || fun.Name == "Loader" {
+		return nil
+	}
+	parts := strings.Split(strings.TrimSpace(fun.Doc), "\n")
+	funcsig := parts[0]
+	doc := parts[1:]
+	funcdoc := []string{}
+	em := emmyPiece{FuncName: strings.TrimPrefix(fun.Name, prefix[mod])}
+	for _, d := range doc {
+		if strings.HasPrefix(d, "---") {
+			emmyLine := strings.TrimSpace(strings.TrimPrefix(d, "---"))
+			emmyLinePieces := strings.Split(emmyLine, " ")
+			emmyType := emmyLinePieces[0]
+			if emmyType == "@param" {
+				em.Params = append(em.Params, emmyLinePieces[1])
+			}
+			if emmyType == "@vararg" {
+				em.Params = append(em.Params, "...") // add vararg
+			}
+			em.Docs = append(em.Docs, d)
+		} else {
+			funcdoc = append(funcdoc, d)
+		}
+	}
+			
+	dps := docPiece{
+		Doc: funcdoc,
+		FuncSig: funcsig,
+		FuncName: strings.TrimPrefix(fun.Name, prefix[mod]),
+	}
+			
+	emmyDocs[mod] = append(emmyDocs[mod], em)
+	return &dps
+}
+
 // feel free to clean this up
 // it works, dont really care about the code
 func main() {
@@ -65,88 +117,22 @@ func main() {
 		}
 	}
 
-	prefix := map[string]string{
-		"hilbish": "hl",
-		"fs": "f",
-		"commander": "c",
-		"bait": "b",
-		"terminal": "term",
-	}
-	docs := make(map[string]module)
-	emmyDocs := make(map[string][]emmyPiece)
-
 	for l, f := range pkgs {
 		p := doc.New(f, "./", doc.AllDecls)
-		pieces := []docPiece{}
+		pieces := make(map[string]docPiece)
 		mod := l
 		for _, t := range p.Funcs {
-			if strings.HasPrefix(t.Name, "hl") { mod = "hilbish" }
+			piece := setupDoc(mod, t)
-			if !strings.HasPrefix(t.Name, "hl") && l == "main" { continue }
+			if piece != nil {	
-			if !strings.HasPrefix(t.Name, prefix[mod]) || t.Name == "Loader" { continue }
+				pieces[piece.FuncName] = *piece
-			parts := strings.Split(strings.TrimSpace(t.Doc), "\n")
-			funcsig := parts[0]
-			doc := parts[1:]
-			funcdoc := []string{}
-			em := emmyPiece{FuncName: strings.TrimPrefix(t.Name, prefix[mod])}
-			for _, d := range doc {
-				if strings.HasPrefix(d, "---") {
-					emmyLine := strings.TrimSpace(strings.TrimPrefix(d, "---"))
-					emmyLinePieces := strings.Split(emmyLine, " ")
-					emmyType := emmyLinePieces[0]
-					if emmyType == "@param" {
-						em.Params = append(em.Params, emmyLinePieces[1])
-					}
-					if emmyType == "@vararg" {
-						em.Params = append(em.Params, "...") // add vararg
-					}
-					em.Docs = append(em.Docs, d)
-				} else {
-					funcdoc = append(funcdoc, d)
-				}
 			}
-			
-			dps := docPiece{
-				Doc: funcdoc,
-				FuncSig: funcsig,
-				FuncName: strings.TrimPrefix(t.Name, prefix[mod]),
-			}
-			
-			pieces = append(pieces, dps)
-			emmyDocs[mod] = append(emmyDocs[mod], em)
 		}
 		for _, t := range p.Types {
 			for _, m := range t.Methods {
-				if !strings.HasPrefix(t.Name, "hl") && l == "main" { continue }
+				piece := setupDoc(mod, m)
-				if !strings.HasPrefix(m.Name, prefix[l]) || m.Name == "Loader" { continue }
+				if piece != nil {	
-				parts := strings.Split(strings.TrimSpace(m.Doc), "\n")
+					pieces[piece.FuncName] = *piece
-				funcsig := parts[0]
-				doc := parts[1:]
-				funcdoc := []string{}
-				em := emmyPiece{FuncName: strings.TrimPrefix(m.Name, prefix[l])}
-				for _, d := range doc {
-					if strings.HasPrefix(d, "---") {
-						emmyLine := strings.TrimSpace(strings.TrimPrefix(d, "---"))
-						emmyLinePieces := strings.Split(emmyLine, " ")
-						emmyType := emmyLinePieces[0]
-						if emmyType == "@param" {
-							em.Params = append(em.Params, emmyLinePieces[1])
-						}
-						if emmyType == "@vararg" {
-							em.Params = append(em.Params, "...") // add vararg
-						}
-						em.Docs = append(em.Docs, d)
-					} else {
-						funcdoc = append(funcdoc, d)
-					}
 				}
-				dps := docPiece{
-					Doc: funcdoc,
-					FuncSig: funcsig,
-					FuncName: strings.TrimPrefix(m.Name, prefix[l]),
-				}
-
-				pieces = append(pieces, dps)
-				emmyDocs[l] = append(emmyDocs[l], em)
 			}
 		}
 
@@ -161,9 +147,13 @@ func main() {
 	}
 
 	for mod, v := range docs {
-		if mod == "main" { continue }
+		modN := mod
-		f, _ := os.Create("docs/api/" + mod + ".md")
+		if mod == "main" {
-		f.WriteString(fmt.Sprintf(header, mod, v.ShortDescription))
+			modN = "hilbish"
+		}
+		fmt.Println(mod)
+		f, _ := os.Create("docs/api/" + modN + ".md")
+		f.WriteString(fmt.Sprintf(header, modN, v.ShortDescription))
 		f.WriteString(fmt.Sprintf("## Introduction\n%s\n\n## Functions\n", v.Description))
 		for _, dps := range v.Docs {
 			f.WriteString(fmt.Sprintf("### %s\n", dps.FuncSig))
@@ -174,25 +164,18 @@ func main() {
 			}
 			f.WriteString("\n")
 		}
-	}
+
-	
+		ff, _ := os.Create("emmyLuaDocs/" + modN + ".lua")
-	for mod, v := range emmyDocs {
+		ff.WriteString("--- @meta\n\nlocal " + modN + " = {}\n\n")
-		if mod == "main" { continue }
+		for _, em := range emmyDocs[mod] {
-		f, _ := os.Create("emmyLuaDocs/" + mod + ".lua")
+			funcdocs := v.Docs[em.FuncName].Doc
-		f.WriteString("--- @meta\n\nlocal " + mod + " = {}\n\n")
+			fmt.Println(funcdocs)
-		for _, em := range v {
+			ff.WriteString("--- " + strings.Join(funcdocs, "\n--- ") + "\n")
-			var funcdocs []string
-			for _, dps := range docs[mod].Docs {
-				if dps.FuncName == em.FuncName {
-					funcdocs = dps.Doc
-				}
-			}
-			f.WriteString("--- " + strings.Join(funcdocs, "\n--- ") + "\n")
 			if len(em.Docs) != 0 {
-				f.WriteString(strings.Join(em.Docs, "\n") + "\n")
+				ff.WriteString(strings.Join(em.Docs, "\n") + "\n")
 			}
-			f.WriteString("function " + mod + "." + em.FuncName + "(" + strings.Join(em.Params, ", ") + ") end\n\n")
+			ff.WriteString("function " + modN + "." + em.FuncName + "(" + strings.Join(em.Params, ", ") + ") end\n\n")
 		}
-		f.WriteString("return " + mod + "\n")
+		ff.WriteString("return " + modN + "\n")
 	}
 }

docs/api/bait.md

@@ -12,9 +12,6 @@ happened, like when you've changed directory, a command has failed,
 etc. To find all available hooks thrown by Hilbish, see doc hooks.
 
 ## Functions
-### catch(name, cb)
-Catches a hook with `name`. Runs the `cb` when it is thrown
-
 ### catchOnce(name, cb)
 Same as catch, but only runs the `cb` once and then removes the hook
 
@@ -29,3 +26,6 @@ an event, like one saved to a variable.
 ### throw(name, ...args)
 Throws a hook with `name` with the provided `args`
 
+### catch(name, cb)
+Catches a hook with `name`. Runs the `cb` when it is thrown
+

docs/api/fs.md

@@ -10,9 +10,6 @@ and other things, and acts an addition to the Lua standard library's
 I/O and filesystem functions.
 
 ## Functions
-### abs(path)
-Gives an absolute version of `path`.
-
 ### basename(path)
 Gives the basename of `path`. For the rules,
 see Go's filepath.Base
@@ -24,6 +21,12 @@ Changes directory to `dir`
 Returns the directory part of `path`. For the rules, see Go's
 filepath.Dir
 
+### readdir(dir)
+Returns a table of files in `dir`
+
+### abs(path)
+Gives an absolute version of `path`.
+
 ### glob(pattern)
 Glob all files and directories that match the pattern.
 For the rules, see Go's filepath.Glob
@@ -35,9 +38,6 @@ directory separator (forward or backward slash).
 ### mkdir(name, recursive)
 Makes a directory called `name`. If `recursive` is true, it will create its parent directories.
 
-### readdir(dir)
-Returns a table of files in `dir`
-
 ### stat(path)
 Returns info about `path`
 

docs/api/hilbish.md

@@ -9,34 +9,19 @@ The Hilbish module includes the core API, containing
 interfaces and functions which directly relate to shell functionality.
 
 ## Functions
-### alias(cmd, orig)
+### runnerMode(mode)
-Sets an alias of `cmd` to `orig`
+Sets the execution/runner mode for interactive Hilbish. This determines whether
+Hilbish wll try to run input as Lua and/or sh or only do one of either.
+Accepted values for mode are hybrid (the default), hybridRev (sh first then Lua),
+sh, and lua. It also accepts a function, to which if it is passed one
+will call it to execute user input instead.
 
 ### appendPath(dir)
 Appends `dir` to $PATH
 
-### complete(scope, cb)
-Registers a completion handler for `scope`.
-A `scope` is currently only expected to be `command.<cmd>`,
-replacing <cmd> with the name of the command (for example `command.git`).
-`cb` must be a function that returns a table of "completion groups."
-Check `doc completions` for more information.
-
-### cwd()
-Returns the current directory of the shell
-
-### exec(cmd)
-Replaces running hilbish with `cmd`
-
 ### goro(fn)
 Puts `fn` in a goroutine
 
-### highlighter(line)
-Line highlighter handler. This is mainly for syntax highlighting, but in
-reality could set the input of the prompt to *display* anything. The
-callback is passed the current line and is expected to return a line that
-will be used as the input display.
-
 ### hinter(line, pos)
 The command line hint handler. It gets called on every key insert to
 determine what text to use as an inline hint. It is passed the current
@@ -44,6 +29,34 @@ line and cursor position. It is expected to return a string which is used
 as the text for the hint. This is by default a shim. To set hints,
 override this function with your custom handler.
 
+### read(prompt?) -> input?
+Read input from the user, using Hilbish's line editor/input reader.
+This is a separate instance from the one Hilbish actually uses.
+Returns `input`, will be nil if ctrl + d is pressed, or an error occurs (which shouldn't happen)
+
+### run(cmd, returnOut) -> exitCode, stdout, stderr
+Runs `cmd` in Hilbish's sh interpreter.
+If returnOut is true, the outputs of `cmd` will be returned as the 2nd and
+3rd values instead of being outputted to the terminal.
+
+### prompt(str, typ?)
+Changes the shell prompt to `str`
+There are a few verbs that can be used in the prompt text.
+These will be formatted and replaced with the appropriate values.
+`%d` - Current working directory
+`%u` - Name of current user
+`%h` - Hostname of device
+
+### timeout(cb, time)
+Runs the `cb` function after `time` in milliseconds
+Returns a `timer` object (see `doc timers`).
+
+### which(name)
+Checks if `name` is a valid command
+
+### exec(cmd)
+Replaces running hilbish with `cmd`
+
 ### inputMode(mode)
 Sets the input mode for Hilbish's line reader. Accepts either emacs or vim
 
@@ -57,35 +70,22 @@ Changes the continued line prompt to `str`
 ### prependPath(dir)
 Prepends `dir` to $PATH
 
-### prompt(str, typ?)
+### complete(scope, cb)
-Changes the shell prompt to `str`
+Registers a completion handler for `scope`.
-There are a few verbs that can be used in the prompt text.
+A `scope` is currently only expected to be `command.<cmd>`,
-These will be formatted and replaced with the appropriate values.
+replacing <cmd> with the name of the command (for example `command.git`).
-`%d` - Current working directory
+`cb` must be a function that returns a table of "completion groups."
-`%u` - Name of current user
+Check `doc completions` for more information.
-`%h` - Hostname of device
 
-### read(prompt?) -> input?
+### highlighter(line)
-Read input from the user, using Hilbish's line editor/input reader.
+Line highlighter handler. This is mainly for syntax highlighting, but in
-This is a separate instance from the one Hilbish actually uses.
+reality could set the input of the prompt to *display* anything. The
-Returns `input`, will be nil if ctrl + d is pressed, or an error occurs (which shouldn't happen)
+callback is passed the current line and is expected to return a line that
+will be used as the input display.
 
-### run(cmd, returnOut) -> exitCode, stdout, stderr
+### alias(cmd, orig)
-Runs `cmd` in Hilbish's sh interpreter.
+Sets an alias of `cmd` to `orig`
-If returnOut is true, the outputs of `cmd` will be returned as the 2nd and
-3rd values instead of being outputted to the terminal.
 
-### runnerMode(mode)
+### cwd()
-Sets the execution/runner mode for interactive Hilbish. This determines whether
+Returns the current directory of the shell
-Hilbish wll try to run input as Lua and/or sh or only do one of either.
-Accepted values for mode are hybrid (the default), hybridRev (sh first then Lua),
-sh, and lua. It also accepts a function, to which if it is passed one
-will call it to execute user input instead.
-
-### timeout(cb, time)
-Runs the `cb` function after `time` in milliseconds
-Returns a `timer` object (see `doc timers`).
-
-### which(name)
-Checks if `name` is a valid command
 

docs/api/main.md

@@ -0,0 +1,91 @@
+---
+name: Module main
+description: the core Hilbish API
+layout: apidoc
+---
+
+## Introduction
+The Hilbish module includes the core API, containing
+interfaces and functions which directly relate to shell functionality.
+
+## Functions
+### interval(cb, time)
+Runs the `cb` function every `time` milliseconds.
+Returns a `timer` object (see `doc timers`).
+
+### timeout(cb, time)
+Runs the `cb` function after `time` in milliseconds
+Returns a `timer` object (see `doc timers`).
+
+### cwd()
+Returns the current directory of the shell
+
+### goro(fn)
+Puts `fn` in a goroutine
+
+### prompt(str, typ?)
+Changes the shell prompt to `str`
+There are a few verbs that can be used in the prompt text.
+These will be formatted and replaced with the appropriate values.
+`%d` - Current working directory
+`%u` - Name of current user
+`%h` - Hostname of device
+
+### read(prompt?) -> input?
+Read input from the user, using Hilbish's line editor/input reader.
+This is a separate instance from the one Hilbish actually uses.
+Returns `input`, will be nil if ctrl + d is pressed, or an error occurs (which shouldn't happen)
+
+### run(cmd, returnOut) -> exitCode, stdout, stderr
+Runs `cmd` in Hilbish's sh interpreter.
+If returnOut is true, the outputs of `cmd` will be returned as the 2nd and
+3rd values instead of being outputted to the terminal.
+
+### hinter(line, pos)
+The command line hint handler. It gets called on every key insert to
+determine what text to use as an inline hint. It is passed the current
+line and cursor position. It is expected to return a string which is used
+as the text for the hint. This is by default a shim. To set hints,
+override this function with your custom handler.
+
+### inputMode(mode)
+Sets the input mode for Hilbish's line reader. Accepts either emacs or vim
+
+### multiprompt(str)
+Changes the continued line prompt to `str`
+
+### prependPath(dir)
+Prepends `dir` to $PATH
+
+### runnerMode(mode)
+Sets the execution/runner mode for interactive Hilbish. This determines whether
+Hilbish wll try to run input as Lua and/or sh or only do one of either.
+Accepted values for mode are hybrid (the default), hybridRev (sh first then Lua),
+sh, and lua. It also accepts a function, to which if it is passed one
+will call it to execute user input instead.
+
+### appendPath(dir)
+Appends `dir` to $PATH
+
+### highlighter(line)
+Line highlighter handler. This is mainly for syntax highlighting, but in
+reality could set the input of the prompt to *display* anything. The
+callback is passed the current line and is expected to return a line that
+will be used as the input display.
+
+### exec(cmd)
+Replaces running hilbish with `cmd`
+
+### which(name)
+Checks if `name` is a valid command
+
+### alias(cmd, orig)
+Sets an alias of `cmd` to `orig`
+
+### complete(scope, cb)
+Registers a completion handler for `scope`.
+A `scope` is currently only expected to be `command.<cmd>`,
+replacing <cmd> with the name of the command (for example `command.git`).
+`cb` must be a function that returns a table of "completion groups."
+Check `doc completions` for more information.
+

docs/api/terminal.md

@@ -8,6 +8,10 @@ layout: apidoc
 The terminal library is a simple and lower level library for certain terminal interactions.
 
 ## Functions
+### size()
+Gets the dimensions of the terminal. Returns a table with `width` and `height`
+Note: this is not the size in relation to the dimensions of the display
+
 ### restoreState()
 Restores the last saved state of the terminal
 
@@ -17,7 +21,3 @@ Saves the current state of the terminal
 ### setRaw()
 Puts the terminal in raw mode
 
-### size()
-Gets the dimensions of the terminal. Returns a table with `width` and `height`
-Note: this is not the size in relation to the dimensions of the display
-

emmyLuaDocs/main.lua

@@ -0,0 +1,110 @@
+--- @meta
+
+local main = {}
+
+--- Sets an alias of `cmd` to `orig`
+--- @param cmd string
+--- @param orig string
+function main.hlalias(cmd, orig) end
+
+--- Appends `dir` to $PATH
+--- @param dir string|table
+function main.hlappendPath(dir) end
+
+--- Registers a completion handler for `scope`.
+--- A `scope` is currently only expected to be `command.<cmd>`,
+--- replacing <cmd> with the name of the command (for example `command.git`).
+--- `cb` must be a function that returns a table of "completion groups."
+--- Check `doc completions` for more information.
+--- @param scope string
+--- @param cb function
+function main.hlcomplete(scope, cb) end
+
+--- Returns the current directory of the shell
+function main.hlcwd() end
+
+--- Replaces running hilbish with `cmd`
+--- @param cmd string
+function main.hlexec(cmd) end
+
+--- Puts `fn` in a goroutine
+--- @param fn function
+function main.hlgoro(fn) end
+
+--- Line highlighter handler. This is mainly for syntax highlighting, but in
+--- reality could set the input of the prompt to *display* anything. The
+--- callback is passed the current line and is expected to return a line that
+--- will be used as the input display.
+--- @param line string
+function main.hlhighlighter(line) end
+
+--- The command line hint handler. It gets called on every key insert to
+--- determine what text to use as an inline hint. It is passed the current
+--- line and cursor position. It is expected to return a string which is used
+--- as the text for the hint. This is by default a shim. To set hints,
+--- override this function with your custom handler.
+--- @param line string
+--- @param pos int
+function main.hlhinter(line, pos) end
+
+--- Sets the input mode for Hilbish's line reader. Accepts either emacs or vim
+--- @param mode string
+function main.hlinputMode(mode) end
+
+--- Runs the `cb` function every `time` milliseconds.
+--- Returns a `timer` object (see `doc timers`).
+--- @param cb function
+--- @param time number
+--- @return table
+function main.hlinterval(cb, time) end
+
+--- Changes the continued line prompt to `str`
+--- @param str string
+function main.hlmultiprompt(str) end
+
+--- Prepends `dir` to $PATH
+--- @param dir string
+function main.hlprependPath(dir) end
+
+--- Changes the shell prompt to `str`
+--- There are a few verbs that can be used in the prompt text.
+--- These will be formatted and replaced with the appropriate values.
+--- `%d` - Current working directory
+--- `%u` - Name of current user
+--- `%h` - Hostname of device
+--- @param str string
+--- @param typ string Type of prompt, being left or right. Left by default.
+function main.hlprompt(str, typ) end
+
+--- Read input from the user, using Hilbish's line editor/input reader.
+--- This is a separate instance from the one Hilbish actually uses.
+--- Returns `input`, will be nil if ctrl + d is pressed, or an error occurs (which shouldn't happen)
+--- @param prompt string
+function main.hlread(prompt) end
+
+--- Runs `cmd` in Hilbish's sh interpreter.
+--- If returnOut is true, the outputs of `cmd` will be returned as the 2nd and
+--- 3rd values instead of being outputted to the terminal.
+--- @param cmd string
+function main.hlrun(cmd) end
+
+--- Sets the execution/runner mode for interactive Hilbish. This determines whether
+--- Hilbish wll try to run input as Lua and/or sh or only do one of either.
+--- Accepted values for mode are hybrid (the default), hybridRev (sh first then Lua),
+--- sh, and lua. It also accepts a function, to which if it is passed one
+--- will call it to execute user input instead.
+--- @param mode string|function
+function main.hlrunnerMode(mode) end
+
+--- Runs the `cb` function after `time` in milliseconds
+--- Returns a `timer` object (see `doc timers`).
+--- @param cb function
+--- @param time number
+--- @return table
+function main.hltimeout(cb, time) end
+
+--- Checks if `name` is a valid command
+--- @param binName string
+function main.hlwhich(binName) end
+
+return main

timer.go

@@ -21,7 +21,7 @@ type timer struct{
 	running bool
 	dur time.Duration
 	fun *rt.Closure
-	th *timerHandler
+	th *timersModule
 	ticker *time.Ticker
 	ud *rt.UserData
 	channel chan struct{}

timerhandler.go

@@ -10,10 +10,10 @@ import (
 	rt "github.com/arnodel/golua/runtime"
 )
 
-var timers *timerHandler
+var timers *timersModule
 var timerMetaKey = rt.StringValue("hshtimer")
 
-type timerHandler struct {
+type timersModule struct {
 	mu *sync.RWMutex
 	wg *sync.WaitGroup
 	timers map[int]*timer
@@ -21,8 +21,8 @@ type timerHandler struct {
 	running int
 }
 
-func newTimerHandler() *timerHandler {
+func newTimersModule() *timersModule {
-	return &timerHandler{
+	return &timersModule{
 		timers: make(map[int]*timer),
 		latestID: 0,
 		mu: &sync.RWMutex{},
@@ -30,11 +30,11 @@ func newTimerHandler() *timerHandler {
 	}
 }
 
-func (th *timerHandler) wait() {
+func (th *timersModule) wait() {
 	th.wg.Wait()
 }
 
-func (th *timerHandler) create(typ timerType, dur time.Duration, fun *rt.Closure) *timer {
+func (th *timersModule) create(typ timerType, dur time.Duration, fun *rt.Closure) *timer {
 	th.mu.Lock()
 	defer th.mu.Unlock()
 
@@ -54,14 +54,14 @@ func (th *timerHandler) create(typ timerType, dur time.Duration, fun *rt.Closure
 	return t
 }
 
-func (th *timerHandler) get(id int) *timer {
+func (th *timersModule) get(id int) *timer {
 	th.mu.RLock()
 	defer th.mu.RUnlock()
 
 	return th.timers[id]
 }
 
-func (th *timerHandler) luaCreate(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
+func (th *timersModule) luaCreate(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 	if err := c.CheckNArgs(3); err != nil {
 		return nil, err
 	}
@@ -83,7 +83,7 @@ func (th *timerHandler) luaCreate(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 	return c.PushingNext1(t.Runtime, rt.UserDataValue(tmr.ud)), nil
 }
 
-func (th *timerHandler) luaGet(thr *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
+func (th *timersModule) luaGet(thr *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 	if err := c.Check1Arg(); err != nil {
 		return nil, err
 	}
@@ -100,7 +100,7 @@ func (th *timerHandler) luaGet(thr *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
 	return c.Next(), nil
 }
 
-func (th *timerHandler) loader(rtm *rt.Runtime) *rt.Table {
+func (th *timersModule) loader(rtm *rt.Runtime) *rt.Table {
 	timerMethods := rt.NewTable()
 	timerFuncs := map[string]util.LuaExport{
 		"start": {timerStart, 1, false},