diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 416c97e..29d2b83 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -36,7 +36,7 @@ jobs: fetch-depth: 0 - name: Download Task run: 'sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d' - - uses: wangyoucao577/go-release-action@v1.25 + - uses: wangyoucao577/go-release-action@v1 with: github_token: ${{ secrets.GITHUB_TOKEN }} goos: ${{ matrix.goos }} diff --git a/CHANGELOG.md b/CHANGELOG.md index 36b82da..0c12ab1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,20 +1,66 @@ # 🎀 Changelog ## Unreleased +### Fixed +- Line refresh fixes (less flicker) +- Do more checks for a TTY + - Panic if ENOTTY is thrown from readline + - use `x/term` function to check if a terminal + ### Added +- Page Up/Down keybinds for Greenhouse will now scroll up and down the size of the region (a page) + +### Changed +- Remove usage of `hilbish.goro` in Greenhouse. +- Values in `hilbish` table are no longer protected. This means +they can be overridden. (#287) + +## [2.2.1] - 2023-12-26 +### Fixed +- Removed a left over debug print +- Recover panic in `hilbish.goro` + +## [2.2.0] - 2023-12-25 +### Added +- [Native Modules](https://rosettea.github.io/Hilbish/docs/api/hilbish/hilbish.module/) - Made a few additions to the sink type: - `read()` method for retrieving input (so now the `in` sink of commanders is useful) - `flush()` and `autoFlush()` related to flushing outputs - `pipe` property to check if a sink with input is a pipe (like stdin) - Add fuzzy search to history search (enable via `hilbish.opts.fuzzy = true`) -- Show indexes on cdr list +- Show indexes on cdr list and use ~ for home directory. +- Fix doc command not displaying correct subdocs when using shorthand api doc access (`doc api hilbish.jobs` as an example) - `hilbish.messages` interface (details in [#219]) - `hilbish.notification` signal when a message/notification is sent - `notifyJobFinish` opt to send a notification when background jobs are +- `hilbish.goVersion` for the version of Go used to compile Hilbish. completed. +- Allow numbered arg substitutions in aliases. + - Example: `hilbish.alias('hello', 'echo %1 says hello')` allows the user to run `hello hilbish` + which will output `hilbish says hello`. +- Greenhouse + - Greenhouse is a pager library and program. Basic usage is `greenhouse ` + - Using this also brings enhancements to the `doc` command like easy + navigation of neighboring doc files. + Ctrl-N can be used for the table of contents, which views adjacent documentation. + +### Changed +- Documentation for EVERYTHING has been improved, with more +information added, code example, parameter details, etc. +You can see the improvements! +- Documentation has gotten an uplift in the `doc` command. +This includes: + - Proper highlighting of code + - Paging (via Greenhouse) + - Highlighting more markdown things -[#219]: https://github.com/Rosettea/Hilbish/issues/219 ### Fixed +- Fix panic when runner doesn't return a table +- Fix edge case of crash on empty alias resolve +- File completion on Windows +- Job management commands work now +- Fix infinite loop when navigating history without any history. [#252](https://github.com/Rosettea/Hilbish/issues/252) +- Return the prefix when calling `hilbish.completions.call`. [#219](https://github.com/Rosettea/Hilbish/issues/219) - Replaced `sed` in-place editing with `grep` and `mv` for compatibility with BSD utils ## [2.1.2] - 2022-04-10 @@ -662,6 +708,11 @@ This input for example will prompt for more input to complete: First "stable" release of Hilbish. +[2.2.2]: https://github.com/Rosettea/Hilbish/compare/v2.2.1...v2.2.2 +[2.2.1]: https://github.com/Rosettea/Hilbish/compare/v2.2.0...v2.2.1 +[2.2.0]: https://github.com/Rosettea/Hilbish/compare/v2.1.0...v2.2.0 +[2.1.2]: https://github.com/Rosettea/Hilbish/compare/v2.1.1...v2.1.2 +[2.1.1]: https://github.com/Rosettea/Hilbish/compare/v2.1.0...v2.1.1 [2.1.0]: https://github.com/Rosettea/Hilbish/compare/v2.0.1...v2.1.0 [2.0.1]: https://github.com/Rosettea/Hilbish/compare/v2.0.0...v2.0.1 [2.0.0]: https://github.com/Rosettea/Hilbish/compare/v1.2.0...v2.0.0 diff --git a/Taskfile.yaml b/Taskfile.yaml index 5c5caae..264e7d5 100644 --- a/Taskfile.yaml +++ b/Taskfile.yaml @@ -13,12 +13,22 @@ vars: tasks: default: + cmds: + - go build {{.GOFLAGS}} + vars: + GOFLAGS: '-ldflags "-s -w -X main.dataDir={{.LIBDIR}} -X main.gitCommit=$(git rev-parse --short HEAD) -X main.gitBranch=$(git rev-parse --abbrev-ref HEAD)"' + + default-nocgo: cmds: - CGO_ENABLED=0 go build {{.GOFLAGS}} vars: GOFLAGS: '-ldflags "-s -w -X main.dataDir={{.LIBDIR}} -X main.gitCommit=$(git rev-parse --short HEAD) -X main.gitBranch=$(git rev-parse --abbrev-ref HEAD)"' build: + cmds: + - go build {{.GOFLAGS}} + + build-nocgo: cmds: - CGO_ENABLED=0 go build {{.GOFLAGS}} diff --git a/aliases.go b/aliases.go index bfacc43..8c90fe5 100644 --- a/aliases.go +++ b/aliases.go @@ -1,6 +1,8 @@ package main import ( + "regexp" + "strconv" "strings" "sync" @@ -46,9 +48,32 @@ func (a *aliasModule) Resolve(cmdstr string) string { a.mu.RLock() defer a.mu.RUnlock() - args := strings.Split(cmdstr, " ") + arg, _ := regexp.Compile(`[\\]?%\d+`) + + args, _ := splitInput(cmdstr) + if len(args) == 0 { + // this shouldnt reach but...???? + return cmdstr + } + for a.aliases[args[0]] != "" { alias := a.aliases[args[0]] + alias = arg.ReplaceAllStringFunc(alias, func(a string) string { + idx, _ := strconv.Atoi(a[1:]) + if strings.HasPrefix(a, "\\") || idx == 0 { + return strings.TrimPrefix(a, "\\") + } + + if idx + 1 > len(args) { + return a + } + val := args[idx] + args = cut(args, idx) + cmdstr = strings.Join(args, " ") + + return val + }) + cmdstr = alias + strings.TrimPrefix(cmdstr, args[0]) cmdArgs, _ := splitInput(cmdstr) args = cmdArgs @@ -86,15 +111,23 @@ func (a *aliasModule) Loader(rtm *rt.Runtime) *rt.Table { // #interface aliases // add(alias, cmd) -// This is an alias (ha) for the `hilbish.alias` function. +// This is an alias (ha) for the [hilbish.alias](../#alias) function. // --- @param alias string // --- @param cmd string func _hlalias() {} // #interface aliases -// list() -> table +// list() -> table[string, string] // Get a table of all aliases, with string keys as the alias and the value as the command. -// --- @returns table +// #returns table[string, string] +/* +#example +hilbish.aliases.add('hi', 'echo hi') + +local aliases = hilbish.aliases.list() +-- -> {hi = 'echo hi'} +#example +*/ func (a *aliasModule) luaList(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { aliasesList := rt.NewTable() for k, v := range a.All() { @@ -107,7 +140,7 @@ func (a *aliasModule) luaList(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // #interface aliases // delete(name) // Removes an alias. -// --- @param name string +// #param name string func (a *aliasModule) luaDelete(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -122,10 +155,10 @@ func (a *aliasModule) luaDelete(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // #interface aliases -// resolve(alias) -> command (string) -// Tries to resolve an alias to its command. -// --- @param alias string -// --- @returns string +// resolve(alias) -> string? +// Resolves an alias to its original command. Will thrown an error if the alias doesn't exist. +// #param alias string +// #returns string func (a *aliasModule) luaResolve(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err diff --git a/api.go b/api.go index 61aac21..9470709 100644 --- a/api.go +++ b/api.go @@ -9,7 +9,7 @@ // #field interactive Is Hilbish in an interactive shell? // #field login Is Hilbish the login shell? // #field vimMode Current Vim input mode of Hilbish (will be nil if not in Vim input mode) -// #field exitCode xit code of the last executed command +// #field exitCode Exit code of the last executed command package main import ( @@ -59,47 +59,8 @@ var hilbishLoader = packagelib.Loader{ } func hilbishLoad(rtm *rt.Runtime) (rt.Value, func()) { - fakeMod := rt.NewTable() - modmt := rt.NewTable() mod := rt.NewTable() - modIndex := func(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { - arg := c.Arg(1) - val := mod.Get(arg) - - return c.PushingNext1(t.Runtime, val), nil - } - modNewIndex := func(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { - k, err := c.StringArg(1) - if err != nil { - return nil, err - } - - v := c.Arg(2) - if k == "highlighter" { - var err error - // fine to assign, since itll be either nil or a closure - highlighter, err = c.ClosureArg(2) - if err != nil { - return nil, errors.New("hilbish.highlighter has to be a function") - } - } else if k == "hinter" { - var err error - hinter, err = c.ClosureArg(2) - if err != nil { - return nil, errors.New("hilbish.hinter has to be a function") - } - } else if modVal := mod.Get(rt.StringValue(k)); modVal != rt.NilValue { - return nil, errors.New("not allowed to override in hilbish table") - } - mod.Set(rt.StringValue(k), v) - - return c.Next(), nil - } - modmt.Set(rt.StringValue("__newindex"), rt.FunctionValue(rt.NewGoFunction(modNewIndex, "__newindex", 3, false))) - modmt.Set(rt.StringValue("__index"), rt.FunctionValue(rt.NewGoFunction(modIndex, "__index", 2, false))) - fakeMod.SetMetatable(modmt) - util.SetExports(rtm, mod, exports) hshMod = mod @@ -110,16 +71,16 @@ func hilbishLoad(rtm *rt.Runtime) (rt.Value, func()) { username = strings.Split(username, "\\")[1] // for some reason Username includes the hostname on windows } - util.SetFieldProtected(fakeMod, mod, "ver", rt.StringValue(getVersion())) - util.SetFieldProtected(fakeMod, mod, "goVersion", rt.StringValue(runtime.Version())) - util.SetFieldProtected(fakeMod, mod, "user", rt.StringValue(username)) - util.SetFieldProtected(fakeMod, mod, "host", rt.StringValue(host)) - util.SetFieldProtected(fakeMod, mod, "home", rt.StringValue(curuser.HomeDir)) - util.SetFieldProtected(fakeMod, mod, "dataDir", rt.StringValue(dataDir)) - util.SetFieldProtected(fakeMod, mod, "interactive", rt.BoolValue(interactive)) - util.SetFieldProtected(fakeMod, mod, "login", rt.BoolValue(login)) - util.SetFieldProtected(fakeMod, mod, "vimMode", rt.NilValue) - util.SetFieldProtected(fakeMod, mod, "exitCode", rt.IntValue(0)) + util.SetField(rtm, mod, "ver", rt.StringValue(getVersion())) + util.SetField(rtm, mod, "goVersion", rt.StringValue(runtime.Version())) + util.SetField(rtm, mod, "user", rt.StringValue(username)) + util.SetField(rtm, mod, "host", rt.StringValue(host)) + util.SetField(rtm, mod, "home", rt.StringValue(curuser.HomeDir)) + util.SetField(rtm, mod, "dataDir", rt.StringValue(dataDir)) + util.SetField(rtm, mod, "interactive", rt.BoolValue(interactive)) + util.SetField(rtm, mod, "login", rt.BoolValue(login)) + util.SetField(rtm, mod, "vimMode", rt.NilValue) + util.SetField(rtm, mod, "exitCode", rt.IntValue(0)) // hilbish.userDir table hshuser := userDirLoader(rtm) @@ -140,7 +101,9 @@ func hilbishLoad(rtm *rt.Runtime) (rt.Value, func()) { // hilbish.completion table hshcomp := completionLoader(rtm) + // TODO: REMOVE "completion" AND ONLY USE "completions" WITH AN S mod.Set(rt.StringValue("completion"), rt.TableValue(hshcomp)) + mod.Set(rt.StringValue("completions"), rt.TableValue(hshcomp)) // hilbish.runner table runnerModule := runnerModeLoader(rtm) @@ -166,7 +129,10 @@ func hilbishLoad(rtm *rt.Runtime) (rt.Value, func()) { util.SetField(rtm, versionModule, "release", rt.StringValue(releaseName)) mod.Set(rt.StringValue("version"), rt.TableValue(versionModule)) - return rt.TableValue(fakeMod), nil + pluginModule := moduleLoader(rtm) + mod.Set(rt.StringValue("module"), rt.TableValue(pluginModule)) + + return rt.TableValue(mod), nil } func getenv(key, fallback string) string { @@ -187,12 +153,10 @@ func unsetVimMode() { } // run(cmd, returnOut) -> exitCode (number), stdout (string), stderr (string) -// 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 -// --- @param returnOut boolean -// --- @returns number, string, string +// Runs `cmd` in Hilbish's shell script interpreter. +// #param cmd string +// #param returnOut boolean If this is true, the function will return the standard output and error of the command instead of printing it. +// #returns number, string, string func hlrun(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -234,8 +198,8 @@ func hlrun(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // cwd() -> string -// Returns the current directory of the shell -// --- @returns string +// Returns the current directory of the shell. +// #returns string func hlcwd(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { cwd, _ := os.Getwd() @@ -246,9 +210,9 @@ func hlcwd(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // read(prompt) -> input (string) // 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 -// --- @returns string|nil +// Returns `input`, will be nil if Ctrl-D is pressed, or an error occurs. +// #param prompt? string Text to print before input, can be empty. +// #returns string|nil func hlread(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { luaprompt := c.Arg(0) if typ := luaprompt.Type(); typ != rt.StringType && typ != rt.NilType { @@ -276,14 +240,21 @@ func hlread(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { /* prompt(str, typ) -Changes the shell prompt to `str` +Changes the shell prompt to the provided string. 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. +#param str string +#param typ? string Type of prompt, being left or right. Left by default. +#example +-- the default hilbish prompt without color +hilbish.prompt '%u %d ∆' +-- or something of old: +hilbish.prompt '%u@%h :%d $' +-- prompt: user@hostname: ~/directory $ +#example */ func hlprompt(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { err := c.Check1Arg() @@ -317,8 +288,28 @@ func hlprompt(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // multiprompt(str) -// Changes the continued line prompt to `str` -// --- @param str string +// Changes the text prompt when Hilbish asks for more input. +// This will show up when text is incomplete, like a missing quote +// #param str string +/* +#example +--[[ +imagine this is your text input: +user ~ ∆ echo "hey + +but there's a missing quote! hilbish will now prompt you so the terminal +will look like: +user ~ ∆ echo "hey +--> ...!" + +so then you get +user ~ ∆ echo "hey +--> ...!" +hey ...! +]]-- +hilbish.multiprompt '-->' +#example +*/ func hlmultiprompt(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -333,9 +324,19 @@ func hlmultiprompt(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // alias(cmd, orig) -// Sets an alias of `cmd` to `orig` -// --- @param cmd string -// --- @param orig string +// Sets an alias, with a name of `cmd` to another command. +// #param cmd string Name of the alias +// #param orig string Command that will be aliased +/* +#example +-- With this, "ga file" will turn into "git add file" +hilbish.alias('ga', 'git add') + +-- Numbered substitutions are supported here! +hilbish.alias('dircount', 'ls %1 | wc -l') +-- "dircount ~" would count how many files are in ~ (home directory). +#example +*/ func hlalias(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.CheckNArgs(2); err != nil { return nil, err @@ -355,8 +356,20 @@ func hlalias(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // appendPath(dir) -// Appends `dir` to $PATH -// --- @param dir string|table +// Appends the provided dir to the command path (`$PATH`) +// #param dir string|table Directory (or directories) to append to path +/* +#example +hilbish.appendPath '~/go/bin' +-- Will add ~/go/bin to the command path. + +-- Or do multiple: +hilbish.appendPath { + '~/go/bin', + '~/.local/bin' +} +#example +*/ func hlappendPath(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -390,8 +403,9 @@ func appendPath(dir string) { } // exec(cmd) -// Replaces running hilbish with `cmd` -// --- @param cmd string +// Replaces the currently running Hilbish instance with the supplied command. +// This can be used to do an in-place restart. +// #param cmd string func hlexec(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -425,8 +439,11 @@ func hlexec(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // goro(fn) -// Puts `fn` in a goroutine -// --- @param fn function +// Puts `fn` in a Goroutine. +// This can be used to run any function in another thread at the same time as other Lua code. +// **NOTE: THIS FUNCTION MAY CRASH HILBISH IF OUTSIDE VARIABLES ARE ACCESSED.** +// **This is a limitation of the Lua runtime.** +// #param fn function func hlgoro(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -438,6 +455,12 @@ func hlgoro(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // call fn go func() { + defer func() { + if r := recover(); r != nil { + // do something here? + } + }() + _, err := rt.Call1(l.MainThread(), rt.FunctionValue(fn), c.Etc()...) if err != nil { fmt.Fprintln(os.Stderr, "Error in goro function:\n\n", err) @@ -448,11 +471,11 @@ func hlgoro(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // timeout(cb, time) -> @Timer -// Runs the `cb` function after `time` in milliseconds. -// This creates a timer that starts immediately. -// --- @param cb function -// --- @param time number -// --- @returns Timer +// Executed the `cb` function after a period of `time`. +// This creates a Timer that starts ticking immediately. +// #param cb function +// #param time number Time to run in milliseconds. +// #returns Timer func hltimeout(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.CheckNArgs(2); err != nil { return nil, err @@ -474,11 +497,11 @@ func hltimeout(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // interval(cb, time) -> @Timer -// Runs the `cb` function every `time` milliseconds. -// This creates a timer that starts immediately. -// --- @param cb function -// --- @param time number -// --- @return Timer +// Runs the `cb` function every specified amount of `time`. +// This creates a timer that ticking immediately. +// #param cb function +// #param time number Time in milliseconds. +// #return Timer func hlinterval(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.CheckNArgs(2); err != nil { return nil, err @@ -500,13 +523,40 @@ func hlinterval(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // complete(scope, cb) -// Registers a completion handler for `scope`. -// A `scope` is currently only expected to be `command.`, +// Registers a completion handler for the specified scope. +// A `scope` is expected to be `command.`, // replacing 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 +// The documentation for completions, under Features/Completions or `doc completions` +// provides more details. +// #param scope string +// #param cb function +/* +#example +-- This is a very simple example. Read the full doc for completions for details. +hilbish.complete('command.sudo', function(query, ctx, fields) + if #fields == 0 then + -- complete for commands + local comps, pfx = hilbish.completion.bins(query, ctx, fields) + local compGroup = { + items = comps, -- our list of items to complete + type = 'grid' -- what our completions will look like. + } + + return {compGroup}, pfx + end + + -- otherwise just be boring and return files + + local comps, pfx = hilbish.completion.files(query, ctx, fields) + local compGroup = { + items = comps, + type = 'grid' + } + + return {compGroup}, pfx +end) +#example +*/ func hlcomplete(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { scope, cb, err := util.HandleStrCallback(t, c) if err != nil { @@ -518,8 +568,8 @@ func hlcomplete(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // prependPath(dir) -// Prepends `dir` to $PATH -// --- @param dir string +// Prepends `dir` to $PATH. +// #param dir string func hlprependPath(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -542,8 +592,8 @@ func hlprependPath(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // which(name) -> string // Checks if `name` is a valid command. // Will return the path of the binary, or a basename if it's a commander. -// --- @param name string -// --- @returns string +// #param name string +// #returns string func hlwhich(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -573,8 +623,10 @@ func hlwhich(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // inputMode(mode) -// Sets the input mode for Hilbish's line reader. Accepts either emacs or vim -// --- @param mode string +// Sets the input mode for Hilbish's line reader. +// `emacs` is the default. Setting it to `vim` changes behavior of input to be +// Vim-like with modes and Vim keybinds. +// #param mode string Can be set to either `emacs` or `vim` func hlinputMode(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -599,12 +651,14 @@ func hlinputMode(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // 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. +// 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 +// Read [about runner mode](../features/runner-mode) for more information. +// #param mode string|function func hlrunnerMode(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -630,26 +684,33 @@ func hlrunnerMode(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // 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 number +// #param line string +// #param pos number Position of cursor in line. Usually equals string.len(line) +/* +#example +-- this will display "hi" after the cursor in a dimmed color. +function hilbish.hinter(line, pos) + return 'hi' +end +#example +*/ func hlhinter(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { return c.Next(), nil } // 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. +// 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. // Note that to set a highlighter, one has to override this function. -// Example: -// ``` +// #example +// --This code will highlight all double quoted strings in green. // function hilbish.highlighter(line) // return line:gsub('"%w+"', function(c) return lunacolors.green(c) end) // end -// ``` -// This code will highlight all double quoted strings in green. -// --- @param line string +// #example +// #param line string func hlhighlighter(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { return c.Next(), nil } diff --git a/cmd/docgen/docgen.go b/cmd/docgen/docgen.go index aae6202..86a622a 100644 --- a/cmd/docgen/docgen.go +++ b/cmd/docgen/docgen.go @@ -11,6 +11,8 @@ import ( "strings" "os" "sync" + + md "github.com/atsushinee/go-markdown-generator/doc" ) var header = `--- @@ -43,6 +45,12 @@ type module struct { HasTypes bool } +type param struct{ + Name string + Type string + Doc []string +} + type docPiece struct { Doc []string FuncSig string @@ -55,11 +63,14 @@ type docPiece struct { IsType bool Fields []docPiece Properties []docPiece + Params []param + Tags map[string][]tag } type tag struct { id string fields []string + startIdx int } var docs = make(map[string]module) @@ -80,7 +91,7 @@ func getTagsAndDocs(docs string) (map[string][]tag, []string) { parts := []string{} tags := make(map[string][]tag) - for _, part := range pts { + for idx, part := range pts { if strings.HasPrefix(part, "#") { tagParts := strings.Split(strings.TrimPrefix(part, "#"), " ") if tags[tagParts[0]] == nil { @@ -89,12 +100,21 @@ func getTagsAndDocs(docs string) (map[string][]tag, []string) { id = tagParts[1] } tags[tagParts[0]] = []tag{ - {id: id}, + {id: id, startIdx: idx}, } if len(tagParts) >= 2 { tags[tagParts[0]][0].fields = tagParts[2:] } } else { + if tagParts[0] == "example" { + exampleIdx := tags["example"][0].startIdx + exampleCode := pts[exampleIdx+1:idx] + + tags["example"][0].fields = exampleCode + parts = strings.Split(strings.Replace(strings.Join(parts, "\n"), strings.TrimPrefix(strings.Join(exampleCode, "\n"), "#example\n"), "", -1), "\n") + continue + } + fleds := []string{} if len(tagParts) >= 2 { fleds = tagParts[2:] @@ -179,6 +199,7 @@ func setupDocType(mod string, typ *doc.Type) *docPiece { ParentModule: parentMod, Fields: fields, Properties: properties, + Tags: tags, } typeTable[strings.ToLower(typeName)] = []string{parentMod, interfaces} @@ -215,6 +236,17 @@ start: fields := docPieceTag("field", tags) properties := docPieceTag("property", tags) + var params []param + if paramsRaw := tags["param"]; paramsRaw != nil { + params = make([]param, len(paramsRaw)) + for i, p := range paramsRaw { + params[i] = param{ + Name: p.id, + Type: p.fields[0], + Doc: p.fields[1:], + } + } + } for _, d := range doc { if strings.HasPrefix(d, "---") { @@ -252,6 +284,8 @@ start: ParentModule: parentMod, Fields: fields, Properties: properties, + Params: params, + Tags: tags, } if strings.HasSuffix(dps.GoFuncName, strings.ToLower("loader")) { dps.Doc = parts @@ -412,13 +446,14 @@ func main() { defer wg.Done() modOrIface := "Module" if modu.ParentModule != "" { - modOrIface = "Interface" + modOrIface = "Module" } + lastHeader := "" f, _ := os.Create(docPath) f.WriteString(fmt.Sprintf(header, modOrIface, modname, modu.ShortDescription)) - typeTag, _ := regexp.Compile(`@\w+`) - modDescription := typeTag.ReplaceAllStringFunc(strings.Replace(modu.Description, "<", `\<`, -1), func(typ string) string { + typeTag, _ := regexp.Compile(`\B@\w+`) + modDescription := typeTag.ReplaceAllStringFunc(strings.Replace(strings.Replace(modu.Description, "<", `\<`, -1), "{{\\<", "{{<", -1), func(typ string) string { typName := typ[1:] typLookup := typeTable[strings.ToLower(typName)] ifaces := typLookup[0] + "." + typLookup[1] + "/" @@ -429,32 +464,77 @@ func main() { return fmt.Sprintf(`%s`, linkedTyp, typName) }) f.WriteString(fmt.Sprintf("## Introduction\n%s\n\n", modDescription)) - if len(modu.Fields) != 0 { - f.WriteString("## Interface fields\n") - for _, dps := range modu.Fields { - f.WriteString(fmt.Sprintf("- `%s`: ", dps.FuncName)) - f.WriteString(strings.Join(dps.Doc, " ")) - f.WriteString("\n") - } - f.WriteString("\n") - } - if len(modu.Properties) != 0 { - f.WriteString("## Object properties\n") - for _, dps := range modu.Properties { - f.WriteString(fmt.Sprintf("- `%s`: ", dps.FuncName)) - f.WriteString(strings.Join(dps.Doc, " ")) - f.WriteString("\n") - } - f.WriteString("\n") - } - if len(modu.Docs) != 0 { - f.WriteString("## Functions\n") + funcCount := 0 for _, dps := range modu.Docs { if dps.IsMember { continue } - htmlSig := typeTag.ReplaceAllStringFunc(strings.Replace(dps.FuncSig, "<", `\<`, -1), func(typ string) string { + funcCount++ + } + + f.WriteString("## Functions\n") + lastHeader = "functions" + + mdTable := md.NewTable(funcCount, 2) + mdTable.SetTitle(0, "") + mdTable.SetTitle(1, "") + + diff := 0 + for i, dps := range modu.Docs { + if dps.IsMember { + diff++ + continue + } + + mdTable.SetContent(i - diff, 0, fmt.Sprintf(`%s`, dps.FuncName, dps.FuncSig)) + mdTable.SetContent(i - diff, 1, dps.Doc[0]) + } + f.WriteString(mdTable.String()) + f.WriteString("\n") + } + + if len(modu.Fields) != 0 { + f.WriteString("## Static module fields\n") + + mdTable := md.NewTable(len(modu.Fields), 2) + mdTable.SetTitle(0, "") + mdTable.SetTitle(1, "") + + + for i, dps := range modu.Fields { + mdTable.SetContent(i, 0, dps.FuncName) + mdTable.SetContent(i, 1, strings.Join(dps.Doc, " ")) + } + f.WriteString(mdTable.String()) + f.WriteString("\n") + } + if len(modu.Properties) != 0 { + f.WriteString("## Object properties\n") + + mdTable := md.NewTable(len(modu.Fields), 2) + mdTable.SetTitle(0, "") + mdTable.SetTitle(1, "") + + + for i, dps := range modu.Properties { + mdTable.SetContent(i, 0, dps.FuncName) + mdTable.SetContent(i, 1, strings.Join(dps.Doc, " ")) + } + f.WriteString(mdTable.String()) + f.WriteString("\n") + } + + if len(modu.Docs) != 0 { + if lastHeader != "functions" { + f.WriteString("## Functions\n") + } + for _, dps := range modu.Docs { + if dps.IsMember { + continue + } + f.WriteString(fmt.Sprintf("
\n
", dps.FuncName)) + htmlSig := typeTag.ReplaceAllStringFunc(strings.Replace(modname + "." + dps.FuncSig, "<", `\<`, -1), func(typ string) string { typName := typ[1:] typLookup := typeTable[strings.ToLower(typName)] ifaces := typLookup[0] + "." + typLookup[1] + "/" @@ -462,21 +542,55 @@ func main() { ifaces = "" } linkedTyp := fmt.Sprintf("/Hilbish/docs/api/%s/%s#%s", typLookup[0], ifaces, strings.ToLower(typName)) - return fmt.Sprintf(`%s`, linkedTyp, typName) + return fmt.Sprintf(`%s`, linkedTyp, typName) }) - f.WriteString(fmt.Sprintf("### %s\n", htmlSig)) + f.WriteString(fmt.Sprintf(` +

+%s + + + +

+ +`, htmlSig, dps.FuncName)) for _, doc := range dps.Doc { - if !strings.HasPrefix(doc, "---") { - f.WriteString(doc + "\n") + if !strings.HasPrefix(doc, "---") && doc != "" { + f.WriteString(doc + " \n") } } - f.WriteString("\n") + f.WriteString("\n#### Parameters\n") + if len(dps.Params) == 0 { + f.WriteString("This function has no parameters. \n") + } + for _, p := range dps.Params { + isVariadic := false + typ := p.Type + if strings.HasPrefix(p.Type, "...") { + isVariadic = true + typ = p.Type[3:] + } + + f.WriteString(fmt.Sprintf("`%s` **`%s`**", typ, p.Name)) + if isVariadic { + f.WriteString(" (This type is variadic. You can pass an infinite amount of parameters with this type.)") + } + f.WriteString(" \n") + f.WriteString(strings.Join(p.Doc, " ")) + f.WriteString("\n\n") + } + if codeExample := dps.Tags["example"]; codeExample != nil { + f.WriteString("#### Example\n") + f.WriteString(fmt.Sprintf("```lua\n%s\n```\n", strings.Join(codeExample[0].fields, "\n"))) + } + f.WriteString("
") + f.WriteString("\n\n") } } if len(modu.Types) != 0 { f.WriteString("## Types\n") for _, dps := range modu.Types { + f.WriteString("
\n\n") f.WriteString(fmt.Sprintf("## %s\n", dps.FuncName)) for _, doc := range dps.Doc { if !strings.HasPrefix(doc, "---") { @@ -484,12 +598,18 @@ func main() { } } if len(dps.Properties) != 0 { - f.WriteString("### Properties\n") - for _, dps := range dps.Properties { - f.WriteString(fmt.Sprintf("- `%s`: ", dps.FuncName)) - f.WriteString(strings.Join(dps.Doc, " ")) - f.WriteString("\n") + f.WriteString("## Object properties\n") + + mdTable := md.NewTable(len(dps.Properties), 2) + mdTable.SetTitle(0, "") + mdTable.SetTitle(1, "") + + for i, d := range dps.Properties { + mdTable.SetContent(i, 0, d.FuncName) + mdTable.SetContent(i, 1, strings.Join(d.Doc, " ")) } + f.WriteString(mdTable.String()) + f.WriteString("\n") } f.WriteString("\n") f.WriteString("### Methods\n") diff --git a/cmd/docgen/docgen.lua b/cmd/docgen/docgen.lua new file mode 100644 index 0000000..207357a --- /dev/null +++ b/cmd/docgen/docgen.lua @@ -0,0 +1,146 @@ +local fs = require 'fs' +local emmyPattern = '^%-%-%- (.+)' +local modpattern = '^%-+ @module (%w+)' +local pieces = {} + +local files = fs.readdir 'nature' +for _, fname in ipairs(files) do + local isScript = fname:match'%.lua$' + if not isScript then goto continue end + + local f = io.open(string.format('nature/%s', fname)) + local header = f:read '*l' + local mod = header:match(modpattern) + if not mod then goto continue end + + print(fname, mod) + pieces[mod] = {} + + local docPiece = {} + local lines = {} + local lineno = 0 + for line in f:lines() do + lineno = lineno + 1 + lines[lineno] = line + + if line == header then goto continue2 end + if not line:match(emmyPattern) then + if line:match '^function' then + local pattern = (string.format('^function %s%%.', mod) .. '(%w+)') + local funcName = line:match(pattern) + if not funcName then goto continue2 end + + local dps = { + description = {}, + params = {} + } + + local offset = 1 + while true do + local prev = lines[lineno - offset] + + local docline = prev:match '^%-+ (.+)' + if docline then + local emmy = docline:match '@(%w+)' + local cut = 0 + + if emmy then cut = emmy:len() + 3 end + local emmythings = string.split(docline:sub(cut), ' ') + + if emmy then + if emmy == 'param' then + table.insert(dps.params, 1, { + name = emmythings[1], + type = emmythings[2] + }) + end + else + table.insert(dps.description, 1, docline) + end + offset = offset + 1 + else + break + end + end + + pieces[mod][funcName] = dps + end + docPiece = {} + goto continue2 + end + + table.insert(docPiece, line) + ::continue2:: + end + ::continue:: +end + +local header = [[--- +title: %s %s +description: %s +layout: doc +menu: + docs: + parent: "Nature" +--- + +]] + +for iface, dps in pairs(pieces) do + local mod = iface:match '(%w+)%.' or 'nature' + local path = string.format('docs/%s/%s.md', mod, iface) + fs.mkdir(fs.dir(path), true) + local f = io.open(path, 'w') + f:write(string.format(header, 'Module', iface, 'No description.')) + print(f) + + print(mod, path) + + for func, docs in pairs(dps) do + f:write(string.format('
\n
', func)) + local sig = string.format('%s.%s(', iface, func) + for idx, param in ipairs(docs.params) do + sig = sig .. ((param.name:gsub('%?$', ''))) + if idx ~= #docs.params then sig = sig .. ', ' end + end + sig = sig .. ')' + f:write(string.format([[ +

+%s + + + +

+ +]], sig, func)) + + f:write(table.concat(docs.description, '\n') .. '\n') + f:write '#### Parameters\n' + if #docs.params == 0 then + f:write 'This function has no parameters. \n' + end + for _, param in ipairs(docs.params) do + f:write(string.format('`%s` **`%s`**\n', param.name:gsub('%?$', ''), param.type)) + end + --[[ + local params = table.filter(docs, function(t) + return t:match '^%-%-%- @param' + end) + for i, str in ipairs(params) do + if i ~= 1 then + f:write ', ' + end + f:write(str:match '^%-%-%- @param ([%w]+) ') + end + f:write(')\n') + + for _, str in ipairs(docs) do + if not str:match '^%-%-%- @' then + f:write(str:match '^%-%-%- (.+)' .. '\n') + end + end + ]]-- + f:write('
') + f:write('\n\n') + end +end diff --git a/complete.go b/complete.go index 51b426f..71d92fb 100644 --- a/complete.go +++ b/complete.go @@ -188,15 +188,15 @@ func escapeFilename(fname string) string { return escapeReplaer.Replace(fname) } -// #interface completions +// #interface completion // tab completions // The completions interface deals with tab completions. func completionLoader(rtm *rt.Runtime) *rt.Table { exports := map[string]util.LuaExport{ - "files": {luaFileComplete, 3, false}, - "bins": {luaBinaryComplete, 3, false}, - "call": {callLuaCompleter, 4, false}, - "handler": {completionHandler, 2, false}, + "bins": {hcmpBins, 3, false}, + "call": {hcmpCall, 4, false}, + "files": {hcmpFiles, 3, false}, + "handler": {hcmpHandler, 2, false}, } mod := rt.NewTable() @@ -205,27 +205,58 @@ func completionLoader(rtm *rt.Runtime) *rt.Table { return mod } -// #interface completions -// handler(line, pos) -// The handler function is the callback for tab completion in Hilbish. -// You can check the completions doc for more info. -// --- @param line string -// --- @param pos string -func completionHandler(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { - return c.Next(), nil +// #interface completion +// bins(query, ctx, fields) -> entries (table), prefix (string) +// Return binaries/executables based on the provided parameters. +// This function is meant to be used as a helper in a command completion handler. +// #param query string +// #param ctx string +// #param fields table +/* +#example +-- an extremely simple completer for sudo. +hilbish.complete('command.sudo', function(query, ctx, fields) + table.remove(fields, 1) + if #fields[1] then + -- return commands because sudo runs a command as root..! + + local entries, pfx = hilbish.completion.bins(query, ctx, fields) + return { + type = 'grid', + items = entries + }, pfx + end + + -- ... else suggest files or anything else .. +end) +#example +*/ +func hcmpBins(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { + query, ctx, fds, err := getCompleteParams(t, c) + if err != nil { + return nil, err + } + + completions, pfx := binaryComplete(query, ctx, fds) + luaComps := rt.NewTable() + + for i, comp := range completions { + luaComps.Set(rt.IntValue(int64(i + 1)), rt.StringValue(comp)) + } + + return c.PushingNext(t.Runtime, rt.TableValue(luaComps), rt.StringValue(pfx)), nil } -// #interface completions +// #interface completion // call(name, query, ctx, fields) -> completionGroups (table), prefix (string) -// Calls a completer function. This is mainly used to call -// a command completer, which will have a `name` in the form -// of `command.name`, example: `command.git`. -// You can check `doc completions` for info on the `completionGroups` return value. -// --- @param name string -// --- @param query string -// --- @param ctx string -// --- @param fields table -func callLuaCompleter(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { +// Calls a completer function. This is mainly used to call a command completer, which will have a `name` +// in the form of `command.name`, example: `command.git`. +// You can check the Completions doc or `doc completions` for info on the `completionGroups` return value. +// #param name string +// #param query string +// #param ctx string +// #param fields table +func hcmpCall(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.CheckNArgs(4); err != nil { return nil, err } @@ -253,24 +284,26 @@ func callLuaCompleter(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // we must keep the holy 80 cols - completerReturn, err := rt.Call1(l.MainThread(), - rt.FunctionValue(completecb), rt.StringValue(query), - rt.StringValue(ctx), rt.TableValue(fields)) + cont := c.Next() + err = rt.Call(l.MainThread(), rt.FunctionValue(completecb), + []rt.Value{rt.StringValue(query), rt.StringValue(ctx), rt.TableValue(fields)}, + cont) if err != nil { return nil, err } - return c.PushingNext1(t.Runtime, completerReturn), nil + return cont, nil } -// #interface completions +// #interface completion // files(query, ctx, fields) -> entries (table), prefix (string) -// Returns file completion candidates based on the provided query. -// --- @param query string -// --- @param ctx string -// --- @param fields table -func luaFileComplete(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { +// Returns file matches based on the provided parameters. +// This function is meant to be used as a helper in a command completion handler. +// #param query string +// #param ctx string +// #param fields table +func hcmpFiles(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { query, ctx, fds, err := getCompleteParams(t, c) if err != nil { return nil, err @@ -286,28 +319,32 @@ func luaFileComplete(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { return c.PushingNext(t.Runtime, rt.TableValue(luaComps), rt.StringValue(pfx)), nil } -// #interface completions -// bins(query, ctx, fields) -> entries (table), prefix (string) -// Returns binary/executale completion candidates based on the provided query. -// --- @param query string -// --- @param ctx string -// --- @param fields table -func luaBinaryComplete(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { - query, ctx, fds, err := getCompleteParams(t, c) - if err != nil { - return nil, err - } +// #interface completion +// handler(line, pos) +// This function contains the general completion handler for Hilbish. This function handles +// completion of everything, which includes calling other command handlers, binaries, and files. +// This function can be overriden to supply a custom handler. Note that alias resolution is required to be done in this function. +// #param line string The current Hilbish command line +// #param pos number Numerical position of the cursor +/* +#example +-- stripped down version of the default implementation +function hilbish.completion.handler(line, pos) + local query = fields[#fields] - completions, pfx := binaryComplete(query, ctx, fds) - luaComps := rt.NewTable() - - for i, comp := range completions { - luaComps.Set(rt.IntValue(int64(i + 1)), rt.StringValue(comp)) - } - - return c.PushingNext(t.Runtime, rt.TableValue(luaComps), rt.StringValue(pfx)), nil + if #fields == 1 then + -- call bins handler here + else + -- call command completer or files completer here + end +end +#example +*/ +func hcmpHandler(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { + return c.Next(), nil } + func getCompleteParams(t *rt.Thread, c *rt.GoCont) (string, string, []string, error) { if err := c.CheckNArgs(3); err != nil { return "", "", []string{}, err diff --git a/website/content/docs/_index.md b/docs/_index.md similarity index 100% rename from website/content/docs/_index.md rename to docs/_index.md diff --git a/docs/api/_index.md b/docs/api/_index.md index 8c9f722..f34539e 100644 --- a/docs/api/_index.md +++ b/docs/api/_index.md @@ -1,7 +1,7 @@ --- title: API layout: doc -weight: -50 +weight: -100 menu: docs --- diff --git a/docs/api/bait.md b/docs/api/bait.md index a70eb17..60b1056 100644 --- a/docs/api/bait.md +++ b/docs/api/bait.md @@ -8,27 +8,160 @@ menu: --- ## Introduction -Bait is the event emitter for Hilbish. Why name it bait? Why not. -It throws hooks that you can catch. This is what you will use if -you want to listen in on hooks to know when certain things have -happened, like when you've changed directory, a command has failed, -etc. To find all available hooks thrown by Hilbish, see doc hooks. + +Bait is the event emitter for Hilbish. Much like Node.js and +its `events` system, many actions in Hilbish emit events. +Unlike Node.js, Hilbish events are global. So make sure to +pick a unique name! + +Usage of the Bait module consists of userstanding +event-driven architecture, but it's pretty simple: +If you want to act on a certain event, you can `catch` it. +You can act on events via callback functions. + +Examples of this are in the Hilbish default config! +Consider this part of it: +```lua +bait.catch('command.exit', function(code) + running = false + doPrompt(code ~= 0) + doNotifyPrompt() +end) +``` + +What this does is, whenever the `command.exit` event is thrown, +this function will set the user prompt. ## Functions -### catch(name, cb) -Catches a hook with `name`. Runs the `cb` when it is thrown +||| +|----|----| +|catch(name, cb)|Catches an event. This function can be used to act on events.| +|catchOnce(name, cb)|Catches an event, but only once. This will remove the hook immediately after it runs for the first time.| +|hooks(name) -> table|Returns a table of functions that are hooked on an event with the corresponding `name`.| +|release(name, catcher)|Removes the `catcher` for the event with `name`.| +|throw(name, ...args)|Throws a hook with `name` with the provided `args`.| -### catchOnce(name, cb) -Same as catch, but only runs the `cb` once and then removes the hook +
+
+

+bait.catch(name, cb) + + + +

-### hooks(name) -> table -Returns a table with hooks (callback functions) on the event with `name`. +Catches an event. This function can be used to act on events. -### release(name, catcher) -Removes the `catcher` for the event with `name`. -For this to work, `catcher` has to be the same function used to catch -an event, like one saved to a variable. +#### Parameters +`string` **`name`** +The name of the hook. -### throw(name, ...args) -Throws a hook with `name` with the provided `args` +`function` **`cb`** +The function that will be called when the hook is thrown. + +#### Example +```lua +bait.catch('hilbish.exit', function() + print 'Goodbye Hilbish!' +end) +``` +
+ +
+
+

+bait.catchOnce(name, cb) + + + +

+ +Catches an event, but only once. This will remove the hook immediately after it runs for the first time. + +#### Parameters +`string` **`name`** +The name of the event + +`function` **`cb`** +The function that will be called when the event is thrown. + +
+ +
+
+

+bait.hooks(name) -> table + + + +

+ +Returns a table of functions that are hooked on an event with the corresponding `name`. + +#### Parameters +`string` **`name`** +The name of the hook + +
+ +
+
+

+bait.release(name, catcher) + + + +

+ +Removes the `catcher` for the event with `name`. +For this to work, `catcher` has to be the same function used to catch +an event, like one saved to a variable. + +#### Parameters +`string` **`name`** +Name of the event the hook is on + +`function` **`catcher`** +Hook function to remove + +#### Example +```lua +local hookCallback = function() print 'hi' end + +bait.catch('event', hookCallback) + +-- a little while later.... +bait.release('event', hookCallback) +-- and now hookCallback will no longer be ran for the event. +``` +
+ +
+
+

+bait.throw(name, ...args) + + + +

+ +Throws a hook with `name` with the provided `args`. + +#### Parameters +`string` **`name`** +The name of the hook. + +`any` **`args`** (This type is variadic. You can pass an infinite amount of parameters with this type.) +The arguments to pass to the hook. + +#### Example +```lua +bait.throw('greeting', 'world') + +-- This can then be listened to via +bait.catch('gretting', function(greetTo) + print('Hello ' .. greetTo) +end) +``` +
diff --git a/docs/api/commander.md b/docs/api/commander.md index 341eeda..03ece54 100644 --- a/docs/api/commander.md +++ b/docs/api/commander.md @@ -9,11 +9,10 @@ menu: ## Introduction -Commander is a library for writing custom commands in Lua. -In order to make it easier to write commands for Hilbish, -not require separate scripts and to be able to use in a config, -the Commander library exists. This is like a very simple wrapper -that works with Hilbish for writing commands. Example: +Commander is the library which handles Hilbish commands. This makes +the user able to add Lua-written commands to their shell without making +a separate script in a bin folder. Instead, you may simply use the Commander +library in your Hilbish config. ```lua local commander = require 'commander' @@ -28,19 +27,67 @@ that will print `Hello world!` to output. One question you may have is: What is the `sinks` parameter? The `sinks` parameter is a table with 3 keys: `in`, `out`, -and `err`. The values of these is a Sink. +and `err`. All of them are a Sink. -- `in` is the standard input. You can read from this sink -to get user input. (**This is currently unimplemented.**) -- `out` is standard output. This is usually where text meant for -output should go. -- `err` is standard error. This sink is for writing errors, as the -name would suggest. +- `in` is the standard input. +You may use the read functions on this sink to get input from the user. +- `out` is standard output. +This is usually where command output should go. +- `err` is standard error. +This sink is for writing errors, as the name would suggest. ## Functions -### deregister(name) -Deregisters any command registered with `name` +||| +|----|----| +|deregister(name)|Removes the named command. Note that this will only remove Commander-registered commands.| +|register(name, cb)|Adds a new command with the given `name`. When Hilbish has to run a command with a name,| -### register(name, cb) -Register a command with `name` that runs `cb` when ran +
+
+

+commander.deregister(name) + + + +

+ +Removes the named command. Note that this will only remove Commander-registered commands. + +#### Parameters +`string` **`name`** +Name of the command to remove. + +
+ +
+
+

+commander.register(name, cb) + + + +

+ +Adds a new command with the given `name`. When Hilbish has to run a command with a name, +it will run the function providing the arguments and sinks. + +#### Parameters +`string` **`name`** +Name of the command + +`function` **`cb`** +Callback to handle command invocation + +#### Example +```lua +-- When you run the command `hello` in the shell, it will print `Hello world`. +-- If you run it with, for example, `hello Hilbish`, it will print 'Hello Hilbish' +commander.register('hello', function(args, sinks) + local name = 'world' + if #args > 0 then name = args[1] end + + sinks.out:writeln('Hello ' .. name) +end) +``` +
diff --git a/docs/api/fs.md b/docs/api/fs.md index ee6949f..bc14055 100644 --- a/docs/api/fs.md +++ b/docs/api/fs.md @@ -8,44 +8,233 @@ menu: --- ## Introduction -The fs module provides easy and simple access to filesystem functions -and other things, and acts an addition to the Lua standard library's -I/O and filesystem functions. + +The fs module provides filesystem functions to Hilbish. While Lua's standard +library has some I/O functions, they're missing a lot of the basics. The `fs` +library offers more functions and will work on any operating system Hilbish does. ## Functions -### abs(path) -> string -Gives an absolute version of `path`. +||| +|----|----| +|abs(path) -> string|Returns an absolute version of the `path`.| +|basename(path) -> string|Returns the "basename," or the last part of the provided `path`. If path is empty,| +|cd(dir)|Changes Hilbish's directory to `dir`.| +|dir(path) -> string|Returns the directory part of `path`. If a file path like| +|glob(pattern) -> matches (table)|Match all files based on the provided `pattern`.| +|join(...path) -> string|Takes any list of paths and joins them based on the operating system's path separator.| +|mkdir(name, recursive)|Creates a new directory with the provided `name`.| +|readdir(path) -> table[string]|Returns a list of all files and directories in the provided path.| +|stat(path) -> {}|Returns the information about a given `path`.| -### basename(path) -> string -Gives the basename of `path`. For the rules, -see Go's filepath.Base +## Static module fields +||| +|----|----| +|pathSep|The operating system's path separator.| -### cd(dir) -Changes directory to `dir` +
+
+

+fs.abs(path) -> string + + + +

-### dir(path) -> string -Returns the directory part of `path`. For the rules, see Go's -filepath.Dir +Returns an absolute version of the `path`. +This can be used to resolve short paths like `..` to `/home/user`. -### glob(pattern) -> matches (table) -Glob all files and directories that match the pattern. -For the rules, see Go's filepath.Glob +#### Parameters +`string` **`path`** -### join(...) -> string -Takes paths and joins them together with the OS's -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`. +
+
+

+fs.basename(path) -> string + + + +

-### stat(path) -> {} -Returns a table of info about the `path`. -It contains the following keys: -name (string) - Name of the path -size (number) - Size of the path -mode (string) - Permission mode in an octal format string (with leading 0) -isDir (boolean) - If the path is a directory +Returns the "basename," or the last part of the provided `path`. If path is empty, +`.` will be returned. + +#### Parameters +`string` **`path`** +Path to get the base name of. + +
+ +
+
+

+fs.cd(dir) + + + +

+ +Changes Hilbish's directory to `dir`. + +#### Parameters +`string` **`dir`** +Path to change directory to. + +
+ +
+
+

+fs.dir(path) -> string + + + +

+ +Returns the directory part of `path`. If a file path like +`~/Documents/doc.txt` then this function will return `~/Documents`. + +#### Parameters +`string` **`path`** +Path to get the directory for. + +
+ +
+
+

+fs.glob(pattern) -> matches (table) + + + +

+ +Match all files based on the provided `pattern`. +For the syntax' refer to Go's filepath.Match function: https://pkg.go.dev/path/filepath#Match + +#### Parameters +`string` **`pattern`** +Pattern to compare files with. + +#### Example +```lua +--[[ + Within a folder that contains the following files: + a.txt + init.lua + code.lua + doc.pdf +]]-- +local matches = fs.glob './*.lua' +print(matches) +-- -> {'init.lua', 'code.lua'} +``` +
+ +
+
+

+fs.join(...path) -> string + + + +

+ +Takes any list of paths and joins them based on the operating system's path separator. + +#### Parameters +`string` **`path`** (This type is variadic. You can pass an infinite amount of parameters with this type.) +Paths to join together + +#### Example +```lua +-- This prints the directory for Hilbish's config! +print(fs.join(hilbish.userDir.config, 'hilbish')) +-- -> '/home/user/.config/hilbish' on Linux +``` +
+ +
+
+

+fs.mkdir(name, recursive) + + + +

+ +Creates a new directory with the provided `name`. +With `recursive`, mkdir will create parent directories. + +#### Parameters +`string` **`name`** +Name of the directory + +`boolean` **`recursive`** +Whether to create parent directories for the provided name + +#### Example +```lua +-- This will create the directory foo, then create the directory bar in the +-- foo directory. If recursive is false in this case, it will fail. +fs.mkdir('./foo/bar', true) +``` +
+ +
+
+

+fs.readdir(path) -> table[string] + + + +

+ +Returns a list of all files and directories in the provided path. + +#### Parameters +`string` **`dir`** + + +
+ +
+
+

+fs.stat(path) -> {} + + + +

+ +Returns the information about a given `path`. +The returned table contains the following values: +name (string) - Name of the path +size (number) - Size of the path in bytes +mode (string) - Unix permission mode in an octal format string (with leading 0) +isDir (boolean) - If the path is a directory + +#### Parameters +`string` **`path`** + + +#### Example +```lua +local inspect = require 'inspect' + +local stat = fs.stat '~' +print(inspect(stat)) +--[[ +Would print the following: +{ + isDir = true, + mode = "0755", + name = "username", + size = 12288 +} +]]-- +``` +
diff --git a/docs/api/hilbish/_index.md b/docs/api/hilbish/_index.md index 4cf0180..b79dcde 100644 --- a/docs/api/hilbish/_index.md +++ b/docs/api/hilbish/_index.md @@ -11,108 +11,490 @@ menu: The Hilbish module includes the core API, containing interfaces and functions which directly relate to shell functionality. -## Interface fields -- `ver`: The version of Hilbish -- `goVersion`: The version of Go that Hilbish was compiled with -- `user`: Username of the user -- `host`: Hostname of the machine -- `dataDir`: Directory for Hilbish data files, including the docs and default modules -- `interactive`: Is Hilbish in an interactive shell? -- `login`: Is Hilbish the login shell? -- `vimMode`: Current Vim input mode of Hilbish (will be nil if not in Vim input mode) -- `exitCode`: xit code of the last executed command - ## Functions -### alias(cmd, orig) -Sets an alias of `cmd` to `orig` +||| +|----|----| +|alias(cmd, orig)|Sets an alias, with a name of `cmd` to another command.| +|appendPath(dir)|Appends the provided dir to the command path (`$PATH`)| +|complete(scope, cb)|Registers a completion handler for the specified scope.| +|cwd() -> string|Returns the current directory of the shell.| +|exec(cmd)|Replaces the currently running Hilbish instance with the supplied command.| +|goro(fn)|Puts `fn` in a Goroutine.| +|highlighter(line)|Line highlighter handler.| +|hinter(line, pos)|The command line hint handler. It gets called on every key insert to| +|inputMode(mode)|Sets the input mode for Hilbish's line reader.| +|interval(cb, time) -> @Timer|Runs the `cb` function every specified amount of `time`.| +|multiprompt(str)|Changes the text prompt when Hilbish asks for more input.| +|prependPath(dir)|Prepends `dir` to $PATH.| +|prompt(str, typ)|Changes the shell prompt to the provided string.| +|read(prompt) -> input (string)|Read input from the user, using Hilbish's line editor/input reader.| +|run(cmd, returnOut) -> exitCode (number), stdout (string), stderr (string)|Runs `cmd` in Hilbish's shell script interpreter.| +|runnerMode(mode)|Sets the execution/runner mode for interactive Hilbish.| +|timeout(cb, time) -> @Timer|Executed the `cb` function after a period of `time`.| +|which(name) -> string|Checks if `name` is a valid command.| -### appendPath(dir) -Appends `dir` to $PATH +## Static module fields +||| +|----|----| +|ver|The version of Hilbish| +|goVersion|The version of Go that Hilbish was compiled with| +|user|Username of the user| +|host|Hostname of the machine| +|dataDir|Directory for Hilbish data files, including the docs and default modules| +|interactive|Is Hilbish in an interactive shell?| +|login|Is Hilbish the login shell?| +|vimMode|Current Vim input mode of Hilbish (will be nil if not in Vim input mode)| +|exitCode|Exit code of the last executed command| -### complete(scope, cb) -Registers a completion handler for `scope`. -A `scope` is currently only expected to be `command.`, -replacing 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. +
+
+

+hilbish.alias(cmd, orig) + + + +

-### cwd() -> string -Returns the current directory of the shell +Sets an alias, with a name of `cmd` to another command. -### exec(cmd) -Replaces running hilbish with `cmd` +#### Parameters +`string` **`cmd`** +Name of the alias -### goro(fn) -Puts `fn` in a goroutine +`string` **`orig`** +Command that will be aliased -### 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. -Note that to set a highlighter, one has to override this function. -Example: +#### Example +```lua +-- With this, "ga file" will turn into "git add file" +hilbish.alias('ga', 'git add') + +-- Numbered substitutions are supported here! +hilbish.alias('dircount', 'ls %1 | wc -l') +-- "dircount ~" would count how many files are in ~ (home directory). ``` +
+ +
+
+

+hilbish.appendPath(dir) + + + +

+ +Appends the provided dir to the command path (`$PATH`) + +#### Parameters +`string|table` **`dir`** +Directory (or directories) to append to path + +#### Example +```lua +hilbish.appendPath '~/go/bin' +-- Will add ~/go/bin to the command path. + +-- Or do multiple: +hilbish.appendPath { + '~/go/bin', + '~/.local/bin' +} +``` +
+ +
+
+

+hilbish.complete(scope, cb) + + + +

+ +Registers a completion handler for the specified scope. +A `scope` is expected to be `command.`, +replacing with the name of the command (for example `command.git`). +The documentation for completions, under Features/Completions or `doc completions` +provides more details. + +#### Parameters +`string` **`scope`** + + +`function` **`cb`** + + +#### Example +```lua +-- This is a very simple example. Read the full doc for completions for details. +hilbish.complete('command.sudo', function(query, ctx, fields) + if #fields == 0 then + -- complete for commands + local comps, pfx = hilbish.completion.bins(query, ctx, fields) + local compGroup = { + items = comps, -- our list of items to complete + type = 'grid' -- what our completions will look like. + } + + return {compGroup}, pfx + end + + -- otherwise just be boring and return files + + local comps, pfx = hilbish.completion.files(query, ctx, fields) + local compGroup = { + items = comps, + type = 'grid' + } + + return {compGroup}, pfx +end) +``` +
+ +
+
+

+hilbish.cwd() -> string + + + +

+ +Returns the current directory of the shell. + +#### Parameters +This function has no parameters. +
+ +
+
+

+hilbish.exec(cmd) + + + +

+ +Replaces the currently running Hilbish instance with the supplied command. +This can be used to do an in-place restart. + +#### Parameters +`string` **`cmd`** + + +
+ +
+
+

+hilbish.goro(fn) + + + +

+ +Puts `fn` in a Goroutine. +This can be used to run any function in another thread at the same time as other Lua code. +**NOTE: THIS FUNCTION MAY CRASH HILBISH IF OUTSIDE VARIABLES ARE ACCESSED.** +**This is a limitation of the Lua runtime.** + +#### Parameters +`function` **`fn`** + + +
+ +
+
+

+hilbish.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. +Note that to set a highlighter, one has to override this function. + +#### Parameters +`string` **`line`** + + +#### Example +```lua +--This code will highlight all double quoted strings in green. function hilbish.highlighter(line) return line:gsub('"%w+"', function(c) return lunacolors.green(c) end) end ``` -This code will highlight all double quoted strings in green. +
-### 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. +
+
+

+hilbish.hinter(line, pos) + + + +

-### inputMode(mode) -Sets the input mode for Hilbish's line reader. Accepts either emacs or vim +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. -### interval(cb, time) -> Timer -Runs the `cb` function every `time` milliseconds. -This creates a timer that starts immediately. +#### Parameters +`string` **`line`** -### multiprompt(str) -Changes the continued line prompt to `str` -### prependPath(dir) -Prepends `dir` to $PATH +`number` **`pos`** +Position of cursor in line. Usually equals string.len(line) -### 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 +#### Example +```lua +-- this will display "hi" after the cursor in a dimmed color. +function hilbish.hinter(line, pos) + return 'hi' +end +``` +
-### read(prompt) -> input (string) -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) +
+
+

+hilbish.inputMode(mode) + + + +

-### run(cmd, returnOut) -> exitCode (number), stdout (string), stderr (string) -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. +Sets the input mode for Hilbish's line reader. +`emacs` is the default. Setting it to `vim` changes behavior of input to be +Vim-like with modes and Vim keybinds. -### 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. +#### Parameters +`string` **`mode`** +Can be set to either `emacs` or `vim` -### timeout(cb, time) -> Timer -Runs the `cb` function after `time` in milliseconds. -This creates a timer that starts immediately. +
-### which(name) -> string -Checks if `name` is a valid command. -Will return the path of the binary, or a basename if it's a commander. +
+
+

+hilbish.interval(cb, time) -> Timer + + + +

+ +Runs the `cb` function every specified amount of `time`. +This creates a timer that ticking immediately. + +#### Parameters +`function` **`cb`** + + +`number` **`time`** +Time in milliseconds. + +
+ +
+
+

+hilbish.multiprompt(str) + + + +

+ +Changes the text prompt when Hilbish asks for more input. +This will show up when text is incomplete, like a missing quote + +#### Parameters +`string` **`str`** + + +#### Example +```lua +--[[ +imagine this is your text input: +user ~ ∆ echo "hey + +but there's a missing quote! hilbish will now prompt you so the terminal +will look like: +user ~ ∆ echo "hey +--> ...!" + +so then you get +user ~ ∆ echo "hey +--> ...!" +hey ...! +]]-- +hilbish.multiprompt '-->' +``` +
+ +
+
+

+hilbish.prependPath(dir) + + + +

+ +Prepends `dir` to $PATH. + +#### Parameters +`string` **`dir`** + + +
+ +
+
+

+hilbish.prompt(str, typ) + + + +

+ +Changes the shell prompt to the provided string. +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 + +#### Parameters +`string` **`str`** + + +`string` **`typ?`** +Type of prompt, being left or right. Left by default. + +#### Example +```lua +-- the default hilbish prompt without color +hilbish.prompt '%u %d ∆' +-- or something of old: +hilbish.prompt '%u@%h :%d $' +-- prompt: user@hostname: ~/directory $ +``` +
+ +
+
+

+hilbish.read(prompt) -> input (string) + + + +

+ +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. + +#### Parameters +`string` **`prompt?`** +Text to print before input, can be empty. + +
+ +
+
+

+hilbish.run(cmd, returnOut) -> exitCode (number), stdout (string), stderr (string) + + + +

+ +Runs `cmd` in Hilbish's shell script interpreter. + +#### Parameters +`string` **`cmd`** + + +`boolean` **`returnOut`** +If this is true, the function will return the standard output and error of the command instead of printing it. + +
+ +
+
+

+hilbish.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. +Read [about runner mode](../features/runner-mode) for more information. + +#### Parameters +`string|function` **`mode`** + + +
+ +
+
+

+hilbish.timeout(cb, time) -> Timer + + + +

+ +Executed the `cb` function after a period of `time`. +This creates a Timer that starts ticking immediately. + +#### Parameters +`function` **`cb`** + + +`number` **`time`** +Time to run in milliseconds. + +
+ +
+
+

+hilbish.which(name) -> string + + + +

+ +Checks if `name` is a valid command. +Will return the path of the binary, or a basename if it's a commander. + +#### Parameters +`string` **`name`** + + +
## Types +
+ ## Sink A sink is a structure that has input and/or output to/from a desination. @@ -126,7 +508,10 @@ A call with no argument will toggle the value. Flush writes all buffered input to the sink. #### read() -> string -Reads input from the sink. +Reads a liine of input from the sink. + +#### readAll() -> string +Reads all input from the sink. #### write(str) Writes data to a sink. diff --git a/docs/api/hilbish/hilbish.aliases.md b/docs/api/hilbish/hilbish.aliases.md index bae5bfc..e0a6f48 100644 --- a/docs/api/hilbish/hilbish.aliases.md +++ b/docs/api/hilbish/hilbish.aliases.md @@ -1,5 +1,5 @@ --- -title: Interface hilbish.aliases +title: Module hilbish.aliases description: command aliasing layout: doc menu: @@ -11,15 +11,81 @@ menu: The alias interface deals with all command aliases in Hilbish. ## Functions -### add(alias, cmd) -This is an alias (ha) for the `hilbish.alias` function. +||| +|----|----| +|add(alias, cmd)|This is an alias (ha) for the [hilbish.alias](../#alias) function.| +|delete(name)|Removes an alias.| +|list() -> table[string, string]|Get a table of all aliases, with string keys as the alias and the value as the command.| +|resolve(alias) -> string?|Resolves an alias to its original command. Will thrown an error if the alias doesn't exist.| -### delete(name) -Removes an alias. +
+
+

+hilbish.aliases.add(alias, cmd) + + + +

-### list() -> table\ -Get a table of all aliases, with string keys as the alias and the value as the command. +This is an alias (ha) for the [hilbish.alias](../#alias) function. -### resolve(alias) -> command (string) -Tries to resolve an alias to its command. +#### Parameters +This function has no parameters. +
+ +
+
+

+hilbish.aliases.delete(name) + + + +

+ +Removes an alias. + +#### Parameters +`string` **`name`** + + +
+ +
+
+

+hilbish.aliases.list() -> table[string, string] + + + +

+ +Get a table of all aliases, with string keys as the alias and the value as the command. + +#### Parameters +This function has no parameters. +#### Example +```lua +hilbish.aliases.add('hi', 'echo hi') + +local aliases = hilbish.aliases.list() +-- -> {hi = 'echo hi'} +``` +
+ +
+
+

+hilbish.aliases.resolve(alias) -> string? + + + +

+ +Resolves an alias to its original command. Will thrown an error if the alias doesn't exist. + +#### Parameters +`string` **`alias`** + + +
diff --git a/docs/api/hilbish/hilbish.completion.md b/docs/api/hilbish/hilbish.completion.md new file mode 100644 index 0000000..be6c094 --- /dev/null +++ b/docs/api/hilbish/hilbish.completion.md @@ -0,0 +1,149 @@ +--- +title: Module hilbish.completion +description: tab completions +layout: doc +menu: + docs: + parent: "API" +--- + +## Introduction +The completions interface deals with tab completions. + +## Functions +||| +|----|----| +|bins(query, ctx, fields) -> entries (table), prefix (string)|Return binaries/executables based on the provided parameters.| +|call(name, query, ctx, fields) -> completionGroups (table), prefix (string)|Calls a completer function. This is mainly used to call a command completer, which will have a `name`| +|files(query, ctx, fields) -> entries (table), prefix (string)|Returns file matches based on the provided parameters.| +|handler(line, pos)|This function contains the general completion handler for Hilbish. This function handles| + +
+
+

+hilbish.completion.bins(query, ctx, fields) -> entries (table), prefix (string) + + + +

+ +Return binaries/executables based on the provided parameters. +This function is meant to be used as a helper in a command completion handler. + +#### Parameters +`string` **`query`** + + +`string` **`ctx`** + + +`table` **`fields`** + + +#### Example +```lua +-- an extremely simple completer for sudo. +hilbish.complete('command.sudo', function(query, ctx, fields) + table.remove(fields, 1) + if #fields[1] then + -- return commands because sudo runs a command as root..! + + local entries, pfx = hilbish.completion.bins(query, ctx, fields) + return { + type = 'grid', + items = entries + }, pfx + end + + -- ... else suggest files or anything else .. +end) +``` +
+ +
+
+

+hilbish.completion.call(name, query, ctx, fields) -> completionGroups (table), prefix (string) + + + +

+ +Calls a completer function. This is mainly used to call a command completer, which will have a `name` +in the form of `command.name`, example: `command.git`. +You can check the Completions doc or `doc completions` for info on the `completionGroups` return value. + +#### Parameters +`string` **`name`** + + +`string` **`query`** + + +`string` **`ctx`** + + +`table` **`fields`** + + +
+ +
+
+

+hilbish.completion.files(query, ctx, fields) -> entries (table), prefix (string) + + + +

+ +Returns file matches based on the provided parameters. +This function is meant to be used as a helper in a command completion handler. + +#### Parameters +`string` **`query`** + + +`string` **`ctx`** + + +`table` **`fields`** + + +
+ +
+
+

+hilbish.completion.handler(line, pos) + + + +

+ +This function contains the general completion handler for Hilbish. This function handles +completion of everything, which includes calling other command handlers, binaries, and files. +This function can be overriden to supply a custom handler. Note that alias resolution is required to be done in this function. + +#### Parameters +`string` **`line`** +The current Hilbish command line + +`number` **`pos`** +Numerical position of the cursor + +#### Example +```lua +-- stripped down version of the default implementation +function hilbish.completion.handler(line, pos) + local query = fields[#fields] + + if #fields == 1 then + -- call bins handler here + else + -- call command completer or files completer here + end +end +``` +
+ diff --git a/docs/api/hilbish/hilbish.completions.md b/docs/api/hilbish/hilbish.completions.md deleted file mode 100644 index 6f8740f..0000000 --- a/docs/api/hilbish/hilbish.completions.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Interface hilbish.completions -description: tab completions -layout: doc -menu: - docs: - parent: "API" ---- - -## Introduction -The completions interface deals with tab completions. - -## Functions -### call(name, query, ctx, fields) -> completionGroups (table), prefix (string) -Calls a completer function. This is mainly used to call -a command completer, which will have a `name` in the form -of `command.name`, example: `command.git`. -You can check `doc completions` for info on the `completionGroups` return value. - -### handler(line, pos) -The handler function is the callback for tab completion in Hilbish. -You can check the completions doc for more info. - -### bins(query, ctx, fields) -> entries (table), prefix (string) -Returns binary/executale completion candidates based on the provided query. - -### files(query, ctx, fields) -> entries (table), prefix (string) -Returns file completion candidates based on the provided query. - diff --git a/docs/api/hilbish/hilbish.editor.md b/docs/api/hilbish/hilbish.editor.md index 30a3842..c70b605 100644 --- a/docs/api/hilbish/hilbish.editor.md +++ b/docs/api/hilbish/hilbish.editor.md @@ -1,5 +1,5 @@ --- -title: Interface hilbish.editor +title: Module hilbish.editor description: interactions for Hilbish's line reader layout: doc menu: @@ -12,15 +12,92 @@ The hilbish.editor interface provides functions to directly interact with the line editor in use. ## Functions -### getLine() -> string -Returns the current input line. +||| +|----|----| +|getLine() -> string|Returns the current input line.| +|getVimRegister(register) -> string|Returns the text that is at the register.| +|insert(text)|Inserts text into the Hilbish command line.| +|getChar() -> string|Reads a keystroke from the user. This is in a format of something like Ctrl-L.| +|setVimRegister(register, text)|Sets the vim register at `register` to hold the passed text.| -### getVimRegister(register) -> string -Returns the text that is at the register. +
+
+

+hilbish.editor.getLine() -> string + + + +

-### insert(text) -Inserts text into the line. +Returns the current input line. -### setVimRegister(register, text) -Sets the vim register at `register` to hold the passed text. +#### Parameters +This function has no parameters. +
+ +
+
+

+hilbish.editor.getVimRegister(register) -> string + + + +

+ +Returns the text that is at the register. + +#### Parameters +`string` **`register`** + + +
+ +
+
+

+hilbish.editor.insert(text) + + + +

+ +Inserts text into the Hilbish command line. + +#### Parameters +`string` **`text`** + + +
+ +
+
+

+hilbish.editor.getChar() -> string + + + +

+ +Reads a keystroke from the user. This is in a format of something like Ctrl-L. + +#### Parameters +This function has no parameters. +
+ +
+
+

+hilbish.editor.setVimRegister(register, text) + + + +

+ +Sets the vim register at `register` to hold the passed text. + +#### Parameters +`string` **`text`** + + +
diff --git a/docs/api/hilbish/hilbish.history.md b/docs/api/hilbish/hilbish.history.md index 9fa9b01..6de9bdf 100644 --- a/docs/api/hilbish/hilbish.history.md +++ b/docs/api/hilbish/hilbish.history.md @@ -1,5 +1,5 @@ --- -title: Interface hilbish.history +title: Module hilbish.history description: command history layout: doc menu: @@ -13,18 +13,90 @@ This includes the ability to override functions to change the main method of saving history. ## Functions -### add(cmd) -Adds a command to the history. +||| +|----|----| +|add(cmd)|Adds a command to the history.| +|all() -> table|Retrieves all history as a table.| +|clear()|Deletes all commands from the history.| +|get(index)|Retrieves a command from the history based on the `index`.| +|size() -> number|Returns the amount of commands in the history.| -### all() -> table -Retrieves all history. +
+
+

+hilbish.history.add(cmd) + + + +

-### clear() -Deletes all commands from the history. +Adds a command to the history. -### get(idx) -Retrieves a command from the history based on the `idx`. +#### Parameters +`string` **`cmd`** -### size() -> number -Returns the amount of commands in the history. + +
+ +
+
+

+hilbish.history.all() -> table + + + +

+ +Retrieves all history as a table. + +#### Parameters +This function has no parameters. +
+ +
+
+

+hilbish.history.clear() + + + +

+ +Deletes all commands from the history. + +#### Parameters +This function has no parameters. +
+ +
+
+

+hilbish.history.get(index) + + + +

+ +Retrieves a command from the history based on the `index`. + +#### Parameters +`number` **`index`** + + +
+ +
+
+

+hilbish.history.size() -> number + + + +

+ +Returns the amount of commands in the history. + +#### Parameters +This function has no parameters. +
diff --git a/docs/api/hilbish/hilbish.jobs.md b/docs/api/hilbish/hilbish.jobs.md index e41be2c..fe3978f 100644 --- a/docs/api/hilbish/hilbish.jobs.md +++ b/docs/api/hilbish/hilbish.jobs.md @@ -1,5 +1,5 @@ --- -title: Interface hilbish.jobs +title: Module hilbish.jobs description: background job management layout: doc menu: @@ -15,32 +15,120 @@ Jobs are the name of background tasks/commands. A job can be started via interactive usage or with the functions defined below for use in external runners. ## Functions -### add(cmdstr, args, execPath) -Adds a new job to the job table. Note that this does not immediately run it. +||| +|----|----| +|add(cmdstr, args, execPath)|Creates a new job. This function does not run the job. This function is intended to be| +|all() -> table[@Job]|Returns a table of all job objects.| +|disown(id)|Disowns a job. This simply deletes it from the list of jobs without stopping it.| +|get(id) -> @Job|Get a job object via its ID.| +|last() -> @Job|Returns the last added job to the table.| -### all() -> table\<Job> -Returns a table of all job objects. +
+
+

+hilbish.jobs.add(cmdstr, args, execPath) + + + +

-### disown(id) -Disowns a job. This deletes it from the job table. +Creates a new job. This function does not run the job. This function is intended to be +used by runners, but can also be used to create jobs via Lua. Commanders cannot be ran as jobs. -### get(id) -> Job -Get a job object via its ID. +#### Parameters +`string` **`cmdstr`** +String that a user would write for the job -### last() -> Job -Returns the last added job from the table. +`table` **`args`** +Arguments for the commands. Has to include the name of the command. + +`string` **`execPath`** +Binary to use to run the command. Needs to be an absolute path. + +#### Example +```lua +hilbish.jobs.add('go build', {'go', 'build'}, '/usr/bin/go') +``` +
+ +
+
+

+hilbish.jobs.all() -> table[Job] + + + +

+ +Returns a table of all job objects. + +#### Parameters +This function has no parameters. +
+ +
+
+

+hilbish.jobs.disown(id) + + + +

+ +Disowns a job. This simply deletes it from the list of jobs without stopping it. + +#### Parameters +`number` **`id`** + + +
+ +
+
+

+hilbish.jobs.get(id) -> Job + + + +

+ +Get a job object via its ID. + +#### Parameters +This function has no parameters. +
+ +
+
+

+hilbish.jobs.last() -> Job + + + +

+ +Returns the last added job to the table. + +#### Parameters +This function has no parameters. +
## Types +
+ ## Job The Job type describes a Hilbish job. -### Properties -- `cmd`: The user entered command string for the job. -- `running`: Whether the job is running or not. -- `id`: The ID of the job in the job table -- `pid`: The Process ID -- `exitCode`: The last exit code of the job. -- `stdout`: The standard output of the job. This just means the normal logs of the process. -- `stderr`: The standard error stream of the process. This (usually) includes error messages of the job. +## Object properties +||| +|----|----| +|cmd|The user entered command string for the job.| +|running|Whether the job is running or not.| +|id|The ID of the job in the job table| +|pid|The Process ID| +|exitCode|The last exit code of the job.| +|stdout|The standard output of the job. This just means the normal logs of the process.| +|stderr|The standard error stream of the process. This (usually) includes error messages of the job.| + ### Methods #### background() diff --git a/docs/api/hilbish/hilbish.module.md b/docs/api/hilbish/hilbish.module.md new file mode 100644 index 0000000..4029d7a --- /dev/null +++ b/docs/api/hilbish/hilbish.module.md @@ -0,0 +1,73 @@ +--- +title: Module hilbish.module +description: native module loading +layout: doc +menu: + docs: + parent: "API" +--- + +## Introduction + +The hilbish.module interface provides a function to load +Hilbish plugins/modules. Hilbish modules are Go-written +plugins (see https://pkg.go.dev/plugin) that are used to add functionality +to Hilbish that cannot be written in Lua for any reason. + +Note that you don't ever need to use the load function that is here as +modules can be loaded with a `require` call like Lua C modules, and the +search paths can be changed with the `paths` property here. + +To make a valid native module, the Go plugin has to export a Loader function +with a signature like so: `func(*rt.Runtime) rt.Value`. + +`rt` in this case refers to the Runtime type at +https://pkg.go.dev/github.com/arnodel/golua@master/runtime#Runtime + +Hilbish uses this package as its Lua runtime. You will need to read +it to use it for a native plugin. + +Here is some code for an example plugin: +```go +package main + +import ( + rt "github.com/arnodel/golua/runtime" +) + +func Loader(rtm *rt.Runtime) rt.Value { + return rt.StringValue("hello world!") +} +``` + +This can be compiled with `go build -buildmode=plugin plugin.go`. +If you attempt to require and print the result (`print(require 'plugin')`), it will show "hello world!" + +## Functions +||| +|----|----| +|load(path)|Loads a module at the designated `path`.| + +## Static module fields +||| +|----|----| +|paths|A list of paths to search when loading native modules. This is in the style of Lua search paths and will be used when requiring native modules. Example: `?.so;?/?.so`| + +
+
+

+hilbish.module.load(path) + + + +

+ +Loads a module at the designated `path`. +It will throw if any error occurs. + +#### Parameters +`string` **`path`** + + +
+ diff --git a/docs/api/hilbish/hilbish.os.md b/docs/api/hilbish/hilbish.os.md index aa2198e..13b56b0 100644 --- a/docs/api/hilbish/hilbish.os.md +++ b/docs/api/hilbish/hilbish.os.md @@ -1,6 +1,6 @@ --- -title: Interface hilbish.os -description: OS Info +title: Module hilbish.os +description: operating system info layout: doc menu: docs: @@ -8,12 +8,13 @@ menu: --- ## Introduction -The `os` interface provides simple text information properties about -the current OS on the systen. This mainly includes the name and -version. +Provides simple text information properties about the current operating system. +This mainly includes the name and version. -## Interface fields -- `family`: Family name of the current OS -- `name`: Pretty name of the current OS -- `version`: Version of the current OS +## Static module fields +||| +|----|----| +|family|Family name of the current OS| +|name|Pretty name of the current OS| +|version|Version of the current OS| diff --git a/docs/api/hilbish/hilbish.runner.md b/docs/api/hilbish/hilbish.runner.md index 68ffdc6..b5cfde4 100644 --- a/docs/api/hilbish/hilbish.runner.md +++ b/docs/api/hilbish/hilbish.runner.md @@ -1,5 +1,5 @@ --- -title: Interface hilbish.runner +title: Module hilbish.runner description: interactive command runner customization layout: doc menu: @@ -8,24 +8,107 @@ menu: --- ## Introduction -The runner interface contains functions that allow the user to change + The runner interface contains functions that allow the user to change how Hilbish interprets interactive input. Users can add and change the default runner for interactive input to any language or script of their choosing. A good example is using it to write command in Fennel. +Runners are functions that evaluate user input. The default runners in +Hilbish can run shell script and Lua code. + +A runner is passed the input and has to return a table with these values. +All are not required, only the useful ones the runner needs to return. +(So if there isn't an error, just omit `err`.) + +- `exitCode` (number): A numerical code to indicate the exit result. +- `input` (string): The user input. This will be used to add +to the history. +- `err` (string): A string to indicate an interal error for the runner. +It can be set to a few special values for Hilbish to throw the right hooks and have a better looking message: + +`[command]: not-found` will throw a command.not-found hook based on what `[command]` is. + +`[command]: not-executable` will throw a command.not-executable hook. +- `continue` (boolean): Whether to prompt the user for more input. + +Here is a simple example of a fennel runner. It falls back to +shell script if fennel eval has an error. +```lua +local fennel = require 'fennel' + +hilbish.runnerMode(function(input) + local ok = pcall(fennel.eval, input) + if ok then + return { + input = input + } + end + + return hilbish.runner.sh(input) +end) +``` + ## Functions -### setMode(cb) -This is the same as the `hilbish.runnerMode` function. It takes a callback, -which will be used to execute all interactive input. -In normal cases, neither callbacks should be overrided by the user, -as the higher level functions listed below this will handle it. +||| +|----|----| +|setMode(cb)|This is the same as the `hilbish.runnerMode` function.| +|lua(cmd)|Evaluates `cmd` as Lua input. This is the same as using `dofile`| +|sh(cmd)|Runs a command in Hilbish's shell script interpreter.| -### lua(cmd) -Evaluates `cmd` as Lua input. This is the same as using `dofile` -or `load`, but is appropriated for the runner interface. +
+
+

+hilbish.runner.setMode(cb) + + + +

-### sh(cmd) -Runs a command in Hilbish's shell script interpreter. -This is the equivalent of using `source`. +This is the same as the `hilbish.runnerMode` function. +It takes a callback, which will be used to execute all interactive input. +In normal cases, neither callbacks should be overrided by the user, +as the higher level functions listed below this will handle it. + +#### Parameters +`function` **`cb`** + + +
+ +
+
+

+hilbish.runner.lua(cmd) + + + +

+ +Evaluates `cmd` as Lua input. This is the same as using `dofile` +or `load`, but is appropriated for the runner interface. + +#### Parameters +`string` **`cmd`** + + +
+ +
+
+

+hilbish.runner.sh(cmd) + + + +

+ +Runs a command in Hilbish's shell script interpreter. +This is the equivalent of using `source`. + +#### Parameters +`string` **`cmd`** + + +
diff --git a/docs/api/hilbish/hilbish.timers.md b/docs/api/hilbish/hilbish.timers.md index e899d1d..f218d2b 100644 --- a/docs/api/hilbish/hilbish.timers.md +++ b/docs/api/hilbish/hilbish.timers.md @@ -1,5 +1,5 @@ --- -title: Interface hilbish.timers +title: Module hilbish.timers description: timeout and interval API layout: doc menu: @@ -14,14 +14,10 @@ a few seconds, you don't have to rely on timing tricks, as Hilbish has a timer API to set intervals and timeouts. These are the simple functions `hilbish.interval` and `hilbish.timeout` (doc -accessible with `doc hilbish`). But if you want slightly more control over -them, there is the `hilbish.timers` interface. It allows you to get -a timer via ID and control them. - -All functions documented with the `Timer` type refer to a Timer object. +accessible with `doc hilbish`, or `Module hilbish` on the Website). An example of usage: -``` +```lua local t = hilbish.timers.create(hilbish.timers.TIMEOUT, 5000, function() print 'hello!' end) @@ -30,25 +26,70 @@ t:start() print(t.running) // true ``` -## Interface fields -- `INTERVAL`: Constant for an interval timer type -- `TIMEOUT`: Constant for a timeout timer type - ## Functions -### create(type, time, callback) -> Timer -Creates a timer that runs based on the specified `time` in milliseconds. -The `type` can either be `hilbish.timers.INTERVAL` or `hilbish.timers.TIMEOUT` +||| +|----|----| +|create(type, time, callback) -> @Timer|Creates a timer that runs based on the specified `time`.| +|get(id) -> @Timer|Retrieves a timer via its ID.| -### get(id) -> Timer -Retrieves a timer via its ID. +## Static module fields +||| +|----|----| +|INTERVAL|Constant for an interval timer type| +|TIMEOUT|Constant for a timeout timer type| + +
+
+

+hilbish.timers.create(type, time, callback) -> Timer + + + +

+ +Creates a timer that runs based on the specified `time`. + +#### Parameters +`number` **`type`** +What kind of timer to create, can either be `hilbish.timers.INTERVAL` or `hilbish.timers.TIMEOUT` + +`number` **`time`** +The amount of time the function should run in milliseconds. + +`function` **`callback`** +The function to run for the timer. + +
+ +
+
+

+hilbish.timers.get(id) -> Timer + + + +

+ +Retrieves a timer via its ID. + +#### Parameters +`number` **`id`** + + +
## Types +
+ ## Timer The Job type describes a Hilbish timer. -### Properties -- `type`: What type of timer it is -- `running`: If the timer is running -- `duration`: The duration in milliseconds that the timer will run +## Object properties +||| +|----|----| +|type|What type of timer it is| +|running|If the timer is running| +|duration|The duration in milliseconds that the timer will run| + ### Methods #### start() diff --git a/docs/api/hilbish/hilbish.userDir.md b/docs/api/hilbish/hilbish.userDir.md index 0b95057..a2b7337 100644 --- a/docs/api/hilbish/hilbish.userDir.md +++ b/docs/api/hilbish/hilbish.userDir.md @@ -1,5 +1,5 @@ --- -title: Interface hilbish.userDir +title: Module hilbish.userDir description: user-related directories layout: doc menu: @@ -12,7 +12,9 @@ This interface just contains properties to know about certain user directories. It is equivalent to XDG on Linux and gets the user's preferred directories for configs and data. -## Interface fields -- `config`: The user's config directory -- `data`: The user's directory for program data +## Static module fields +||| +|----|----| +|config|The user's config directory| +|data|The user's directory for program data| diff --git a/docs/api/terminal.md b/docs/api/terminal.md index 99d4b49..1bd4cc1 100644 --- a/docs/api/terminal.md +++ b/docs/api/terminal.md @@ -11,16 +11,71 @@ menu: The terminal library is a simple and lower level library for certain terminal interactions. ## Functions -### restoreState() -Restores the last saved state of the terminal +||| +|----|----| +|restoreState()|Restores the last saved state of the terminal| +|saveState()|Saves the current state of the terminal.| +|setRaw()|Puts the terminal into raw mode.| +|size()|Gets the dimensions of the terminal. Returns a table with `width` and `height`| -### saveState() -Saves the current state of the terminal +
+
+

+terminal.restoreState() + + + +

-### setRaw() -Puts the terminal in raw mode +Restores the last saved state of the terminal -### 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 +#### Parameters +This function has no parameters. +
+ +
+
+

+terminal.saveState() + + + +

+ +Saves the current state of the terminal. + +#### Parameters +This function has no parameters. +
+ +
+
+

+terminal.setRaw() + + + +

+ +Puts the terminal into raw mode. + +#### Parameters +This function has no parameters. +
+ +
+
+

+terminal.size() + + + +

+ +Gets the dimensions of the terminal. Returns a table with `width` and `height` +NOTE: The size refers to the amount of columns and rows of text that can fit in the terminal. + +#### Parameters +This function has no parameters. +
diff --git a/docs/completions.md b/docs/completions.md index c2de27a..59ead1b 100644 --- a/docs/completions.md +++ b/docs/completions.md @@ -1,56 +1,78 @@ -Hilbish has a pretty good completion system. It has a nice looking -menu, with 2 types of menus: grid (like file completions) or -list. +--- +title: Completions +description: Tab completion for commands. +layout: doc +menu: + docs: + parent: "Features" +--- +Completions for commands can be created with the [`hilbish.complete`](../api/hilbish#complete) +function. See the link for how to use it. + +To create completions for a command is simple. +The callback will be passed 3 parameters: +- `query` (string): The text that the user is currently trying to complete. +This should be used to match entries. +- `ctx` (string): Contains the entire line. Use this if +more text is needed to be parsed for context. +- `fields` (string): The `ctx` split up by spaces. + +In most cases, the completer just uses `fields` to check the amount +and `query` on what to match entries on. + +In order to return your results, it has to go within a "completion group." +Then you return a table of completion groups and a prefix. The prefix will +usually just be the `query`. + +Hilbish allows one to mix completion menus of different types, so +a grid menu and a list menu can be used and complete and display at the same time. +A completion group is a table with these keys: +- `type` (string): type of completion menu, either `grid` or `list`. +- `items` (table): a list of items. + +The requirements of the `items` table is different based on the +`type`. If it is a `grid`, it can simply be a table of strings. + +Otherwise if it is a `list` then each entry can +either be a string or a table. +Example: +```lua +local cg = { + items = { + 'list item 1', + ['--command-flag-here'] = {'this does a thing', '--the-flag-alias'} + }, + type = 'list' +} +local cg2 = { + items = {'just', 'a bunch', 'of items', 'here', 'hehe'}, + type = 'grid' +} + +return {cg, cg2}, prefix +``` + +Which looks like this: +{{< video src="https://safe.saya.moe/t4CiLK6dgPbD.mp4" >}} + +# Completion Handler Like most parts of Hilbish, it's made to be extensible and customizable. The default handler for completions in general can be overwritten to provide more advanced completions if needed. +This usually doesn't need to be done though, unless you know +what you're doing. -# Completion Handler -By default, it provides 3 things: for the first argument, +The default completion handler provides 3 things: binaries (with a plain name requested to complete, those in -$PATH), files, or command completions. With the default -completion handler, it will try to run a handler for the -command or fallback to file completions. +$PATH), files, or command completions. It will try to run a handler +for the command or fallback to file completions. -To overwrite it, just assign a function to -`hilbish.completion.handler` like so: +To overwrite it, just assign a function to `hilbish.completion.handler` like so: +```lua +-- line is the entire line as a string +-- pos is the position of the cursor. function hilbish.completion.handler(line, pos) -- do things end - -It is passed 2 arguments, the entire line, and the current -cursor position. The functions in the completion interface -take 3 arguments: query, ctx, and fields. - -- The `query`, which what the user is currently trying to complete -- `ctx`, being just the entire line -- `fields` being a table of arguments. It's just `ctx` split up, -delimited by spaces. - -It's expected to return 2 things: a table of completion groups, and -a prefix. A completion group is defined as a table with 2 keys: -`items` and `type`. - -- The `items` field is just a table of items to use for completions. -- The `type` is for the completion menu type, being either `grid` or -`list`. - -The prefix is what all the completions start with. It should be empty -if the user doesn't have a query. If the beginning of the completion -item does not match the prefix, it will be replaced and fixed -properly in the line. It is case sensitive. - -If you want to overwrite the functionality of the general completion -handler, or make your command completion have files as well -(and filter them), then there is the `files` function, which is -mentioned below. - -# Completion Interface -## Functions -- `files(query, ctx, fields)` -> table, prefix: get file completions, -based on the user's query. -- `bins(query, ctx, fields)` -> table, prefix: get binary/executable -completions, based on user query. -- `call(scope, query, ctx, fields)` -> table, prefix: call a completion -handler with `scope`, usually being in the form of `command.` +``` diff --git a/website/content/docs/faq.md b/docs/faq.md similarity index 74% rename from website/content/docs/faq.md rename to docs/faq.md index 997fbaa..f89f269 100644 --- a/website/content/docs/faq.md +++ b/docs/faq.md @@ -15,11 +15,12 @@ It compiles for Windows (CI ensures it does), but otherwise it is not directly supported. If you'd like to improve this situation, checkout [the discussion](https://github.com/Rosettea/Hilbish/discussions/165). -# Where is the API documentation? -The builtin `doc` command supplies all documentation of Hilbish provided -APIs. You can also check the sidebar. - # Why? Hilbish emerged from the desire of a Lua configured shell. It was the initial reason that it was created, but now it's more: to be hyper extensible, simpler and more user friendly. + +# Does it have "autocompletion" or "tab completion" +Of course! This is a modern shell. Hilbish provides a way for users +to write tab completion for any command and/or the whole shell. +Inline hinting and syntax highlighting are also available. diff --git a/website/content/docs/features/_index.md b/docs/features/_index.md similarity index 100% rename from website/content/docs/features/_index.md rename to docs/features/_index.md diff --git a/website/content/docs/features/notifications.md b/docs/features/notifications.md similarity index 100% rename from website/content/docs/features/notifications.md rename to docs/features/notifications.md diff --git a/docs/features/opts.md b/docs/features/opts.md new file mode 100644 index 0000000..2fb848d --- /dev/null +++ b/docs/features/opts.md @@ -0,0 +1,78 @@ +--- +title: Options +description: Simple customizable options. +layout: doc +menu: + docs: + parent: "Features" +--- + +Opts are simple toggle or value options a user can set in Hilbish. +As toggles, there are things like `autocd` or history saving. As values, +there is the `motd` which the user can either change to a custom string or disable. + +Opts are accessed from the `hilbish.opts` table. Here they can either +be read or modified + +### `autocd` +#### Value: `boolean` +#### Default: `false` + +The autocd opt makes it so that lone directories attempted to be executed are +instead set as the shell's directory. + +Example: +``` +~/Directory +∆ ~ +~ +∆ Downloads +~/Downloads +∆ ../Documents +~/Documents +∆ +``` + +
+ +### `history` +#### Value: `boolean` +#### Default: `true` +Sets whether command history will be saved or not. + +
+ +### `greeting` +#### Value: `boolean` or `string` +The greeting is the message that Hilbish shows on startup +(the one which says Welcome to Hilbish). + +This can be set to either true/false to enable/disable or a custom greeting string. + +
+ +### `motd` +#### Value: `boolean` +#### Default: `true` +The message of the day shows the current major.minor version and +includes a small range of things added in the current release. + +This can be set to `false` to disable the message. + +
+ +### `fuzzy` +#### Value: `boolean` +#### Default: `false` +Toggles the functionality of fuzzy history searching, usable +via the menu in Ctrl-R. Fuzzy searching is an approximate searching +method, which means results that match *closest* will be shown instead +of an exact match. + +
+ +### `notifyJobFinish` +#### Value: `boolean` +#### Default: `true` +If this is enabled, when a background job is finished, +a [notification](../notifications) will be sent. diff --git a/docs/runner-mode.md b/docs/features/runner-mode.md similarity index 50% rename from docs/runner-mode.md rename to docs/features/runner-mode.md index 0b5ce24..0f7a8dd 100644 --- a/docs/runner-mode.md +++ b/docs/features/runner-mode.md @@ -1,7 +1,24 @@ -Hilbish is *unique,* when interactive it first attempts to run input as -Lua and then tries shell script. But if you're normal, you wouldn't -really be using Hilbish anyway but you'd also not want this -(or maybe want Lua only in some cases.) +--- +title: Runner Mode +description: Customize the interactive script/command runner. +layout: doc +menu: + docs: + parent: "Features" +--- + +Hilbish allows you to change how interactive text can be interpreted. +This is mainly due to the fact that the default method Hilbish uses +is that it runs Lua first and then falls back to shell script. + +In some cases, someone might want to switch to just shell script to avoid +it while interactive but still have a Lua config, or go full Lua to use +Hilbish as a REPL. This also allows users to add alternative languages like +Fennel as the interactive script runner. + +Runner mode can also be used to handle specific kinds of input before +evaluating like normal, which is how [Link.hsh](https://github.com/TorchedSammy/Link.hsh) +handles links. The "runner mode" of Hilbish is customizable via `hilbish.runnerMode`, which determines how Hilbish will run user input. By default, this is @@ -11,28 +28,23 @@ set it to `hybridRev` and for isolated modes there is `sh` and `lua` respectively. You can also set it to a function, which will be called everytime Hilbish -needs to run interactive input. For example, you can set this to a simple -function to compile and evaluate Fennel, and now you can run Fennel. -You can even mix it with sh to make a hybrid mode with Lua replaced by -Fennel. - -An example: -hilbish.runnerMode(function(input) - local ok = pcall(fennel.eval, input) - if ok then - return input, 0, nil - end - - return hilbish.runner.sh(input) -end) +needs to run interactive input. For more detail, see the [API documentation](../../api/hilbish/hilbish.runner) The `hilbish.runner` interface is an alternative to using `hilbish.runnerMode` -and also provides the sh and Lua runner functions that Hilbish itself uses. -A runner function is expected to return 3 values: the input, exit code, and an error. -The input return is there incase you need to prompt for more input. -If you don't, just return the input passed to the runner function. -The exit code has to be a number, it will be 0 otherwise and the error can be -`nil` to indicate no error. +and also provides the shell script and Lua runner functions that Hilbish itself uses. + +A runner function is expected to return a table with the following values: +- `exitCode` (number): Exit code of the command +- `input` (string): The text input of the user. This is used by Hilbish to append extra input, in case +more is requested. +- `err` (string): A string that represents an error from the runner. +This should only be set when, for example, there is a syntax error. +It can be set to a few special values for Hilbish to throw the right +hooks and have a better looking message. + - `: not-found` will throw a `command.not-found` hook + based on what `` is. + - `: not-executable` will throw a `command.not-executable` hook. +- `continue` (boolean): Whether Hilbish should prompt the user for no input ## Functions These are the "low level" functions for the `hilbish.runner` interface. @@ -41,21 +53,6 @@ These are the "low level" functions for the `hilbish.runner` interface. + sh(input) -> table > Runs `input` in Hilbish's sh interpreter + lua(input) -> table > Evals `input` as Lua code -The table value that runners return can have at least 4 values: -+ input (string): The full input text. -+ exitCode (number): Exit code (usually from a command) -+ continue (boolean): Whether to prompt the user for more input -(in the case of incomplete syntax) -+ err (string): A string that represents an error from the runner. -This should only be set when, for example, there is a syntax error. -It can be set to a few special values for Hilbish to throw the right -hooks and have a better looking message. - -+ `: not-found` will throw a `command.not-found` hook -based on what `` is. -+ `: not-executable` will throw a `command.not-executable` hook. - -The others here are defined in Lua and have EmmyLua documentation. These functions should be preferred over the previous ones. + setCurrent(mode) > The same as `setMode`, but works with runners managed via the functions below. diff --git a/website/content/docs/getting-started.md b/docs/getting-started.md similarity index 100% rename from website/content/docs/getting-started.md rename to docs/getting-started.md diff --git a/docs/hooks/_index.md b/docs/hooks/_index.md index 6616b05..ec313c6 100644 --- a/docs/hooks/_index.md +++ b/docs/hooks/_index.md @@ -1,13 +1,11 @@ -Here is a list of bait hooks that are thrown by Hilbish. If a hook is related -to a command, it will have the `command` scope, as example. +--- +title: Signals +description: +layout: doc +weight: -50 +menu: + docs +--- -Here is the format for a doc for a hook: -+ -> > - -`` just means the arguments of the hook. If a hook doc has the format -of `arg...`, it means the hook can take/recieve any number of `arg`. - -+ error -> eventName, handler, err > Emitted when there is an error in -an event handler. The `eventName` is the name of the event the handler -is for, the `handler` is the callback function, and `err` is the error -message. +Signals are global events emitted with the [Bait](../api/bait) module. +For more detail on how to use these signals, you may check the Bait page. diff --git a/docs/hooks/command.md b/docs/hooks/command.md index 2d29f4b..2e3163e 100644 --- a/docs/hooks/command.md +++ b/docs/hooks/command.md @@ -1,12 +1,67 @@ -+ `command.preexec` -> input, cmdStr > Thrown before a command -is executed. The `input` is the user written command, while `cmdStr` -is what will be executed (`input` will have aliases while `cmdStr` -will have alias resolved input). +--- +title: Command +description: +layout: doc +menu: + docs: + parent: "Signals" +--- -+ `command.exit` -> code, cmdStr > Thrown when a command exits. -`code` is the exit code of the command, and `cmdStr` is the command that was run. +## command.preexec +Thrown right before a command is executed. -+ `command.not-found` -> cmdStr > Thrown when a command is not found. +#### Variables +`string` **`input`** +The raw string that the user typed. This will include the text +without changes applied to it (argument substitution, alias expansion, +etc.) -+ `command.not-executable` -> cmdStr > Thrown when Hilbish attempts to run a file -that is not executable. +`string` **`cmdStr`** +The command that will be directly executed by the current runner. + +
+ +## command.exit +Thrown after the user's ran command is finished. + +#### Variables +`number` **`code`** +The exit code of what was executed. + +`string` **`cmdStr`** +The command or code that was executed + +
+ +## command.not-found +Thrown if the command attempted to execute was not found. +This can be used to customize the text printed when a command is not found. +Example: +```lua +local bait = require 'bait' +-- Remove any present handlers on `command.not-found` + +local notFoundHooks = bait.hooks 'command.not-found' +for _, hook in ipairs(notFoundHooks) do + bait.release('command.not-found', hook) +end + +-- then assign custom +bait.catch('command.not-found', function(cmd) + print(string.format('The command "%s" was not found.', cmd)) +end) +``` + +#### Variables +`string` **`cmdStr`** +The name of the command. + +
+ +## command.not-executable +Thrown when the user attempts to run a file that is not executable +(like a text file, or Unix binary without +x permission). + +#### Variables +`string` **`cmdStr`** +The name of the command. diff --git a/docs/hooks/hilbish.md b/docs/hooks/hilbish.md index 7118901..d5d8a48 100644 --- a/docs/hooks/hilbish.md +++ b/docs/hooks/hilbish.md @@ -1,12 +1,47 @@ -+ `hilbish.exit` > Sent when Hilbish is about to exit. +--- +title: Hilbish +description: +layout: doc +menu: + docs: + parent: "Signals" +--- -+ `hilbish.vimMode` -> modeName > Sent when Hilbish's Vim mode is changed (example insert to normal mode), -`modeName` is the name of the mode changed to (can be `insert`, `normal`, `delete` or `replace`). +## hilbish.exit +Sent when Hilbish is going to exit. + +#### Variables +This signal returns no variables. + +
+ +## hilbish.vimMode +Sent when the Vim mode of Hilbish is changed (like from insert to normal mode). +This can be used to change the prompt and notify based on Vim mode. + +#### Variables +`string` **`modeName`** +The mode that has been set. +Can be these values: `insert`, `normal`, `delete` or `replace` + +
+ +## hilbish.cancel +Sent when the user cancels their command input with Ctrl-C + +#### Variables +This signal returns no variables. + +
+ +## hilbish.notification +Thrown when a [notification](../../features/notifications) is sent. + +#### Variables +`table` **`notification`** +The notification. The properties are defined in the link above. + +
+ `hilbish.vimAction` -> actionName, args > Sent when the user does a "vim action," being something like yanking or pasting text. See `doc vim-mode actions` for more info. - -+ `hilbish.cancel` > Sent when the user cancels their input with Ctrl-C. - -+ `hilbish.notification` -> message > Sent when a message is -sent. diff --git a/docs/hooks/signal.md b/docs/hooks/signal.md index ac5deed..63834b0 100644 --- a/docs/hooks/signal.md +++ b/docs/hooks/signal.md @@ -1,7 +1,40 @@ -+ `signal.sigint` > Sent when Hilbish receives SIGINT (on Ctrl-C). +--- +title: Signal +description: +layout: doc +menu: + docs: + parent: "Signals" +--- -+ `signal.resize` > Sent when the terminal is resized. +## signal.sigint +Thrown when Hilbish receive the SIGINT signal, +aka when Ctrl-C is pressed. -+ `signal.sigusr1` +#### Variables +This signal returns no variables. + +
+ +## signal.resize +Thrown when the terminal is resized. + +#### Variables +This signal returns no variables. + +
+ +## signal.sigusr1 +Thrown when SIGUSR1 is sent to Hilbish. + +#### Variables +This signal returns no variables. + +
+ +## signal.sigusr2 +Thrown when SIGUSR2 is sent to Hilbish. + +#### Variables +This signal returns no variables. -+ `signal.sigusr2` diff --git a/docs/jobs.md b/docs/jobs.md index a5fee9c..8651051 100644 --- a/docs/jobs.md +++ b/docs/jobs.md @@ -1,3 +1,5 @@ +(This has mainly been replaced by [hilbish.jobs](../api/hilbish.jobs)). + Hilbish has pretty standard job control. It's missing one or two things, but works well. One thing which is different from other shells (besides Hilbish) itself is the API for jobs, and of course it's in Lua. diff --git a/docs/lunacolors.md b/docs/lunacolors.md index e122fef..bde809c 100644 --- a/docs/lunacolors.md +++ b/docs/lunacolors.md @@ -1,3 +1,10 @@ +--- +title: Lunacolors +layout: doc +weight: -60 +menu: docs +--- + Lunacolors is an ANSI color/styling library for Lua. It is included by default in standard Hilbish distributions to provide easy styling for things like prompts and text. diff --git a/docs/nature/_index.md b/docs/nature/_index.md index 53df6ca..4a3bc35 100644 --- a/docs/nature/_index.md +++ b/docs/nature/_index.md @@ -1,10 +1,17 @@ +--- +title: Nature +layout: doc +weight: -90 +menu: docs +--- + A bit after creation, we have the outside nature. Little plants, seeds, growing to their final phase: a full plant. A lot of Hilbish itself is written in Go, but there are parts made in Lua, being most builtins (`doc`, `cd`, cdr), completions, and other things. -Hilbish's Lua core module is called `nature`. It's handled after everything -on the Go side initializes, which is what that first sentence was from. +Hilbish's Lua core module is called `nature`. +It runs after Hilbish's Go core does. # Nature Modules Currently, `nature` provides 1 intended public module: `nature.dirs`. diff --git a/docs/nature/dirs.md b/docs/nature/dirs.md new file mode 100644 index 0000000..3c707e6 --- /dev/null +++ b/docs/nature/dirs.md @@ -0,0 +1,79 @@ +--- +title: Module dirs +description: No description. +layout: doc +menu: + docs: + parent: "Nature" +--- + +
+
+

+dirs.setOld(d) + + + +

+ +Sets the old directory string. +#### Parameters +`d` **`string`** +
+ +
+
+

+dirs.push() + + + +

+ +Add `d` to the recent directories list. +#### Parameters +This function has no parameters. +
+ +
+
+

+dirs.peak(num) + + + +

+ +Look at `num` amount of recent directories, starting from the latest. +#### Parameters +`num` **`number`** +
+ +
+
+

+dirs.pop(num) + + + +

+ +Remove the specified amount of dirs from the recent directories list. +#### Parameters +`num` **`number`** +
+ +
+
+

+dirs.recent(idx) + + + +

+ +Get entry from recent directories list based on index. +#### Parameters +`idx` **`number`** +
+ diff --git a/docs/vim-mode/_index.md b/docs/vim-mode/_index.md index a30fe74..bda01e9 100644 --- a/docs/vim-mode/_index.md +++ b/docs/vim-mode/_index.md @@ -1,3 +1,10 @@ +--- +title: Vim Mode +layout: doc +weight: -90 +menu: docs +--- + Hilbish has a Vim binding input mode accessible for use. It can be enabled with the `hilbish.inputMode` function (check `doc hilbish`). diff --git a/docs/vim-mode/actions.md b/docs/vim-mode/actions.md index 9dfb7b2..9757827 100644 --- a/docs/vim-mode/actions.md +++ b/docs/vim-mode/actions.md @@ -1,3 +1,12 @@ +--- +title: Actions +layout: doc +weight: -80 +menu: + docs: + parent: "Vim Mode" +--- + Vim actions are essentially just when a user uses a Vim keybind. Things like yanking and pasting are Vim actions. This is not an "offical Vim thing," just a Hilbish thing. diff --git a/editor.go b/editor.go index 3038f07..9c49440 100644 --- a/editor.go +++ b/editor.go @@ -16,6 +16,7 @@ func editorLoader(rtm *rt.Runtime) *rt.Table { "setVimRegister": {editorSetRegister, 1, false}, "getVimRegister": {editorGetRegister, 2, false}, "getLine": {editorGetLine, 0, false}, + "readChar": {editorReadChar, 0, false}, } mod := rt.NewTable() @@ -26,7 +27,8 @@ func editorLoader(rtm *rt.Runtime) *rt.Table { // #interface editor // insert(text) -// Inserts text into the line. +// Inserts text into the Hilbish command line. +// #param text string func editorInsert(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -45,8 +47,8 @@ func editorInsert(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // #interface editor // setVimRegister(register, text) // Sets the vim register at `register` to hold the passed text. -// --- @param register string -// --- @param text string +// #aram register string +// #param text string func editorSetRegister(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -70,7 +72,7 @@ func editorSetRegister(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // #interface editor // getVimRegister(register) -> string // Returns the text that is at the register. -// --- @param register string +// #param register string func editorGetRegister(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -89,8 +91,18 @@ func editorGetRegister(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // #interface editor // getLine() -> string // Returns the current input line. +// #returns string func editorGetLine(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { buf := lr.rl.GetLine() return c.PushingNext1(t.Runtime, rt.StringValue(string(buf))), nil } + +// #interface editor +// getChar() -> string +// Reads a keystroke from the user. This is in a format of something like Ctrl-L. +func editorReadChar(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { + buf := lr.rl.ReadChar() + + return c.PushingNext1(t.Runtime, rt.StringValue(string(buf))), nil +} diff --git a/emmyLuaDocs/bait.lua b/emmyLuaDocs/bait.lua index 35a37ed..c38eea1 100644 --- a/emmyLuaDocs/bait.lua +++ b/emmyLuaDocs/bait.lua @@ -2,31 +2,27 @@ local bait = {} ---- Catches a hook with `name`. Runs the `cb` when it is thrown ---- @param name string ---- @param cb function +--- Catches an event. This function can be used to act on events. +--- +--- function bait.catch(name, cb) end ---- Same as catch, but only runs the `cb` once and then removes the hook ---- @param name string ---- @param cb function +--- Catches an event, but only once. This will remove the hook immediately after it runs for the first time. function bait.catchOnce(name, cb) end ---- Returns a table with hooks (callback functions) on the event with `name`. ---- @param name string ---- @returns table +--- Returns a table of functions that are hooked on an event with the corresponding `name`. function bait.hooks(name) end --- Removes the `catcher` for the event with `name`. --- For this to work, `catcher` has to be the same function used to catch --- an event, like one saved to a variable. ---- @param name string ---- @param catcher function +--- +--- function bait.release(name, catcher) end ---- Throws a hook with `name` with the provided `args` ---- @param name string ---- @vararg any +--- Throws a hook with `name` with the provided `args`. +--- +--- function bait.throw(name, ...args) end return bait diff --git a/emmyLuaDocs/commander.lua b/emmyLuaDocs/commander.lua index c6738dd..285c4b5 100644 --- a/emmyLuaDocs/commander.lua +++ b/emmyLuaDocs/commander.lua @@ -2,13 +2,13 @@ local commander = {} ---- Deregisters any command registered with `name` ---- @param name string +--- Removes the named command. Note that this will only remove Commander-registered commands. function commander.deregister(name) end ---- Register a command with `name` that runs `cb` when ran ---- @param name string ---- @param cb function +--- Adds a new command with the given `name`. When Hilbish has to run a command with a name, +--- it will run the function providing the arguments and sinks. +--- +--- function commander.register(name, cb) end return commander diff --git a/emmyLuaDocs/fs.lua b/emmyLuaDocs/fs.lua index e974ab9..89a418b 100644 --- a/emmyLuaDocs/fs.lua +++ b/emmyLuaDocs/fs.lua @@ -2,56 +2,49 @@ local fs = {} ---- Gives an absolute version of `path`. ---- @param path string ---- @returns string +--- Returns an absolute version of the `path`. +--- This can be used to resolve short paths like `..` to `/home/user`. function fs.abs(path) end ---- Gives the basename of `path`. For the rules, ---- see Go's filepath.Base ---- @returns string +--- Returns the "basename," or the last part of the provided `path`. If path is empty, +--- `.` will be returned. function fs.basename(path) end ---- Changes directory to `dir` ---- @param dir string +--- Changes Hilbish's directory to `dir`. function fs.cd(dir) end ---- Returns the directory part of `path`. For the rules, see Go's ---- filepath.Dir ---- @param path string ---- @returns string +--- Returns the directory part of `path`. If a file path like +--- `~/Documents/doc.txt` then this function will return `~/Documents`. function fs.dir(path) end ---- Glob all files and directories that match the pattern. ---- For the rules, see Go's filepath.Glob ---- @param pattern string ---- @returns table +--- Match all files based on the provided `pattern`. +--- For the syntax' refer to Go's filepath.Match function: https://pkg.go.dev/path/filepath#Match +--- +--- function fs.glob(pattern) end ---- Takes paths and joins them together with the OS's ---- directory separator (forward or backward slash). ---- @vararg string ---- @returns string -function fs.join(...) end +--- Takes any list of paths and joins them based on the operating system's path separator. +--- +--- +function fs.join(...path) end ---- Makes a directory called `name`. If `recursive` is true, it will create its parent directories. ---- @param name string ---- @param recursive boolean +--- Creates a new directory with the provided `name`. +--- With `recursive`, mkdir will create parent directories. +--- +--- function fs.mkdir(name, recursive) end ---- Returns a table of files in `dir`. ---- @param dir string ---- @return table -function fs.readdir(dir) end +--- Returns a list of all files and directories in the provided path. +function fs.readdir(path) end ---- Returns a table of info about the `path`. ---- It contains the following keys: +--- Returns the information about a given `path`. +--- The returned table contains the following values: --- name (string) - Name of the path ---- size (number) - Size of the path ---- mode (string) - Permission mode in an octal format string (with leading 0) +--- size (number) - Size of the path in bytes +--- mode (string) - Unix permission mode in an octal format string (with leading 0) --- isDir (boolean) - If the path is a directory ---- @param path string ---- @returns table +--- +--- function fs.stat(path) end return fs diff --git a/emmyLuaDocs/hilbish.lua b/emmyLuaDocs/hilbish.lua index c26c7ec..7cca355 100644 --- a/emmyLuaDocs/hilbish.lua +++ b/emmyLuaDocs/hilbish.lua @@ -2,92 +2,92 @@ local hilbish = {} ---- This is an alias (ha) for the `hilbish.alias` function. +--- This is an alias (ha) for the [hilbish.alias](../#alias) function. --- @param alias string --- @param cmd string function hilbish.aliases.add(alias, cmd) end ---- This is the same as the `hilbish.runnerMode` function. It takes a callback, ---- which will be used to execute all interactive input. +--- This is the same as the `hilbish.runnerMode` function. +--- It takes a callback, which will be used to execute all interactive input. --- In normal cases, neither callbacks should be overrided by the user, --- as the higher level functions listed below this will handle it. ---- @param cb function function hilbish.runner.setMode(cb) end ---- Calls a completer function. This is mainly used to call ---- a command completer, which will have a `name` in the form ---- of `command.name`, example: `command.git`. ---- You can check `doc completions` for info on the `completionGroups` return value. ---- @param name string ---- @param query string ---- @param ctx string ---- @param fields table -function hilbish.completions.call(name, query, ctx, fields) end - ---- The handler function is the callback for tab completion in Hilbish. ---- You can check the completions doc for more info. ---- @param line string ---- @param pos string -function hilbish.completions.handler(line, pos) end - --- Returns the current input line. function hilbish.editor.getLine() end --- Returns the text that is at the register. ---- @param register string function hilbish.editor.getVimRegister(register) end ---- Inserts text into the line. +--- Inserts text into the Hilbish command line. function hilbish.editor.insert(text) end +--- Reads a keystroke from the user. This is in a format of something like Ctrl-L. +function hilbish.editor.getChar() end + --- Sets the vim register at `register` to hold the passed text. ---- @param register string ---- @param text string function hilbish.editor.setVimRegister(register, text) end ---- Sets an alias of `cmd` to `orig` ---- @param cmd string ---- @param orig string +--- Return binaries/executables based on the provided parameters. +--- This function is meant to be used as a helper in a command completion handler. +--- +--- +function hilbish.completion.bins(query, ctx, fields) end + +--- Calls a completer function. This is mainly used to call a command completer, which will have a `name` +--- in the form of `command.name`, example: `command.git`. +--- You can check the Completions doc or `doc completions` for info on the `completionGroups` return value. +function hilbish.completion.call(name, query, ctx, fields) end + +--- Returns file matches based on the provided parameters. +--- This function is meant to be used as a helper in a command completion handler. +function hilbish.completion.files(query, ctx, fields) end + +--- This function contains the general completion handler for Hilbish. This function handles +--- completion of everything, which includes calling other command handlers, binaries, and files. +--- This function can be overriden to supply a custom handler. Note that alias resolution is required to be done in this function. +--- +--- +function hilbish.completion.handler(line, pos) end + +--- Sets an alias, with a name of `cmd` to another command. +--- +--- function hilbish.alias(cmd, orig) end ---- Appends `dir` to $PATH ---- @param dir string|table +--- Appends the provided dir to the command path (`$PATH`) +--- +--- function hilbish.appendPath(dir) end ---- Registers a completion handler for `scope`. ---- A `scope` is currently only expected to be `command.`, +--- Registers a completion handler for the specified scope. +--- A `scope` is expected to be `command.`, --- replacing 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 +--- The documentation for completions, under Features/Completions or `doc completions` +--- provides more details. +--- +--- function hilbish.complete(scope, cb) end ---- Returns the current directory of the shell ---- @returns string +--- Returns the current directory of the shell. function hilbish.cwd() end ---- Replaces running hilbish with `cmd` ---- @param cmd string +--- Replaces the currently running Hilbish instance with the supplied command. +--- This can be used to do an in-place restart. function hilbish.exec(cmd) end ---- Puts `fn` in a goroutine ---- @param fn function +--- Puts `fn` in a Goroutine. +--- This can be used to run any function in another thread at the same time as other Lua code. +--- **NOTE: THIS FUNCTION MAY CRASH HILBISH IF OUTSIDE VARIABLES ARE ACCESSED.** +--- **This is a limitation of the Lua runtime.** function hilbish.goro(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. +--- 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. --- Note that to set a highlighter, one has to override this function. ---- Example: ---- ``` ---- function hilbish.highlighter(line) ---- return line:gsub('"%w+"', function(c) return lunacolors.green(c) end) ---- end ---- ``` ---- This code will highlight all double quoted strings in green. ---- @param line string +--- function hilbish.highlighter(line) end --- The command line hint handler. It gets called on every key insert to @@ -95,97 +95,71 @@ function hilbish.highlighter(line) end --- 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 number +--- +--- function hilbish.hinter(line, pos) end ---- Sets the input mode for Hilbish's line reader. Accepts either emacs or vim ---- @param mode string +--- Sets the input mode for Hilbish's line reader. +--- `emacs` is the default. Setting it to `vim` changes behavior of input to be +--- Vim-like with modes and Vim keybinds. function hilbish.inputMode(mode) end ---- Runs the `cb` function every `time` milliseconds. ---- This creates a timer that starts immediately. ---- @param cb function ---- @param time number ---- @return Timer +--- Runs the `cb` function every specified amount of `time`. +--- This creates a timer that ticking immediately. function hilbish.interval(cb, time) end ---- Changes the continued line prompt to `str` ---- @param str string +--- Changes the text prompt when Hilbish asks for more input. +--- This will show up when text is incomplete, like a missing quote +--- +--- function hilbish.multiprompt(str) end ---- Prepends `dir` to $PATH ---- @param dir string +--- Prepends `dir` to $PATH. function hilbish.prependPath(dir) end ---- Changes the shell prompt to `str` +--- Changes the shell prompt to the provided string. --- 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 hilbish.prompt(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 ---- @returns string|nil +--- Returns `input`, will be nil if Ctrl-D is pressed, or an error occurs. function hilbish.read(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 ---- @param returnOut boolean ---- @returns number, string, string +--- Runs `cmd` in Hilbish's shell script interpreter. function hilbish.run(cmd, returnOut) 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. +--- 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 +--- Read [about runner mode](../features/runner-mode) for more information. function hilbish.runnerMode(mode) end ---- Runs the `cb` function after `time` in milliseconds. ---- This creates a timer that starts immediately. ---- @param cb function ---- @param time number ---- @returns Timer +--- Executed the `cb` function after a period of `time`. +--- This creates a Timer that starts ticking immediately. function hilbish.timeout(cb, time) end --- Checks if `name` is a valid command. --- Will return the path of the binary, or a basename if it's a commander. ---- @param name string ---- @returns string function hilbish.which(name) end --- Puts a job in the background. This acts the same as initially running a job. function hilbish.jobs:background() end ---- Returns binary/executale completion candidates based on the provided query. ---- @param query string ---- @param ctx string ---- @param fields table -function hilbish.completions.bins(query, ctx, fields) end - ---- Returns file completion candidates based on the provided query. ---- @param query string ---- @param ctx string ---- @param fields table -function hilbish.completions.files(query, ctx, fields) end - --- Puts a job in the foreground. This will cause it to run like it was --- executed normally and wait for it to complete. function hilbish.jobs:foreground() end --- Evaluates `cmd` as Lua input. This is the same as using `dofile` --- or `load`, but is appropriated for the runner interface. ---- @param cmd string function hilbish.runner.lua(cmd) end --- Sets/toggles the option of automatically flushing output. @@ -196,10 +170,14 @@ function hilbish:autoFlush(auto) end --- Flush writes all buffered input to the sink. function hilbish:flush() end ---- Reads input from the sink. +--- Reads a liine of input from the sink. --- @returns string function hilbish:read() end +--- Reads all input from the sink. +--- @returns string +function hilbish:readAll() end + --- Writes data to a sink. function hilbish:write(str) end @@ -212,9 +190,12 @@ function hilbish.jobs:start() end --- Stops the job from running. function hilbish.jobs:stop() end +--- Loads a module at the designated `path`. +--- It will throw if any error occurs. +function hilbish.module.load(path) end + --- Runs a command in Hilbish's shell script interpreter. --- This is the equivalent of using `source`. ---- @param cmd string function hilbish.runner.sh(cmd) end --- Starts a timer. @@ -224,30 +205,26 @@ function hilbish.timers:start() end function hilbish.timers:stop() end --- Removes an alias. ---- @param name string function hilbish.aliases.delete(name) end --- Get a table of all aliases, with string keys as the alias and the value as the command. ---- @returns table +--- +--- function hilbish.aliases.list() end ---- Tries to resolve an alias to its command. ---- @param alias string ---- @returns string +--- Resolves an alias to its original command. Will thrown an error if the alias doesn't exist. function hilbish.aliases.resolve(alias) end ---- Adds a new job to the job table. Note that this does not immediately run it. ---- @param cmdstr string ---- @param args table ---- @param execPath string +--- Creates a new job. This function does not run the job. This function is intended to be +--- used by runners, but can also be used to create jobs via Lua. Commanders cannot be ran as jobs. +--- +--- function hilbish.jobs.add(cmdstr, args, execPath) end --- Returns a table of all job objects. ---- @returns table function hilbish.jobs.all() end ---- Disowns a job. This deletes it from the job table. ---- @param id number +--- Disowns a job. This simply deletes it from the list of jobs without stopping it. function hilbish.jobs.disown(id) end --- Get a job object via its ID. @@ -255,39 +232,28 @@ function hilbish.jobs.disown(id) end --- @returns Job function hilbish.jobs.get(id) end ---- Returns the last added job from the table. ---- @returns Job +--- Returns the last added job to the table. function hilbish.jobs.last() end --- Adds a command to the history. ---- @param cmd string function hilbish.history.add(cmd) end ---- Retrieves all history. ---- @returns table +--- Retrieves all history as a table. function hilbish.history.all() end --- Deletes all commands from the history. function hilbish.history.clear() end ---- Retrieves a command from the history based on the `idx`. ---- @param idx number -function hilbish.history.get(idx) end +--- Retrieves a command from the history based on the `index`. +function hilbish.history.get(index) end --- Returns the amount of commands in the history. ---- @returns number function hilbish.history.size() end ---- Creates a timer that runs based on the specified `time` in milliseconds. ---- The `type` can either be `hilbish.timers.INTERVAL` or `hilbish.timers.TIMEOUT` ---- @param type number ---- @param time number ---- @param callback function +--- Creates a timer that runs based on the specified `time`. function hilbish.timers.create(type, time, callback) end --- Retrieves a timer via its ID. ---- @param id number ---- @returns Timer function hilbish.timers.get(id) end return hilbish diff --git a/emmyLuaDocs/terminal.lua b/emmyLuaDocs/terminal.lua index 2266ac6..ed0b9ef 100644 --- a/emmyLuaDocs/terminal.lua +++ b/emmyLuaDocs/terminal.lua @@ -5,14 +5,14 @@ local terminal = {} --- Restores the last saved state of the terminal function terminal.restoreState() end ---- Saves the current state of the terminal +--- Saves the current state of the terminal. function terminal.saveState() end ---- Puts the terminal in raw mode +--- Puts the terminal into raw mode. function terminal.setRaw() end --- 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 +--- NOTE: The size refers to the amount of columns and rows of text that can fit in the terminal. function terminal.size() end return terminal diff --git a/exec.go b/exec.go index 726a986..cf84231 100644 --- a/exec.go +++ b/exec.go @@ -175,6 +175,9 @@ func runLuaRunner(runr rt.Value, userInput string) (input string, exitCode uint8 runnerRet := term.Get(0) if runner, ok = runnerRet.TryTable(); !ok { fmt.Fprintln(os.Stderr, "runner did not return a table") + exitCode = 125 + input = userInput + return } if code, ok := runner.Get(rt.StringValue("exitCode")).TryInt(); ok { diff --git a/go.mod b/go.mod index 5d0efe3..65a463c 100644 --- a/go.mod +++ b/go.mod @@ -1,11 +1,11 @@ module hilbish -go 1.17 +go 1.18 require ( github.com/arnodel/golua v0.0.0-20220221163911-dfcf252b6f86 + github.com/atsushinee/go-markdown-generator v0.0.0-20191121114853-83f9e1f68504 github.com/blackfireio/osinfo v1.0.3 - github.com/chuckpreslar/emission v0.0.0-20170206194824-a7ddd980baf9 github.com/maxlandon/readline v0.1.0-beta.0.20211027085530-2b76cabb8036 github.com/pborman/getopt v1.1.0 github.com/rjeczalik/notify v0.9.3 @@ -19,6 +19,7 @@ require ( github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d // indirect github.com/arnodel/strftime v0.1.6 // indirect github.com/evilsocket/islazy v1.10.6 // indirect + github.com/kylelemons/godebug v1.1.0 // indirect github.com/olekukonko/ts v0.0.0-20171002115256-78ecb04241c0 // indirect github.com/rivo/uniseg v0.2.0 // indirect golang.org/x/sync v0.0.0-20220513210516-0976fa681c29 // indirect diff --git a/go.sum b/go.sum index 1ae270b..64bdf98 100644 --- a/go.sum +++ b/go.sum @@ -1,13 +1,5 @@ -github.com/Rosettea/golua v0.0.0-20220419183026-6d22d6fec5ac h1:dtXrgjch8PQyf7C90anZUquB5U3dr8AcMGJofeuirrI= -github.com/Rosettea/golua v0.0.0-20220419183026-6d22d6fec5ac/go.mod h1:9jzpYPiU2is0HVGCiuIOBSXdergHUW44IEjmuN1UrIE= -github.com/Rosettea/golua v0.0.0-20220518005949-116371948fe3 h1:I/wWr40FFLFF9pbT3wLb1FAEZhKb/hUWE+nJ5uHBK2g= -github.com/Rosettea/golua v0.0.0-20220518005949-116371948fe3/go.mod h1:9jzpYPiU2is0HVGCiuIOBSXdergHUW44IEjmuN1UrIE= -github.com/Rosettea/golua v0.0.0-20220621002945-b05143999437 h1:6lWu4YVLeKuZ8jR9xwHONhkHBsrIbw5dpfG1gtOVw0A= -github.com/Rosettea/golua v0.0.0-20220621002945-b05143999437/go.mod h1:9jzpYPiU2is0HVGCiuIOBSXdergHUW44IEjmuN1UrIE= github.com/Rosettea/golua v0.0.0-20221213193027-cbf6d4e4d345 h1:QNYjYDogUSiNUkffbhFSrSCtpZhofeiVYGFN2FI4wSs= github.com/Rosettea/golua v0.0.0-20221213193027-cbf6d4e4d345/go.mod h1:9jzpYPiU2is0HVGCiuIOBSXdergHUW44IEjmuN1UrIE= -github.com/Rosettea/sh/v3 v3.4.0-0.dev.0.20220306140409-795a84b00b4e h1:P2XupP8SaylWaudD1DqbWtZ3mIa8OsE9635LmR+Q+lg= -github.com/Rosettea/sh/v3 v3.4.0-0.dev.0.20220306140409-795a84b00b4e/go.mod h1:R09vh/04ILvP2Gj8/Z9Jd0Dh0ZIvaucowMEs6abQpWs= github.com/Rosettea/sh/v3 v3.4.0-0.dev.0.20220524215627-dfd9a4fa219b h1:s5eDMhBk6H1BgipgLub/gv9qeyBaTuiHM0k3h2/9TSE= github.com/Rosettea/sh/v3 v3.4.0-0.dev.0.20220524215627-dfd9a4fa219b/go.mod h1:R09vh/04ILvP2Gj8/Z9Jd0Dh0ZIvaucowMEs6abQpWs= github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d h1:licZJFw2RwpHMqeKTCYkitsPqHNxTmd4SNR5r94FGM8= @@ -16,10 +8,10 @@ github.com/arnodel/edit v0.0.0-20220202110212-dfc8d7a13890/go.mod h1:AcpttpuZBaL github.com/arnodel/strftime v0.1.6 h1:0hc0pUvk8KhEMXE+htyaOUV42zNcf/csIbjzEFCJqsw= github.com/arnodel/strftime v0.1.6/go.mod h1:5NbK5XqYK8QpRZpqKNt4OlxLtIB8cotkLk4KTKzJfWs= github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI= +github.com/atsushinee/go-markdown-generator v0.0.0-20191121114853-83f9e1f68504 h1:R1/AOzdMbopSliUTTEHvHbyNmnZ3YxY5GvdhTkpPsSY= +github.com/atsushinee/go-markdown-generator v0.0.0-20191121114853-83f9e1f68504/go.mod h1:kHBCvAXJIatTX1pw6tLiOspjGc3MhUDRlog9yrCUS+k= github.com/blackfireio/osinfo v1.0.3 h1:Yk2t2GTPjBcESv6nDSWZKO87bGMQgO+Hi9OoXPpxX8c= github.com/blackfireio/osinfo v1.0.3/go.mod h1:Pd987poVNmd5Wsx6PRPw4+w7kLlf9iJxoRKPtPAjOrA= -github.com/chuckpreslar/emission v0.0.0-20170206194824-a7ddd980baf9 h1:xz6Nv3zcwO2Lila35hcb0QloCQsc38Al13RNEzWRpX4= -github.com/chuckpreslar/emission v0.0.0-20170206194824-a7ddd980baf9/go.mod h1:2wSM9zJkl1UQEFZgSd68NfCgRz1VL1jzy/RjCg+ULrs= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= github.com/creack/pty v1.1.15 h1:cKRCLMj3Ddm54bKSpemfQ8AtYFBhAI2MPmdys22fBdc= github.com/creack/pty v1.1.15/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4= @@ -36,6 +28,8 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc= +github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw= github.com/lucasb-eyer/go-colorful v1.0.3/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= github.com/mattn/go-runewidth v0.0.10/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk= github.com/olekukonko/ts v0.0.0-20171002115256-78ecb04241c0 h1:LiZB1h0GIcudcDci2bxbqI6DXV8bF8POAnArqvRrIyw= @@ -53,7 +47,6 @@ github.com/rogpeppe/go-internal v1.8.1-0.20210923151022-86f73c517451 h1:d1PiN4Rx github.com/rogpeppe/go-internal v1.8.1-0.20210923151022-86f73c517451/go.mod h1:JeRgkft04UBgHMgCIwADu4Pn6Mtm5d4nPKWu0nJ5d+o= github.com/sahilm/fuzzy v0.1.0 h1:FzWGaw2Opqyu+794ZQ9SYifWv2EIXpwP4q8dY1kDAwI= github.com/sahilm/fuzzy v0.1.0/go.mod h1:VFvziUEIMCrT6A6tw2RFIXPXXmzXbOsSHF0DOI8ZK9Y= -golang.org/x/sync v0.0.0-20210220032951-036812b2e83c h1:5KslGYwFpkhGh+Q16bwMP3cOontH8FOep7tGV86Y7SQ= golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220513210516-0976fa681c29 h1:w8s32wxx3sY+OjLlv9qltkLU5yvJzxjjgiHWLjdIcw4= golang.org/x/sync v0.0.0-20220513210516-0976fa681c29/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -63,18 +56,13 @@ golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210925032602-92d5a993a665/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220114195835-da31bd327af9/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220227234510-4e6760a101f9 h1:nhht2DYV/Sn3qOayu8lM+cU1ii9sTLUeBQwQQfUHtrs= -golang.org/x/sys v0.0.0-20220227234510-4e6760a101f9/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a h1:dGzPydgVsqGcTRVwiLJ1jVbufYwmzD3LfVPLKsKg+0k= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210916214954-140adaaadfaf/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= -golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 h1:JGgROgKl9N8DuW20oFS5gxc+lE67/N3FcwmBPMe7ArY= -golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.0.0-20220411215600-e5f449aeb171 h1:EH1Deb8WZJ0xc0WK//leUHXcX9aLE5SymusoTmMZye8= golang.org/x/term v0.0.0-20220411215600-e5f449aeb171/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= -golang.org/x/text v0.3.6 h1:aRYxNxv6iGQlyVaZmk6ZgYEDa+Jg18DxebPSrd6bg1M= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= diff --git a/golibs/bait/bait.go b/golibs/bait/bait.go index 3f3c34e..1f85c76 100644 --- a/golibs/bait/bait.go +++ b/golibs/bait/bait.go @@ -1,9 +1,28 @@ // the event emitter -// Bait is the event emitter for Hilbish. Why name it bait? Why not. -// It throws hooks that you can catch. This is what you will use if -// you want to listen in on hooks to know when certain things have -// happened, like when you've changed directory, a command has failed, -// etc. To find all available hooks thrown by Hilbish, see doc hooks. +/* +Bait is the event emitter for Hilbish. Much like Node.js and +its `events` system, many actions in Hilbish emit events. +Unlike Node.js, Hilbish events are global. So make sure to +pick a unique name! + +Usage of the Bait module consists of userstanding +event-driven architecture, but it's pretty simple: +If you want to act on a certain event, you can `catch` it. +You can act on events via callback functions. + +Examples of this are in the Hilbish default config! +Consider this part of it: +```lua +bait.catch('command.exit', function(code) + running = false + doPrompt(code ~= 0) + doNotifyPrompt() +end) +``` + +What this does is, whenever the `command.exit` event is thrown, +this function will set the user prompt. +*/ package bait import ( @@ -228,31 +247,17 @@ func handleHook(t *rt.Thread, c *rt.GoCont, name string, catcher *rt.Closure, ar } } -// throw(name, ...args) -// Throws a hook with `name` with the provided `args` -// --- @param name string -// --- @vararg any -func (b *Bait) bthrow(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { - if err := c.Check1Arg(); err != nil { - return nil, err - } - name, err := c.StringArg(0) - if err != nil { - return nil, err - } - ifaceSlice := make([]interface{}, len(c.Etc())) - for i, v := range c.Etc() { - ifaceSlice[i] = v - } - b.Emit(name, ifaceSlice...) - - return c.Next(), nil -} - // catch(name, cb) -// Catches a hook with `name`. Runs the `cb` when it is thrown -// --- @param name string -// --- @param cb function +// Catches an event. This function can be used to act on events. +// #param name string The name of the hook. +// #param cb function The function that will be called when the hook is thrown. +/* +#example +bait.catch('hilbish.exit', function() + print 'Goodbye Hilbish!' +end) +#example +*/ func (b *Bait) bcatch(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { name, catcher, err := util.HandleStrCallback(t, c) if err != nil { @@ -265,9 +270,9 @@ func (b *Bait) bcatch(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // catchOnce(name, cb) -// Same as catch, but only runs the `cb` once and then removes the hook -// --- @param name string -// --- @param cb function +// Catches an event, but only once. This will remove the hook immediately after it runs for the first time. +// #param name string The name of the event +// #param cb function The function that will be called when the event is thrown. func (b *Bait) bcatchOnce(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { name, catcher, err := util.HandleStrCallback(t, c) if err != nil { @@ -279,27 +284,10 @@ func (b *Bait) bcatchOnce(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { return c.Next(), nil } -// release(name, catcher) -// Removes the `catcher` for the event with `name`. -// For this to work, `catcher` has to be the same function used to catch -// an event, like one saved to a variable. -// --- @param name string -// --- @param catcher function -func (b *Bait) brelease(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { - name, catcher, err := util.HandleStrCallback(t, c) - if err != nil { - return nil, err - } - - b.OffLua(name, catcher) - - return c.Next(), nil -} - // hooks(name) -> table -// Returns a table with hooks (callback functions) on the event with `name`. -// --- @param name string -// --- @returns table +// Returns a table of functions that are hooked on an event with the corresponding `name`. +// #param name string The name of the hook +// #returns table func (b *Bait) bhooks(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -327,3 +315,62 @@ func (b *Bait) bhooks(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { return c.PushingNext1(t.Runtime, rt.TableValue(luaHandlers)), nil } + +// release(name, catcher) +// Removes the `catcher` for the event with `name`. +// For this to work, `catcher` has to be the same function used to catch +// an event, like one saved to a variable. +// #param name string Name of the event the hook is on +// #param catcher function Hook function to remove +/* +#example +local hookCallback = function() print 'hi' end + +bait.catch('event', hookCallback) + +-- a little while later.... +bait.release('event', hookCallback) +-- and now hookCallback will no longer be ran for the event. +#example +*/ +func (b *Bait) brelease(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { + name, catcher, err := util.HandleStrCallback(t, c) + if err != nil { + return nil, err + } + + b.OffLua(name, catcher) + + return c.Next(), nil +} + +// throw(name, ...args) +// #param name string The name of the hook. +// #param args ...any The arguments to pass to the hook. +// Throws a hook with `name` with the provided `args`. +/* +#example +bait.throw('greeting', 'world') + +-- This can then be listened to via +bait.catch('gretting', function(greetTo) + print('Hello ' .. greetTo) +end) +#example +*/ +func (b *Bait) bthrow(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { + if err := c.Check1Arg(); err != nil { + return nil, err + } + name, err := c.StringArg(0) + if err != nil { + return nil, err + } + ifaceSlice := make([]interface{}, len(c.Etc())) + for i, v := range c.Etc() { + ifaceSlice[i] = v + } + b.Emit(name, ifaceSlice...) + + return c.Next(), nil +} diff --git a/golibs/commander/commander.go b/golibs/commander/commander.go index c639cf9..ea2da7a 100644 --- a/golibs/commander/commander.go +++ b/golibs/commander/commander.go @@ -1,10 +1,9 @@ // library for custom commands /* -Commander is a library for writing custom commands in Lua. -In order to make it easier to write commands for Hilbish, -not require separate scripts and to be able to use in a config, -the Commander library exists. This is like a very simple wrapper -that works with Hilbish for writing commands. Example: +Commander is the library which handles Hilbish commands. This makes +the user able to add Lua-written commands to their shell without making +a separate script in a bin folder. Instead, you may simply use the Commander +library in your Hilbish config. ```lua local commander = require 'commander' @@ -19,14 +18,14 @@ that will print `Hello world!` to output. One question you may have is: What is the `sinks` parameter? The `sinks` parameter is a table with 3 keys: `in`, `out`, -and `err`. The values of these is a @Sink. +and `err`. All of them are a @Sink. -- `in` is the standard input. You can read from this sink -to get user input. (**This is currently unimplemented.**) -- `out` is standard output. This is usually where text meant for -output should go. -- `err` is standard error. This sink is for writing errors, as the -name would suggest. +- `in` is the standard input. +You may use the read functions on this sink to get input from the user. +- `out` is standard output. +This is usually where command output should go. +- `err` is standard error. +This sink is for writing errors, as the name would suggest. */ package commander @@ -67,9 +66,22 @@ func (c *Commander) loaderFunc(rtm *rt.Runtime) (rt.Value, func()) { } // register(name, cb) -// Register a command with `name` that runs `cb` when ran -// --- @param name string -// --- @param cb function +// Adds a new command with the given `name`. When Hilbish has to run a command with a name, +// it will run the function providing the arguments and sinks. +// #param name string Name of the command +// #param cb function Callback to handle command invocation +/* +#example +-- When you run the command `hello` in the shell, it will print `Hello world`. +-- If you run it with, for example, `hello Hilbish`, it will print 'Hello Hilbish' +commander.register('hello', function(args, sinks) + local name = 'world' + if #args > 0 then name = args[1] end + + sinks.out:writeln('Hello ' .. name) +end) +#example +*/ func (c *Commander) cregister(t *rt.Thread, ct *rt.GoCont) (rt.Cont, error) { cmdName, cmd, err := util.HandleStrCallback(t, ct) if err != nil { @@ -82,8 +94,8 @@ func (c *Commander) cregister(t *rt.Thread, ct *rt.GoCont) (rt.Cont, error) { } // deregister(name) -// Deregisters any command registered with `name` -// --- @param name string +// Removes the named command. Note that this will only remove Commander-registered commands. +// #param name string Name of the command to remove. func (c *Commander) cderegister(t *rt.Thread, ct *rt.GoCont) (rt.Cont, error) { if err := ct.Check1Arg(); err != nil { return nil, err diff --git a/golibs/fs/fs.go b/golibs/fs/fs.go index 538eff2..4c209de 100644 --- a/golibs/fs/fs.go +++ b/golibs/fs/fs.go @@ -1,7 +1,10 @@ // filesystem interaction and functionality library -// The fs module provides easy and simple access to filesystem functions -// and other things, and acts an addition to the Lua standard library's -// I/O and filesystem functions. +/* +The fs module provides filesystem functions to Hilbish. While Lua's standard +library has some I/O functions, they're missing a lot of the basics. The `fs` +library offers more functions and will work on any operating system Hilbish does. +#field pathSep The operating system's path separator. +*/ package fs import ( @@ -70,9 +73,46 @@ func loaderFunc(rtm *rt.Runtime) (rt.Value, func()) { return rt.TableValue(mod), nil } +// abs(path) -> string +// Returns an absolute version of the `path`. +// This can be used to resolve short paths like `..` to `/home/user`. +// #param path string +// #returns string +func fabs(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { + path, err := c.StringArg(0) + if err != nil { + return nil, err + } + path = util.ExpandHome(path) + + abspath, err := filepath.Abs(path) + if err != nil { + return nil, err + } + + return c.PushingNext1(t.Runtime, rt.StringValue(abspath)), nil +} + +// basename(path) -> string +// Returns the "basename," or the last part of the provided `path`. If path is empty, +// `.` will be returned. +// #param path string Path to get the base name of. +// #returns string +func fbasename(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { + if err := c.Check1Arg(); err != nil { + return nil, err + } + path, err := c.StringArg(0) + if err != nil { + return nil, err + } + + return c.PushingNext(t.Runtime, rt.StringValue(filepath.Base(path))), nil +} + // cd(dir) -// Changes directory to `dir` -// --- @param dir string +// Changes Hilbish's directory to `dir`. +// #param dir string Path to change directory to. func fcd(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -91,10 +131,103 @@ func fcd(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { return c.Next(), err } +// dir(path) -> string +// Returns the directory part of `path`. If a file path like +// `~/Documents/doc.txt` then this function will return `~/Documents`. +// #param path string Path to get the directory for. +// #returns string +func fdir(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { + if err := c.Check1Arg(); err != nil { + return nil, err + } + path, err := c.StringArg(0) + if err != nil { + return nil, err + } + + return c.PushingNext(t.Runtime, rt.StringValue(filepath.Dir(path))), nil +} + +// glob(pattern) -> matches (table) +// Match all files based on the provided `pattern`. +// For the syntax' refer to Go's filepath.Match function: https://pkg.go.dev/path/filepath#Match +// #param pattern string Pattern to compare files with. +// #returns table A list of file names/paths that match. +/* +#example +--[[ + Within a folder that contains the following files: + a.txt + init.lua + code.lua + doc.pdf +]]-- +local matches = fs.glob './*.lua' +print(matches) +-- -> {'init.lua', 'code.lua'} +#example +*/ +func fglob(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { + if err := c.Check1Arg(); err != nil { + return nil, err + } + pattern, err := c.StringArg(0) + if err != nil { + return nil, err + } + + matches, err := filepath.Glob(pattern) + if err != nil { + return nil, err + } + + luaMatches := rt.NewTable() + + for i, match := range matches { + luaMatches.Set(rt.IntValue(int64(i + 1)), rt.StringValue(match)) + } + + return c.PushingNext(t.Runtime, rt.TableValue(luaMatches)), nil +} + +// join(...path) -> string +// Takes any list of paths and joins them based on the operating system's path separator. +// #param path ...string Paths to join together +// #returns string The joined path. +/* +#example +-- This prints the directory for Hilbish's config! +print(fs.join(hilbish.userDir.config, 'hilbish')) +-- -> '/home/user/.config/hilbish' on Linux +#example +*/ +func fjoin(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { + strs := make([]string, len(c.Etc())) + for i, v := range c.Etc() { + if v.Type() != rt.StringType { + // +2; go indexes of 0 and first arg from above + return nil, fmt.Errorf("bad argument #%d to run (expected string, got %s)", i + 1, v.TypeName()) + } + strs[i] = v.AsString() + } + + res := filepath.Join(strs...) + + return c.PushingNext(t.Runtime, rt.StringValue(res)), nil +} + // mkdir(name, recursive) -// Makes a directory called `name`. If `recursive` is true, it will create its parent directories. -// --- @param name string -// --- @param recursive boolean +// Creates a new directory with the provided `name`. +// With `recursive`, mkdir will create parent directories. +// #param name string Name of the directory +// #param recursive boolean Whether to create parent directories for the provided name +/* +#example +-- This will create the directory foo, then create the directory bar in the +-- foo directory. If recursive is false in this case, it will fail. +fs.mkdir('./foo/bar', true) +#example +*/ func fmkdir(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.CheckNArgs(2); err != nil { return nil, err @@ -121,15 +254,58 @@ func fmkdir(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { return c.Next(), err } +// readdir(path) -> table[string] +// Returns a list of all files and directories in the provided path. +// #param dir string +// #returns table +func freaddir(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { + if err := c.Check1Arg(); err != nil { + return nil, err + } + dir, err := c.StringArg(0) + if err != nil { + return nil, err + } + dir = util.ExpandHome(dir) + names := rt.NewTable() + + dirEntries, err := os.ReadDir(dir) + if err != nil { + return nil, err + } + for i, entry := range dirEntries { + names.Set(rt.IntValue(int64(i + 1)), rt.StringValue(entry.Name())) + } + + return c.PushingNext1(t.Runtime, rt.TableValue(names)), nil +} + // stat(path) -> {} -// Returns a table of info about the `path`. -// It contains the following keys: +// Returns the information about a given `path`. +// The returned table contains the following values: // name (string) - Name of the path -// size (number) - Size of the path -// mode (string) - Permission mode in an octal format string (with leading 0) +// size (number) - Size of the path in bytes +// mode (string) - Unix permission mode in an octal format string (with leading 0) // isDir (boolean) - If the path is a directory -// --- @param path string -// --- @returns table +// #param path string +// #returns table +/* +#example +local inspect = require 'inspect' + +local stat = fs.stat '~' +print(inspect(stat)) +--[[ +Would print the following: +{ + isDir = true, + mode = "0755", + name = "username", + size = 12288 +} +]]-- +#example +*/ func fstat(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -153,132 +329,6 @@ func fstat(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { return c.PushingNext1(t.Runtime, rt.TableValue(statTbl)), nil } -// readdir(dir) -> {} -// Returns a table of files in `dir`. -// --- @param dir string -// --- @return table -func freaddir(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { - if err := c.Check1Arg(); err != nil { - return nil, err - } - dir, err := c.StringArg(0) - if err != nil { - return nil, err - } - dir = util.ExpandHome(dir) - names := rt.NewTable() - - dirEntries, err := os.ReadDir(dir) - if err != nil { - return nil, err - } - for i, entry := range dirEntries { - names.Set(rt.IntValue(int64(i + 1)), rt.StringValue(entry.Name())) - } - - return c.PushingNext1(t.Runtime, rt.TableValue(names)), nil -} - -// abs(path) -> string -// Gives an absolute version of `path`. -// --- @param path string -// --- @returns string -func fabs(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { - path, err := c.StringArg(0) - if err != nil { - return nil, err - } - path = util.ExpandHome(path) - - abspath, err := filepath.Abs(path) - if err != nil { - return nil, err - } - - return c.PushingNext1(t.Runtime, rt.StringValue(abspath)), nil -} - -// basename(path) -> string -// Gives the basename of `path`. For the rules, -// see Go's filepath.Base -// --- @returns string -func fbasename(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { - if err := c.Check1Arg(); err != nil { - return nil, err - } - path, err := c.StringArg(0) - if err != nil { - return nil, err - } - - return c.PushingNext(t.Runtime, rt.StringValue(filepath.Base(path))), nil -} - -// dir(path) -> string -// Returns the directory part of `path`. For the rules, see Go's -// filepath.Dir -// --- @param path string -// --- @returns string -func fdir(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { - if err := c.Check1Arg(); err != nil { - return nil, err - } - path, err := c.StringArg(0) - if err != nil { - return nil, err - } - - return c.PushingNext(t.Runtime, rt.StringValue(filepath.Dir(path))), nil -} - -// glob(pattern) -> matches (table) -// Glob all files and directories that match the pattern. -// For the rules, see Go's filepath.Glob -// --- @param pattern string -// --- @returns table -func fglob(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { - if err := c.Check1Arg(); err != nil { - return nil, err - } - pattern, err := c.StringArg(0) - if err != nil { - return nil, err - } - - matches, err := filepath.Glob(pattern) - if err != nil { - return nil, err - } - - luaMatches := rt.NewTable() - - for i, match := range matches { - luaMatches.Set(rt.IntValue(int64(i + 1)), rt.StringValue(match)) - } - - return c.PushingNext(t.Runtime, rt.TableValue(luaMatches)), nil -} - -// join(...) -> string -// Takes paths and joins them together with the OS's -// directory separator (forward or backward slash). -// --- @vararg string -// --- @returns string -func fjoin(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { - strs := make([]string, len(c.Etc())) - for i, v := range c.Etc() { - if v.Type() != rt.StringType { - // +2; go indexes of 0 and first arg from above - return nil, fmt.Errorf("bad argument #%d to run (expected string, got %s)", i + 1, v.TypeName()) - } - strs[i] = v.AsString() - } - - res := filepath.Join(strs...) - - return c.PushingNext(t.Runtime, rt.StringValue(res)), nil -} - func fwatch(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.CheckNArgs(2); err != nil { return nil, err diff --git a/golibs/terminal/terminal.go b/golibs/terminal/terminal.go index 2040fac..954a4dd 100644 --- a/golibs/terminal/terminal.go +++ b/golibs/terminal/terminal.go @@ -34,7 +34,7 @@ func loaderFunc(rtm *rt.Runtime) (rt.Value, func()) { // 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 +// NOTE: The size refers to the amount of columns and rows of text that can fit in the terminal. func termsize(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { w, h, err := term.GetSize(int(os.Stdin.Fd())) if err != nil { @@ -49,7 +49,7 @@ func termsize(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // saveState() -// Saves the current state of the terminal +// Saves the current state of the terminal. func termsaveState(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { state, err := term.GetState(int(os.Stdin.Fd())) if err != nil { @@ -72,7 +72,7 @@ func termrestoreState(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // setRaw() -// Puts the terminal in raw mode +// Puts the terminal into raw mode. func termsetRaw(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { _, err := term.MakeRaw(int(os.Stdin.Fd())) if err != nil { diff --git a/job.go b/job.go index 1beba9c..f5bd6f2 100644 --- a/job.go +++ b/job.go @@ -414,10 +414,16 @@ func (j *jobHandler) luaGetJob(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // #interface jobs // add(cmdstr, args, execPath) -// Adds a new job to the job table. Note that this does not immediately run it. -// --- @param cmdstr string -// --- @param args table -// --- @param execPath string +// Creates a new job. This function does not run the job. This function is intended to be +// used by runners, but can also be used to create jobs via Lua. Commanders cannot be ran as jobs. +// #param cmdstr string String that a user would write for the job +// #param args table Arguments for the commands. Has to include the name of the command. +// #param execPath string Binary to use to run the command. Needs to be an absolute path. +/* +#example +hilbish.jobs.add('go build', {'go', 'build'}, '/usr/bin/go') +#example +*/ func (j *jobHandler) luaAddJob(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.CheckNArgs(3); err != nil { return nil, err @@ -448,9 +454,9 @@ func (j *jobHandler) luaAddJob(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { } // #interface jobs -// all() -> table<@Job> +// all() -> table[@Job] // Returns a table of all job objects. -// --- @returns table +// #returns table[Job] func (j *jobHandler) luaAllJobs(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { j.mu.RLock() defer j.mu.RUnlock() @@ -465,8 +471,8 @@ func (j *jobHandler) luaAllJobs(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // #interface jobs // disown(id) -// Disowns a job. This deletes it from the job table. -// --- @param id number +// Disowns a job. This simply deletes it from the list of jobs without stopping it. +// #param id number func (j *jobHandler) luaDisownJob(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -486,8 +492,8 @@ func (j *jobHandler) luaDisownJob(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // #interface jobs // last() -> @Job -// Returns the last added job from the table. -// --- @returns Job +// Returns the last added job to the table. +// #returns Job func (j *jobHandler) luaLastJob(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { j.mu.RLock() defer j.mu.RUnlock() diff --git a/main.go b/main.go index 300f333..4b756c0 100644 --- a/main.go +++ b/main.go @@ -2,6 +2,7 @@ package main import ( "bufio" + "errors" "fmt" "io" "os" @@ -9,6 +10,7 @@ import ( "path/filepath" "runtime" "strings" + "syscall" "hilbish/util" "hilbish/golibs/bait" @@ -88,7 +90,7 @@ func main() { interactive = true } - if fileInfo, _ := os.Stdin.Stat(); (fileInfo.Mode() & os.ModeCharDevice) == 0 { + if fileInfo, _ := os.Stdin.Stat(); (fileInfo.Mode() & os.ModeCharDevice) == 0 || !term.IsTerminal(int(os.Stdin.Fd())) { interactive = false } @@ -189,8 +191,12 @@ input: } else { // If we get a completely random error, print fmt.Fprintln(os.Stderr, err) + if errors.Is(err, syscall.ENOTTY) { + // what are we even doing here? + panic("not a tty") + } + <-make(chan struct{}) } - // TODO: Halt if any other error occurs continue } var priv bool @@ -289,7 +295,7 @@ func removeDupes(slice []string) []string { func contains(s []string, e string) bool { for _, a := range s { - if a == e { + if strings.ToLower(a) == strings.ToLower(e) { return true } } @@ -324,3 +330,7 @@ func getVersion() string { return v.String() } + +func cut(slice []string, idx int) []string { + return append(slice[:idx], slice[idx + 1:]...) +} diff --git a/module.go b/module.go new file mode 100644 index 0000000..bf4e32a --- /dev/null +++ b/module.go @@ -0,0 +1,93 @@ +package main + +import ( + "plugin" + + "hilbish/util" + + rt "github.com/arnodel/golua/runtime" +) + +// #interface module +// native module loading +// #field paths A list of paths to search when loading native modules. This is in the style of Lua search paths and will be used when requiring native modules. Example: `?.so;?/?.so` +/* +The hilbish.module interface provides a function to load +Hilbish plugins/modules. Hilbish modules are Go-written +plugins (see https://pkg.go.dev/plugin) that are used to add functionality +to Hilbish that cannot be written in Lua for any reason. + +Note that you don't ever need to use the load function that is here as +modules can be loaded with a `require` call like Lua C modules, and the +search paths can be changed with the `paths` property here. + +To make a valid native module, the Go plugin has to export a Loader function +with a signature like so: `func(*rt.Runtime) rt.Value`. + +`rt` in this case refers to the Runtime type at +https://pkg.go.dev/github.com/arnodel/golua@master/runtime#Runtime + +Hilbish uses this package as its Lua runtime. You will need to read +it to use it for a native plugin. + +Here is some code for an example plugin: +```go +package main + +import ( + rt "github.com/arnodel/golua/runtime" +) + +func Loader(rtm *rt.Runtime) rt.Value { + return rt.StringValue("hello world!") +} +``` + +This can be compiled with `go build -buildmode=plugin plugin.go`. +If you attempt to require and print the result (`print(require 'plugin')`), it will show "hello world!" +*/ +func moduleLoader(rtm *rt.Runtime) *rt.Table { + exports := map[string]util.LuaExport{ + "load": {moduleLoad, 2, false}, + } + + mod := rt.NewTable() + util.SetExports(rtm, mod, exports) + + return mod +} + +// #interface module +// load(path) +// Loads a module at the designated `path`. +// It will throw if any error occurs. +// #param path string +func moduleLoad(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { + if err := c.CheckNArgs(1); err != nil { + return nil, err + } + + path, err := c.StringArg(0) + if err != nil { + return nil, err + } + + p, err := plugin.Open(path) + if err != nil { + return nil, err + } + + value, err := p.Lookup("Loader") + if err != nil { + return nil, err + } + + loader, ok := value.(func(*rt.Runtime) rt.Value) + if !ok { + return nil, nil + } + + val := loader(t.Runtime) + + return c.PushingNext1(t.Runtime, val), nil +} diff --git a/nature/commands/doc.lua b/nature/commands/doc.lua index d37e677..7263fe4 100644 --- a/nature/commands/doc.lua +++ b/nature/commands/doc.lua @@ -1,6 +1,42 @@ +local ansikit = require 'ansikit' local commander = require 'commander' local fs = require 'fs' local lunacolors = require 'lunacolors' +local Greenhouse = require 'nature.greenhouse' +local Page = require 'nature.greenhouse.page' +local docfuncs = require 'nature.doc' + +local function strip(text, ...) + for _, pat in ipairs {...} do + text = text:gsub(pat, '\n') + end + + return text +end + +local function transformHTMLandMD(text) + return strip(text, '|||', '|%-%-%-%-|%-%-%-%-|') + :gsub('|(.-)|(.-)|', function(entry1, entry2) + return string.format('%s - %s', entry1, entry2) + end) + :gsub('
', '{separator}') + :gsub('<.->', '') + --:gsub('^\n\n', '\n') + :gsub('\n%s+\n', '\n\n') + --:gsub(' \n', '\n\n') + :gsub('{{< (%w+) `(.-)` >}}', function(shortcode, text) + return docfuncs.renderInfoBlock(shortcode, text) + end) + :gsub('```(%w+)\n(.-)```', function(lang, text) + return docfuncs.renderCodeBlock(text) + end) + :gsub('```\n(.-)\n```', function(text) + return docfuncs.renderCodeBlock(text) + end) + :gsub('`[^\n].-`', lunacolors.cyan) + :gsub('#+ (.-\n)', function(heading) return lunacolors.blue(lunacolors.bold('→ ' .. heading)) end) + :gsub('%*%*(.-)%*%*', lunacolors.bold) +end commander.register('doc', function(args, sinks) local moddocPath = hilbish.dataDir .. '/docs/' @@ -9,11 +45,6 @@ commander.register('doc', function(args, sinks) -- hilbish git moddocPath = './docs/' end - local apidocHeader = [[ -# %s -{grayBg} {white}{italic}%s {reset} - -]] local modules = table.map(fs.readdir(moddocPath), function(f) return lunacolors.underline(lunacolors.blue(string.gsub(f, '.md', ''))) @@ -25,47 +56,18 @@ to Hilbish. Usage: doc
[subdoc] Available sections: ]] .. table.concat(modules, ', ') - if #args > 0 then - local mod = args[1] - - local f = io.open(moddocPath .. mod .. '.md', 'rb') - local funcdocs = nil - local subdocName = args[2] - if not f then - -- assume subdir - -- dataDir/docs//.md - moddocPath = moddocPath .. mod .. '/' - if not subdocName then - subdocName = '_index' - end - f = io.open(moddocPath .. subdocName .. '.md', 'rb') - if not f then - f = io.open(moddocPath .. subdocName:match '%w+' .. '/' .. subdocName .. '.md', 'rb') - end - if not f then - moddocPath = moddocPath .. subdocName .. '/' - subdocName = args[3] or '_index' - f = io.open(moddocPath .. subdocName .. '.md', 'rb') - end - if not f then - sinks.out:writeln('No documentation found for ' .. mod .. '.') - return 1 - end - end - funcdocs = f:read '*a':gsub('-([%d]+)', '%1') - local moddocs = table.filter(fs.readdir(moddocPath), function(f) return f ~= '_index.md' and f ~= 'index.md' end) - local subdocs = table.map(moddocs, function(fname) - return lunacolors.underline(lunacolors.blue(string.gsub(fname, '.md', ''))) - end) - if #moddocs ~= 0 then - funcdocs = funcdocs .. '\nSubdocs: ' .. table.concat(subdocs, ', ') - end - - local valsStr = funcdocs:match '%-%-%-\n([^%-%-%-]+)\n' + local f + local function handleYamlInfo(d) local vals = {} + local docs = d + + local valsStr = docs:match '^%-%-%-\n.-\n%-%-%-' if valsStr then - local _, endpos = funcdocs:find('---\n' .. valsStr .. '\n---\n\n', 1, true) - funcdocs = funcdocs:sub(endpos + 1, #funcdocs) + docs = docs:sub(valsStr:len() + 2, #docs) + local pre = docs:sub(1, 1) + if pre == '\n' then + docs = docs:sub(2) + end -- parse vals local lines = string.split(valsStr, '\n') @@ -78,23 +80,113 @@ Available sections: ]] .. table.concat(modules, ', ') end end end - if mod == 'api' then - funcdocs = string.format(apidocHeader, vals.title, vals.description or 'no description.') .. funcdocs - end - doc = funcdocs:sub(1, #funcdocs - 1) - f:close() + + --docs = docs:sub(1, #docs - 1) + return docs, vals end - local backtickOccurence = 0 - sinks.out:writeln(lunacolors.format(doc:gsub('`', function() - backtickOccurence = backtickOccurence + 1 - if backtickOccurence % 2 == 0 then - return '{reset}' - else - return '{underline}{green}' + if #args > 0 then + local mod = args[1] + + f = io.open(moddocPath .. mod .. '.md', 'rb') + local funcdocs = nil + local subdocName = args[2] + if not f then + moddocPath = moddocPath .. mod .. '/' + if not subdocName then + subdocName = '_index' + end + f = io.open(moddocPath .. subdocName .. '.md', 'rb') + local oldmoddocPath = moddocPath + if not f then + moddocPath = moddocPath .. subdocName:match '%w+' .. '/' + f = io.open(moddocPath .. subdocName .. '.md', 'rb') + end + if not f then + moddocPath = oldmoddocPath .. subdocName .. '/' + subdocName = args[3] or '_index' + f = io.open(moddocPath .. subdocName .. '.md', 'rb') + end + if not f then + sinks.out:writeln('No documentation found for ' .. mod .. '.') + return 1 + end end - end):gsub('\n#+.-\n', function(t) - local signature = t:gsub('<.->(.-)', '{underline}%1'):gsub('\\', '<') - return '{bold}{yellow}' .. signature .. '{reset}' - end))) + + end + + local moddocs = table.filter(fs.readdir(moddocPath), function(f) return f ~= '_index.md' and f ~= 'index.md' end) + local subdocs = table.map(moddocs, function(fname) + return lunacolors.underline(lunacolors.blue(string.gsub(fname, '.md', ''))) + end) + + local gh = Greenhouse(sinks.out) + function gh:resize() + local size = terminal.size() + self.region = { + width = size.width, + height = size.height - 1 + } + end + gh:resize() + + function gh:render() + local workingPage = self.pages[self.curPage] + local offset = self.offset + if self.isSpecial then + offset = self.specialOffset + workingPage = self.specialPage + end + local size = terminal.size() + + self.sink:write(ansikit.getCSI(size.height - 1 .. ';1', 'H')) + self.sink:write(ansikit.getCSI(0, 'J')) + if not self.isSpecial then + if args[1] == 'api' then + self.sink:writeln(workingPage.title) + self.sink:write(lunacolors.format(string.format('{grayBg} ↳ {white}{italic}%s {reset}', workingPage.description or 'No description.'))) + else + self.sink:write(lunacolors.reset(string.format('Viewing doc page %s', moddocPath))) + end + end + end + local backtickOccurence = 0 + local function formatDocText(d) + return transformHTMLandMD(d) + --[[ + return lunacolors.format(d:gsub('`(.-)`', function(t) + return docfuncs.renderCodeBlock(t) + end):gsub('\n#+.-\n', function(t) + local signature = t:gsub('<.->(.-)', '{underline}%1'):gsub('\\', '<') + return '{bold}{yellow}' .. signature .. '{reset}' + end)) + ]]-- + end + + + local doc, vals = handleYamlInfo(#args == 0 and doc or formatDocText(f:read '*a')) + if #moddocs ~= 0 and f then + doc = doc .. '\nSubdocs: ' .. table.concat(subdocs, ', ') .. '\n\n' + end + if f then f:close() end + + local page = Page(vals.title, doc) + page.description = vals.description + gh:addPage(page) + + -- add subdoc pages + for _, sdName in ipairs(moddocs) do + local sdFile = fs.join(sdName, '_index.md') + if sdName:match '.md$' then + sdFile = sdName + end + + local f = io.open(moddocPath .. sdFile, 'rb') + local doc, vals = handleYamlInfo(formatDocText(f:read '*a')) + local page = Page(vals.title or sdName, doc) + page.description = vals.description + gh:addPage(page) + end + ansikit.hideCursor() + gh:initUi() end) diff --git a/nature/commands/greenhouse.lua b/nature/commands/greenhouse.lua new file mode 100644 index 0000000..9c155b0 --- /dev/null +++ b/nature/commands/greenhouse.lua @@ -0,0 +1,124 @@ +local ansikit = require 'ansikit' +local bait = require 'bait' +local commander = require 'commander' +local hilbish = require 'hilbish' +local lunacolors = require 'lunacolors' +local terminal = require 'terminal' +local Greenhouse = require 'nature.greenhouse' +local Page = require 'nature.greenhouse.page' + +commander.register('greenhouse', function(args, sinks) + local gh = Greenhouse(sinks.out) + + local buffer = '' + local display = '' + local command = false + local commands = { + q = function() + gh.keybinds['Ctrl-D'](gh) + end, + ['goto'] = function(args) + if not args[1] then + return 'nuh uh' + end + gh:jump(tonumber(args[1])) + end + } + + function gh:resize() + local size = terminal.size() + self.region = { + width = size.width, + height = size.height - 2 + } + end + + function gh:render() + local workingPage = self.pages[self.curPage] + local offset = self.offset + if self.isSpecial then + offset = self.specialOffset + workingPage = self.specialPage + end + + self.sink:write(ansikit.getCSI(self.region.height + 1 .. ';1', 'H')) + if not self.isSpecial then + self.sink:writeln(lunacolors.format(string.format('{grayBg} ↳ Page %d%s{reset}', self.curPage, workingPage.title and ' — ' .. workingPage.title .. ' ' or ''))) + end + self.sink:write(buffer == '' and display or buffer) + end + function gh:input(c) + -- command handling + if c == ':' and not command then + command = true + end + if c == 'Escape' then + if command then + command = false + buffer = '' + else + if self.isSpecial then gh:special() end + end + elseif c == 'Backspace' then + buffer = buffer:sub(0, -2) + if buffer == '' then + command = false + else + goto update + end + end + + if command then + ansikit.showCursor() + if buffer:match '^:' then buffer = buffer .. c else buffer = c end + else + ansikit.hideCursor() + end + + ::update:: + gh:update() + end + gh:resize() + + gh:keybind('Enter', function(self) + if self.isSpecial then + self:jump(self.specialPageIdx) + self:special(false) + else + if buffer:len() < 2 then return end + + local splitBuf = string.split(buffer, " ") + local command = commands[splitBuf[1]:sub(2)] + if command then + table.remove(splitBuf, 1) + buffer = command(splitBuf) or '' + end + self:update() + end + end) + + if sinks['in'].pipe then + local page = Page('stdin', sinks['in']:readAll()) + gh:addPage(page) + end + + for _, name in ipairs(args) do + local f = io.open(name, 'r') + if not f then + sinks.err:writeln(string.format('could not open file %s', name)) + end + local page = Page(name, f:read '*a') + gh:addPage(page) + end + + if #gh.pages == 0 then + sinks.out:writeln [[greenhouse is the Hilbish pager library and command! +usage: greenhouse ... + +example: greenhouse hello.md]] + return 1 + end + + ansikit.hideCursor() + gh:initUi() +end) diff --git a/nature/dirs.lua b/nature/dirs.lua index 5b7ec86..328b4b7 100644 --- a/nature/dirs.lua +++ b/nature/dirs.lua @@ -1,3 +1,4 @@ +-- @module dirs local fs = require 'fs' local dirs = {} @@ -11,8 +12,8 @@ dirs.recentDirs = {} dirs.recentSize = 10 --- Get (and remove) a `num` of entries from recent directories. ---- @param num number ---- @param remove boolean Whether to remove items +-- @param num number +-- @param remove boolean Whether to remove items function dirRecents(num, remove) num = num or 1 local entries = {} @@ -34,12 +35,12 @@ function dirRecents(num, remove) end --- Look at `num` amount of recent directories, starting from the latest. ---- @param num? number +-- @param num? number function dirs.peak(num) return dirRecents(num) end ---- Add `d` to the recent directories. +--- Add `d` to the recent directories list. function dirs.push(d) dirs.recentDirs[dirs.recentSize + 1] = nil if dirs.recentDirs[#dirs.recentDirs - 1] ~= d then @@ -50,20 +51,20 @@ function dirs.push(d) end end ---- Remove `num` amount of dirs from the recent directories. ---- @param num number +--- Remove the specified amount of dirs from the recent directories list. +-- @param num number function dirs.pop(num) return dirRecents(num, true) end ---- Get entry from recent directories. ---- @param idx number +--- Get entry from recent directories list based on index. +-- @param idx number function dirs.recent(idx) return dirs.recentDirs[idx] end ---- Sets the old directory. ---- @param d string +--- Sets the old directory string. +-- @param d string function dirs.setOld(d) ok, d = pcall(fs.abs, d) assert(ok, 'could not turn "' .. d .. '"into an absolute path') diff --git a/nature/doc.lua b/nature/doc.lua new file mode 100644 index 0000000..657af51 --- /dev/null +++ b/nature/doc.lua @@ -0,0 +1,47 @@ +local lunacolors = require 'lunacolors' + +local M = {} + +function M.highlight(text) + return text:gsub('\'.-\'', lunacolors.yellow) + --:gsub('%-%- .-', lunacolors.black) +end + +function M.renderCodeBlock(text) + local longest = 0 + local lines = string.split(text:gsub('\t', ' '), '\n') + + for i, line in ipairs(lines) do + local len = line:len() + if len > longest then longest = len end + end + + for i, line in ipairs(lines) do + lines[i] = ' ' .. M.highlight(line:sub(0, longest)) + .. string.rep(' ', longest - line:len()) .. ' ' + end + + return '\n' .. lunacolors.format('{greyBg}' .. table.concat(lines, '\n')) .. '\n' +end + +function M.renderInfoBlock(type, text) + local longest = 0 + local lines = string.split(text:gsub('\t', ' '), '\n') + + for i, line in ipairs(lines) do + local len = line:len() + if len > longest then longest = len end + end + + for i, line in ipairs(lines) do + lines[i] = ' ' .. M.highlight(line:sub(0, longest)) + .. string.rep(' ', longest - line:len()) .. ' ' + end + + local heading + if type == 'warning' then + heading = lunacolors.yellowBg(lunacolors.black(' ⚠ Warning ')) + end + return '\n' .. heading .. '\n' .. lunacolors.format('{greyBg}' .. table.concat(lines, '\n')) .. '\n' +end +return M diff --git a/nature/greenhouse/init.lua b/nature/greenhouse/init.lua new file mode 100644 index 0000000..50d5fad --- /dev/null +++ b/nature/greenhouse/init.lua @@ -0,0 +1,325 @@ +-- Greenhouse is a simple text scrolling handler for terminal programs. +-- The idea is that it can be set a region to do its scrolling and paging +-- job and then the user can draw whatever outside it. +-- This reduces code duplication for the message viewer +-- and flowerbook. + +local ansikit = require 'ansikit' +local lunacolors = require 'lunacolors' +local terminal = require 'terminal' +local Page = require 'nature.greenhouse.page' +local Object = require 'nature.object' + +local Greenhouse = Object:extend() + +function Greenhouse:new(sink) + local size = terminal.size() + self.region = size + self.contents = nil -- or can be a table + self.start = 1 -- where to start drawing from (should replace with self.region.y) + self.offset = 1 -- vertical text offset + self.horizOffset = 1 + self.sink = sink + self.pages = {} + self.curPage = 1 + self.step = { + horizontal = 5, + vertical = 1 + } + self.separator = '─' + self.keybinds = { + ['Up'] = function(self) self:scroll 'up' end, + ['Down'] = function(self) self:scroll 'down' end, + ['Left'] = function(self) self:scroll 'left' end, + ['Right'] = function(self) self:scroll 'right' end, + ['Ctrl-Left'] = self.previous, + ['Ctrl-Right'] = self.next, + ['Ctrl-N'] = function(self) self:toc(true) end, + ['Enter'] = function(self) + if self.isSpecial then + self:jump(self.specialPageIdx) + self:special(false) + end + end, + ['Page-Down'] = function(self) self:scroll('down', {page = true}) end, + ['Page-Up'] = function(self) self:scroll('up', {page = true}) end + } + self.isSpecial = false + self.specialPage = nil + self.specialPageIdx = 1 + self.specialOffset = 1 + + return self +end + +function Greenhouse:addPage(page) + table.insert(self.pages, page) +end + +function Greenhouse:updateCurrentPage(text) + local page = self.pages[self.curPage] + page:setText(text) +end + +function Greenhouse:sub(str, offset, limit) + local overhead = 0 + local function addOverhead(s) + overhead = overhead + string.len(s) + end + + local s = str:gsub('\x1b%[%d+;%d+;%d+;%d+;%d+%w', addOverhead) + :gsub('\x1b%[%d+;%d+;%d+;%d+%w', addOverhead) + :gsub('\x1b%[%d+;%d+;%d+%w',addOverhead) + :gsub('\x1b%[%d+;%d+%w', addOverhead) + :gsub('\x1b%[%d+%w', addOverhead) + + return s:sub(offset, utf8.offset(str, limit + overhead) or limit + overhead) + --return s:sub(offset, limit + overhead) +end + +function Greenhouse:draw() + local workingPage = self.pages[self.curPage] + local offset = self.offset + if self.isSpecial then + offset = self.specialOffset + workingPage = self.specialPage + end + + if workingPage.lazy and not workingPage.loaded then + workingPage.initialize() + end + + local lines = workingPage.lines + self.sink:write(ansikit.getCSI(self.start .. ';1', 'H')) + self.sink:write(ansikit.getCSI(2, 'J')) + + local writer = self.sink.writeln + for i = offset, offset + self.region.height - 1 do + if i > #lines then break end + + if i == offset + self.region.height - 1 then writer = self.sink.write end + + self.sink:write(ansikit.getCSI(self.start + i - offset .. ';1', 'H')) + local line = lines[i]:gsub('{separator}', function() return self.separator:rep(self.region.width - 1) end) + writer(self.sink, self:sub(line:gsub('\t', ' '), self.horizOffset, self.region.width)) + end + writer(self.sink, '\27[0m') + self:render() +end + +function Greenhouse:render() +end + +function Greenhouse:scroll(direction, opts) + opts = opts or {} + + if self.isSpecial then + if direction == 'down' then + self:next(true) + elseif direction == 'up' then + self:previous(true) + end + return + end + + local lines = self.pages[self.curPage].lines + + local oldOffset = self.offset + local oldHorizOffset = self.horizOffset + local amount = self.step.vertical + if opts.page then + amount = self.region.height + end + + if direction == 'down' then + self.offset = math.min(self.offset + amount, math.max(1, #lines - self.region.height)) + elseif direction == 'up' then + self.offset = math.max(self.offset - amount, 1) + end + +--[[ + if direction == 'left' then + self.horizOffset = math.max(self.horizOffset - self.step.horizontal, 1) + elseif direction == 'right' then + self.horizOffset = self.horizOffset + self.step.horizontal + end +]]-- + + if self.offset ~= oldOffset then self:draw() end + if self.horizOffset ~= oldHorizOffset then self:draw() end +end + +function Greenhouse:update() + self:resize() + if self.isSpecial then + self:updateSpecial() + end + + self:draw() +end + + +function Greenhouse:special(val) + self.isSpecial = val + self:update() +end + +function Greenhouse:toggleSpecial() + self:special(not self.isSpecial) +end + +--- This function will be called when the special page +--- is on and needs to be updated. +function Greenhouse:updateSpecial() +end + +function Greenhouse:contents() +end + +function Greenhouse:toc(toggle) + if not self.isSpecial then + self.specialPageIdx = self.curPage + end + if toggle then self.isSpecial = not self.isSpecial end + -- Generate a special page for our table of contents + local tocText = string.format([[ +%s + +]], lunacolors.cyan(lunacolors.bold '―― Table of Contents ――')) + + local genericPageCount = 1 + local contents = self:contents() + if contents then + for i, c in ipairs(contents) do + local title = c.title + if c.active then + title = lunacolors.invert(title) + end + + tocText = tocText .. title .. '\n' + end + else + for i, page in ipairs(self.pages) do + local title = page.title + if title == 'Page' then + title = 'Page #' .. genericPageCount + genericPageCount = genericPageCount + 1 + end + if i == self.specialPageIdx then + title = lunacolors.invert(title) + end + + tocText = tocText .. title .. '\n' + end + end + self.specialPage = Page('TOC', tocText) + function self:updateSpecial() + self:toc() + end + self:draw() +end + +function Greenhouse:resize() + local size = terminal.size() + self.region = size +end + +function Greenhouse:next(special) + local oldCurrent = special and self.specialPageIdx or self.curPage + local pageIdx = math.min(oldCurrent + 1, #self.pages) + + if special then + self.specialPageIdx = pageIdx + else + self.curPage = pageIdx + end + + if pageIdx ~= oldCurrent then + self.offset = 1 + self:update() + end +end + +function Greenhouse:previous(special) + local oldCurrent = special and self.specialPageIdx or self.curPage + local pageIdx = math.max(self.curPage - 1, 1) + + if special then + self.specialPageIdx = pageIdx + else + self.curPage = pageIdx + end + + if pageIdx ~= oldCurrent then + self.offset = 1 + self:update() + end +end + +function Greenhouse:jump(idx) + if idx ~= self.curPage then + self.offset = 1 + end + self.curPage = idx + self:update() +end + +function Greenhouse:keybind(key, callback) + self.keybinds[key] = callback +end + +function Greenhouse:input(char) +end + +function Greenhouse:initUi() + local ansikit = require 'ansikit' + local bait = require 'bait' + local commander = require 'commander' + local hilbish = require 'hilbish' + local terminal = require 'terminal' + local Page = require 'nature.greenhouse.page' + local done = false + + bait.catch('signal.sigint', function() + ansikit.clear() + done = true + end) + + bait.catch('signal.resize', function() + self:update() + end) + + ansikit.screenAlt() + ansikit.clear(true) + self:draw() + + while not done do + local c = read() + self:keybind('Ctrl-Q', function() + done = true + end) + self:keybind('Ctrl-D', function() + done = true + end) + + if self.keybinds[c] then + self.keybinds[c](self) + else + self:input(c) + end + end + + ansikit.showCursor() + ansikit.screenMain() +end + +function read() + terminal.saveState() + terminal.setRaw() + local c = hilbish.editor.readChar() + + terminal.restoreState() + return c +end + +return Greenhouse diff --git a/nature/greenhouse/page.lua b/nature/greenhouse/page.lua new file mode 100644 index 0000000..51d1440 --- /dev/null +++ b/nature/greenhouse/page.lua @@ -0,0 +1,32 @@ +local Object = require 'nature.object' + +local Page = Object:extend() + +function Page:new(title, text) + self:setText(text) + self.title = title or 'Page' + self.lazy = false + self.loaded = true + self.children = {} +end + +function Page:setText(text) + self.lines = string.split(text, '\n') +end + +function Page:setTitle(title) + self.title = title +end + +function Page:dynamic(initializer) + self.initializer = initializer + self.lazy = true + self.loaded = false +end + +function Page:initialize() + self.initializer() + self.loaded = true +end + +return Page diff --git a/nature/init.lua b/nature/init.lua index 9e78135..a0579d7 100644 --- a/nature/init.lua +++ b/nature/init.lua @@ -6,6 +6,18 @@ local fs = require 'fs' package.path = package.path .. ';' .. hilbish.dataDir .. '/?/init.lua' .. ';' .. hilbish.dataDir .. '/?/?.lua' .. ";" .. hilbish.dataDir .. '/?.lua' +hilbish.module.paths = '?.so;?/?.so;' +.. hilbish.userDir.data .. 'hilbish/libs/?/?.so' +.. ";" .. hilbish.userDir.data .. 'hilbish/libs/?.so' + +table.insert(package.searchers, function(module) + local path = package.searchpath(module, hilbish.module.paths) + if not path then return nil end + + -- it didnt work normally, idk + return function() return hilbish.module.load(path) end, path +end) + require 'nature.commands' require 'nature.completions' require 'nature.opts' diff --git a/nature/object.lua b/nature/object.lua new file mode 100644 index 0000000..053be4a --- /dev/null +++ b/nature/object.lua @@ -0,0 +1,59 @@ +---@class nature.object +---@field super nature.object +local Object = {} +Object.__index = Object + +---Can be overrided by child objects to implement a constructor. +function Object:new() end + +---@return nature.object +function Object:extend() + local cls = {} + for k, v in pairs(self) do + if k:find("__") == 1 then + cls[k] = v + end + end + cls.__index = cls + cls.super = self + setmetatable(cls, self) + return cls +end + +---Check if the object is strictly of the given type. +---@param T any +---@return boolean +function Object:is(T) + return getmetatable(self) == T +end + +---Check if the object inherits from the given type. +---@param T any +---@return boolean +function Object:extends(T) + local mt = getmetatable(self) + while mt do + if mt == T then + return true + end + mt = getmetatable(mt) + end + return false +end + +---Metamethod to get a string representation of an object. +---@return string +function Object:__tostring() + return "Object" +end + +---Methamethod to allow using the object call as a constructor. +---@return nature.object +function Object:__call(...) + local obj = setmetatable({}, self) + obj:new(...) + return obj +end + + +return Object diff --git a/nature/opts/crimmas.lua b/nature/opts/crimmas.lua new file mode 100644 index 0000000..e187113 --- /dev/null +++ b/nature/opts/crimmas.lua @@ -0,0 +1,11 @@ +local lunacolors = require 'lunacolors' + +bait.catch('hilbish.init', function() + + if os.date '%m' == '12' and hilbish.interactive and hilbish.opts.crimmas then + local crimmas = math.random(1, 31) + if crimmas >= 25 and crimmas <= 29 then + print(lunacolors.format '🎄 {green}Merry {red}Christmas{reset} from your {green}favourite{reset} shell {red}(right?){reset} 🌺') + end + end +end) diff --git a/nature/opts/init.lua b/nature/opts/init.lua index 56c34ba..474ea3b 100644 --- a/nature/opts/init.lua +++ b/nature/opts/init.lua @@ -1,21 +1,7 @@ -local opts = {} hilbish.opts = {} -setmetatable(hilbish.opts, { - __newindex = function(_, k, v) - if opts[k] == nil then - error(string.format('opt %s does not exist', k)) - end - - opts[k] = v - end, - __index = function(_, k) - return opts[k] - end -}) - local function setupOpt(name, default) - opts[name] = default + hilbish.opts[name] = default pcall(require, 'nature.opts.' .. name) end @@ -27,7 +13,8 @@ The nice lil shell for {blue}Lua{reset} fanatics! ]], hilbish.user), motd = true, fuzzy = false, - notifyJobFinish = true + notifyJobFinish = true, + crimmas = true } for optsName, default in pairs(defaultOpts) do diff --git a/nature/opts/motd.lua b/nature/opts/motd.lua index 79954d6..c1f31b4 100644 --- a/nature/opts/motd.lua +++ b/nature/opts/motd.lua @@ -2,8 +2,8 @@ local bait = require 'bait' local lunacolors = require 'lunacolors' hilbish.motd = [[ -1000 commits on the Hilbish repository brings us to {cyan}Version 2.1!{reset} -Docs, docs, docs... At least builtins work with pipes now. +Finally at {red}v2.2!{reset} So much {green}documentation improvements{reset} +and 1 single fix for Windows! {blue}.. and a feature they can't use.{reset} ]] bait.catch('hilbish.init', function() diff --git a/os.go b/os.go index da9eadd..46e3d3c 100644 --- a/os.go +++ b/os.go @@ -8,10 +8,9 @@ import ( ) // #interface os -// OS Info -// The `os` interface provides simple text information properties about -// the current OS on the systen. This mainly includes the name and -// version. +// operating system info +// Provides simple text information properties about the current operating system. +// This mainly includes the name and version. // #field family Family name of the current OS // #field name Pretty name of the current OS // #field version Version of the current OS diff --git a/pprof.go b/pprof.go new file mode 100644 index 0000000..977eeb0 --- /dev/null +++ b/pprof.go @@ -0,0 +1,14 @@ +// +build pprof + +package main + +import ( + _ "net/http/pprof" + "net/http" +) + +func init() { + go func() { + http.ListenAndServe("localhost:8080", nil) + }() +} diff --git a/readline/codes.go b/readline/codes.go index 492bc72..28a9e60 100644 --- a/readline/codes.go +++ b/readline/codes.go @@ -1,5 +1,7 @@ package readline +import "os" + // Character codes const ( charCtrlA = iota + 1 @@ -58,6 +60,8 @@ var ( seqAltF = string([]byte{27, 102}) seqAltR = string([]byte{27, 114}) // Used for alternative history seqAltBackspace = string([]byte{27, 127}) + seqPageUp = string([]byte{27, 91, 53, 126}) + seqPageDown = string([]byte{27, 91, 54, 126}) ) const ( @@ -72,6 +76,8 @@ const ( seqCursorTopLeft = "\x1b[H" // Clears screen and places cursor on top-left seqGetCursorPos = "\x1b6n" // response: "\x1b{Line};{Column}R" + seqHideCursor = "\x1b[?25l" + seqUnhideCursor = "\x1b[?25h" seqCtrlLeftArrow = "\x1b[1;5D" seqCtrlRightArrow = "\x1b[1;5C" @@ -134,3 +140,59 @@ const ( const ( seqCtermFg255 = "\033[48;5;255m" ) + +// TODO: return whether its actually a sequence or not +// remedies the edge case of someone literally typing Ctrl-A for example. +func (rl *Instance) ReadChar() string { + b := make([]byte, 1024) + i, _ := os.Stdin.Read(b) + r := []rune(string(b)) + s := string(r[:i]) + + switch b[0] { + case charCtrlA: return "Ctrl-A" + case charCtrlB: return "Ctrl-B" + case charCtrlC: return "Ctrl-C" + case charEOF: return "Ctrl-D" + case charCtrlE: return "Ctrl-E" + case charCtrlF: return "Ctrl-F" + case charCtrlG: return "Ctrl-G" + case charBackspace, charBackspace2: return "Backspace" + case charTab: return "Tab" + case charCtrlK: return "Ctrl-K" + case charCtrlL: return "Ctrl-L" + case charCtrlN: return "Ctrl-N" + case charCtrlO: return "Ctrl-O" + case charCtrlP: return "Ctrl-P" + case charCtrlQ: return "Ctrl-Q" + case charCtrlR: return "Ctrl-R" + case charCtrlS: return "Ctrl-S" + case charCtrlT: return "Ctrl-T" + case charCtrlU: return "Ctrl-U" + case charCtrlV: return "Ctrl-V" + case charCtrlW: return "Ctrl-W" + case charCtrlX: return "Ctrl-X" + case charCtrlY: return "Ctrl-Y" + case charCtrlZ: return "Ctrl-Z" + case '\r': fallthrough + case '\n': return "Enter" + case charEscape: + switch s { + case string(charEscape): return "Escape" + case seqUp: return "Up" + case seqDown: return "Down" + case seqBackwards: return "Left" + case seqForwards: return "Right" + case seqCtrlLeftArrow: return "Ctrl-Left" + case seqCtrlRightArrow: return "Ctrl-Right" + case seqCtrlDelete, seqCtrlDelete2: return "Ctrl-Delete" + case seqHome, seqHomeSc: return "Home" + case seqEnd, seqEndSc: return "End" + case seqDelete, seqDelete2: return "Delete" + case seqPageUp: return "Page-Up" + case seqPageDown: return "Page-Down" + } + } + + return s +} diff --git a/readline/cursor.go b/readline/cursor.go index f313ef4..9d68a5a 100644 --- a/readline/cursor.go +++ b/readline/cursor.go @@ -1,6 +1,7 @@ package readline import ( +// "fmt" "os" "regexp" "strconv" @@ -68,6 +69,40 @@ func (rl *Instance) getCursorPos() (x int, y int) { // This means that they are not used to keep any reference point when // when we internally move around clearning and printing things +/* +func moveCursorUpBuffered(i int) { + if i < 1 { + return + } + + fmt.Fprintf(rl.bufferedOut, "\x1b[%dA", i) +} + +func moveCursorDownBuffered(i int) { + if i < 1 { + return + } + + fmt.Fprintf(rl.bufferedOut, "\x1b[%dB", i) +} + +func moveCursorForwardsBuffered(i int) { + if i < 1 { + return + } + + fmt.Fprintf(rl.bufferedOut, "\x1b[%dC", i) +} + +func moveCursorUpBuffered(i int) { + if i < 1 { + return + } + + fmt.Fprintf(rl.bufferedOut, "\x1b[%dD", i) +} +*/ + func moveCursorUp(i int) { if i < 1 { return @@ -100,6 +135,14 @@ func moveCursorBackwards(i int) { printf("\x1b[%dD", i) } +func hideCursor() { + print(seqHideCursor) +} + +func unhideCursor() { + print(seqUnhideCursor) +} + func (rl *Instance) backspace(forward bool) { if len(rl.line) == 0 || rl.pos == 0 { return diff --git a/readline/go.mod b/readline/go.mod index ab404cd..d5322dc 100644 --- a/readline/go.mod +++ b/readline/go.mod @@ -1,6 +1,6 @@ module github.com/maxlandon/readline -go 1.16 +go 1.18 require ( github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d diff --git a/readline/history.go b/readline/history.go index f772813..e226b4d 100644 --- a/readline/history.go +++ b/readline/history.go @@ -156,8 +156,8 @@ func (rl *Instance) walkHistory(i int) { rl.updateHelpers() // In order to avoid having to type j/k twice each time for history navigation, - // we walk once again. This only ever happens when we aren't out of bounds. - if dedup && old == new { + // we walk once again. This only ever happens when we aren't out of bounds and the last history item was not a empty string. + if new != "" && dedup && old == new { rl.walkHistory(i) } } diff --git a/readline/instance.go b/readline/instance.go index a477246..163bffe 100644 --- a/readline/instance.go +++ b/readline/instance.go @@ -1,6 +1,7 @@ package readline import ( + "bufio" "os" "regexp" "sync" @@ -203,6 +204,8 @@ type Instance struct { ViActionCallback func(ViAction, []string) RawInputCallback func([]rune) // called on all input + + bufferedOut *bufio.Writer } // NewInstance is used to create a readline instance and initialise it with sane defaults. @@ -251,6 +254,8 @@ func NewInstance() *Instance { return suggs } + rl.bufferedOut = bufio.NewWriter(os.Stdout) + // Registers rl.initRegisters() diff --git a/readline/line.go b/readline/line.go index 2024bb0..3069ad8 100644 --- a/readline/line.go +++ b/readline/line.go @@ -33,19 +33,20 @@ func (rl *Instance) GetLine() []rune { func (rl *Instance) echo() { // Then we print the prompt, and the line, + hideCursor() switch { case rl.PasswordMask != 0: case rl.PasswordMask > 0: - print(strings.Repeat(string(rl.PasswordMask), len(rl.line)) + " ") + rl.bufprint(strings.Repeat(string(rl.PasswordMask), len(rl.line)) + " ") default: + // Go back to prompt position, and clear everything below moveCursorBackwards(GetTermWidth()) moveCursorUp(rl.posY) - print(seqClearScreenBelow) // Print the prompt - print(string(rl.realPrompt)) + rl.bufprint(string(rl.realPrompt)) // Assemble the line, taking virtual completions into account var line []rune @@ -57,11 +58,14 @@ func (rl *Instance) echo() { // Print the input line with optional syntax highlighting if rl.SyntaxHighlighter != nil { - print(rl.SyntaxHighlighter(line)) + rl.bufprint(rl.SyntaxHighlighter(line)) } else { - print(string(line)) + rl.bufprint(string(line)) } + rl.bufprint(seqClearScreenBelow) + } + rl.bufflush() // Update references with new coordinates only now, because // the new line may be longer/shorter than the previous one. @@ -72,6 +76,7 @@ func (rl *Instance) echo() { moveCursorUp(rl.fullY) moveCursorDown(rl.posY) moveCursorForwards(rl.posX) + unhideCursor() } func (rl *Instance) insert(r []rune) { @@ -159,7 +164,7 @@ func (rl *Instance) clearLine() { moveCursorForwards(rl.promptLen) // Clear everything after & below the cursor - print(seqClearScreenBelow) + //print(seqClearScreenBelow) // Real input line rl.line = []rune{} diff --git a/readline/prompt.go b/readline/prompt.go index 0f6ca5a..d141cd6 100644 --- a/readline/prompt.go +++ b/readline/prompt.go @@ -48,7 +48,7 @@ func (rl *Instance) RefreshPromptLog(log string) (err error) { rl.stillOnRefresh = true moveCursorUp(rl.infoY + rl.tcUsedY) moveCursorBackwards(GetTermWidth()) - print("\r\n" + seqClearScreenBelow) + //print("\r\n" + seqClearScreenBelow) // Print the log fmt.Printf(log) @@ -97,7 +97,7 @@ func (rl *Instance) RefreshPromptInPlace(prompt string) (err error) { print(seqClearLine) moveCursorUp(rl.infoY + rl.tcUsedY) moveCursorBackwards(GetTermWidth()) - print("\r\n" + seqClearScreenBelow) + //print("\r\n" + seqClearScreenBelow) // Add a new line if needed if rl.Multiline { @@ -137,7 +137,7 @@ func (rl *Instance) RefreshPromptCustom(prompt string, offset int, clearLine boo moveCursorUp(offset) // Then clear everything below our new position - print(seqClearScreenBelow) + //print(seqClearScreenBelow) // Update the prompt if a special has been passed. if prompt != "" { diff --git a/readline/readline.go b/readline/readline.go index f1d6c96..627bff4 100644 --- a/readline/readline.go +++ b/readline/readline.go @@ -868,7 +868,7 @@ func (rl *Instance) escapeSeq(r []rune) { if err != nil { return } - if !rl.mainHist { + if !rl.mainHist && rl.altHistory != nil { line, err = rl.altHistory.GetLine(rl.altHistory.Len() - 1) if err != nil { return diff --git a/readline/tab.go b/readline/tab.go index d00decc..f2cc140 100644 --- a/readline/tab.go +++ b/readline/tab.go @@ -276,13 +276,14 @@ func (rl *Instance) writeTabCompletion() { // than what their MaxLength allows them to, cycling sometimes occur, // but does not fully clears itself: some descriptions are messed up with. // We always clear the screen as a result, between writings. - print(seqClearScreenBelow) + //rl.bufprint(seqClearScreenBelow) // Crop the completions so that it fits within our MaxTabCompleterRows completions, rl.tcUsedY = rl.cropCompletions(completions) // Then we print all of them. - fmt.Printf(completions) + rl.bufprintF(completions) + rl.bufflush() } // cropCompletions - When the user cycles through a completion list longer diff --git a/readline/update.go b/readline/update.go index 8f85c6d..66b3ba0 100644 --- a/readline/update.go +++ b/readline/update.go @@ -1,6 +1,7 @@ package readline import ( + "fmt" "strings" "golang.org/x/text/width" @@ -10,7 +11,7 @@ import ( // it should coordinate reprinting the input line, any Infos and completions // and manage to get back to the current (computed) cursor coordinates func (rl *Instance) updateHelpers() { - + print(seqHideCursor) // Load all Infos & completions before anything. // Thus overwrites anything having been dirtily added/forced/modified, like rl.SetInfoText() rl.getInfoText() @@ -27,6 +28,7 @@ func (rl *Instance) updateHelpers() { // We are at the prompt line (with the latter // not printed yet), then reprint everything rl.renderHelpers() + print(seqUnhideCursor) } const tabWidth = 4 @@ -119,7 +121,7 @@ func (rl *Instance) clearHelpers() { moveCursorForwards(rl.fullX) // Clear everything below - print(seqClearScreenBelow) + //print(seqClearScreenBelow) // Go back to current cursor position moveCursorBackwards(GetTermWidth()) @@ -194,3 +196,15 @@ func (rl *Instance) renderHelpers() { moveCursorUp(rl.fullY - rl.posY) moveCursorForwards(rl.posX) } + +func (rl *Instance) bufprintF(format string, a ...any) { + fmt.Fprintf(rl.bufferedOut, format, a...) +} + +func (rl *Instance) bufprint(text string) { + fmt.Fprint(rl.bufferedOut, text) +} + +func (rl *Instance) bufflush() { + rl.bufferedOut.Flush() +} diff --git a/rl.go b/rl.go index 17ea4df..7d5ed89 100644 --- a/rl.go +++ b/rl.go @@ -267,7 +267,7 @@ func (lr *lineReader) Loader(rtm *rt.Runtime) *rt.Table { // #interface history // add(cmd) // Adds a command to the history. -// --- @param cmd string +// #param cmd string func (lr *lineReader) luaAddHistory(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -284,15 +284,15 @@ func (lr *lineReader) luaAddHistory(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) // #interface history // size() -> number // Returns the amount of commands in the history. -// --- @returns number +// #eturns number func (lr *lineReader) luaSize(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { return c.PushingNext1(t.Runtime, rt.IntValue(int64(lr.fileHist.Len()))), nil } // #interface history -// get(idx) -// Retrieves a command from the history based on the `idx`. -// --- @param idx number +// get(index) +// Retrieves a command from the history based on the `index`. +// #param index number func (lr *lineReader) luaGetHistory(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -309,8 +309,8 @@ func (lr *lineReader) luaGetHistory(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) // #interface history // all() -> table -// Retrieves all history. -// --- @returns table +// Retrieves all history as a table. +// #returns table func (lr *lineReader) luaAllHistory(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { tbl := rt.NewTable() size := lr.fileHist.Len() diff --git a/runnermode.go b/runnermode.go index 8e9e7b9..55adfdc 100644 --- a/runnermode.go +++ b/runnermode.go @@ -8,11 +8,47 @@ import ( // #interface runner // interactive command runner customization -// The runner interface contains functions that allow the user to change -// how Hilbish interprets interactive input. -// Users can add and change the default runner for interactive input to any -// language or script of their choosing. A good example is using it to -// write command in Fennel. +/* The runner interface contains functions that allow the user to change +how Hilbish interprets interactive input. +Users can add and change the default runner for interactive input to any +language or script of their choosing. A good example is using it to +write command in Fennel. + +Runners are functions that evaluate user input. The default runners in +Hilbish can run shell script and Lua code. + +A runner is passed the input and has to return a table with these values. +All are not required, only the useful ones the runner needs to return. +(So if there isn't an error, just omit `err`.) + +- `exitCode` (number): A numerical code to indicate the exit result. +- `input` (string): The user input. This will be used to add +to the history. +- `err` (string): A string to indicate an interal error for the runner. +It can be set to a few special values for Hilbish to throw the right hooks and have a better looking message: + +`[command]: not-found` will throw a command.not-found hook based on what `[command]` is. + +`[command]: not-executable` will throw a command.not-executable hook. +- `continue` (boolean): Whether to prompt the user for more input. + +Here is a simple example of a fennel runner. It falls back to +shell script if fennel eval has an error. +```lua +local fennel = require 'fennel' + +hilbish.runnerMode(function(input) + local ok = pcall(fennel.eval, input) + if ok then + return { + input = input + } + end + + return hilbish.runner.sh(input) +end) +``` +*/ func runnerModeLoader(rtm *rt.Runtime) *rt.Table { exports := map[string]util.LuaExport{ "sh": {shRunner, 1, false}, @@ -28,18 +64,18 @@ func runnerModeLoader(rtm *rt.Runtime) *rt.Table { // #interface runner // setMode(cb) -// This is the same as the `hilbish.runnerMode` function. It takes a callback, -// which will be used to execute all interactive input. +// This is the same as the `hilbish.runnerMode` function. +// It takes a callback, which will be used to execute all interactive input. // In normal cases, neither callbacks should be overrided by the user, // as the higher level functions listed below this will handle it. -// --- @param cb function +// #param cb function func _runnerMode() {} // #interface runner // sh(cmd) // Runs a command in Hilbish's shell script interpreter. // This is the equivalent of using `source`. -// --- @param cmd string +// #param cmd string func shRunner(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -67,7 +103,7 @@ func shRunner(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // lua(cmd) // Evaluates `cmd` as Lua input. This is the same as using `dofile` // or `load`, but is appropriated for the runner interface. -// --- @param cmd string +// #param cmd string func luaRunner(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err diff --git a/sink.go b/sink.go index 2ecc19d..3aa5507 100644 --- a/sink.go +++ b/sink.go @@ -5,6 +5,7 @@ import ( "fmt" "io" "os" + "strings" "hilbish/util" @@ -31,6 +32,7 @@ func setupSinkType(rtm *rt.Runtime) { sinkFuncs := map[string]util.LuaExport{ "flush": {luaSinkFlush, 1, false}, "read": {luaSinkRead, 1, false}, + "readAll": {luaSinkReadAll, 1, false}, "autoFlush": {luaSinkAutoFlush, 2, false}, "write": {luaSinkWrite, 2, false}, "writeln": {luaSinkWriteln, 2, false}, @@ -65,10 +67,42 @@ func setupSinkType(rtm *rt.Runtime) { l.SetRegistry(sinkMetaKey, rt.TableValue(sinkMeta)) } + +// #member +// readAll() -> string +// --- @returns string +// Reads all input from the sink. +func luaSinkReadAll(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { + if err := c.Check1Arg(); err != nil { + return nil, err + } + + s, err := sinkArg(c, 0) + if err != nil { + return nil, err + } + + lines := []string{} + for { + line, err := s.reader.ReadString('\n') + if err != nil { + if err == io.EOF { + break + } + + return nil, err + } + + lines = append(lines, line) + } + + return c.PushingNext1(t.Runtime, rt.StringValue(strings.Join(lines, ""))), nil +} + // #member // read() -> string // --- @returns string -// Reads input from the sink. +// Reads a liine of input from the sink. func luaSinkRead(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err diff --git a/testplugin/testplugin.go b/testplugin/testplugin.go new file mode 100644 index 0000000..2d8a41b --- /dev/null +++ b/testplugin/testplugin.go @@ -0,0 +1,9 @@ +package main + +import ( + rt "github.com/arnodel/golua/runtime" +) + +func Loader(rtm *rt.Runtime) rt.Value { + return rt.StringValue("hello world!") +} diff --git a/testplugin/testplugin.so b/testplugin/testplugin.so new file mode 100644 index 0000000..3c83992 Binary files /dev/null and b/testplugin/testplugin.so differ diff --git a/timerhandler.go b/timerhandler.go index 0cb4197..0a8e34f 100644 --- a/timerhandler.go +++ b/timerhandler.go @@ -63,11 +63,10 @@ func (th *timersModule) get(id int) *timer { // #interface timers // create(type, time, callback) -> @Timer -// Creates a timer that runs based on the specified `time` in milliseconds. -// The `type` can either be `hilbish.timers.INTERVAL` or `hilbish.timers.TIMEOUT` -// --- @param type number -// --- @param time number -// --- @param callback function +// Creates a timer that runs based on the specified `time`. +// #param type number What kind of timer to create, can either be `hilbish.timers.INTERVAL` or `hilbish.timers.TIMEOUT` +// #param time number The amount of time the function should run in milliseconds. +// #param callback function The function to run for the timer. func (th *timersModule) luaCreate(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.CheckNArgs(3); err != nil { return nil, err @@ -93,8 +92,8 @@ func (th *timersModule) luaCreate(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // #interface timers // get(id) -> @Timer // Retrieves a timer via its ID. -// --- @param id number -// --- @returns Timer +// #param id number +// #returns Timer func (th *timersModule) luaGet(thr *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -122,15 +121,10 @@ a few seconds, you don't have to rely on timing tricks, as Hilbish has a timer API to set intervals and timeouts. These are the simple functions `hilbish.interval` and `hilbish.timeout` (doc -accessible with `doc hilbish`). But if you want slightly more control over -them, there is the `hilbish.timers` interface. It allows you to get -a timer via ID and control them. - -## Timer Object -All functions documented with the `Timer` type refer to a Timer object. +accessible with `doc hilbish`, or `Module hilbish` on the Website). An example of usage: -``` +```lua local t = hilbish.timers.create(hilbish.timers.TIMEOUT, 5000, function() print 'hello!' end) diff --git a/vars.go b/vars.go index 583db71..9093a88 100644 --- a/vars.go +++ b/vars.go @@ -11,7 +11,7 @@ var ( // Version info var ( - ver = "v2.2.0" + ver = "v2.2.1" releaseName = "Poppy" gitCommit string diff --git a/website/config.toml b/website/config.toml index 31f42d5..42f3d30 100644 --- a/website/config.toml +++ b/website/config.toml @@ -1,5 +1,5 @@ -baseURL = 'https://rosettea.github.io/Hilbish/' languageCode = 'en-us' +baseURL = 'https://rosettea.github.io/Hilbish/' title = 'Hilbish' theme = 'hsh' enableGitInfo = true @@ -29,6 +29,14 @@ enableGitInfo = true [markup.goldmark.renderer] unsafe = true +[markup.highlight] +lineNos = true +lineNumbersInTable = false +noClasses = false +codeFences = true +guessSyntax = true +tabWidth = 4 + [author] [author.sammyette] name = 'sammyette' diff --git a/website/content/_index.md b/website/content/_index.md index 4421798..51b0851 100644 --- a/website/content/_index.md +++ b/website/content/_index.md @@ -19,109 +19,50 @@ description: 'Something Unique. Hilbish is the new interactive shell for Lua fan
-
-
-
- - - -
-
-
Simple and Easy Scripting
-
-

- Hilbish is configured and scripted in the Lua programming language. - This removes all the old, ugly things about Shell script and introduces - everything good about Lua, including other languages (Moonscript & Fennel). -

-
-
+
+
+
Simple and Easy Scripting
+

Hilbish is configured and scripted in the + Lua programming language. This removes all the old, ugly things + about Shell script and introduces everything good about Lua, + including other languages (Fennel, Lua derivatives).

-
-
-
- - - -
-
-
History and Completion Menus
-
-

- Hilbish provides the user with proper menus for completions, - history searching. Want to see your previous commands? Hit Ctrl-R. -

-
-
+
+
+
History and Completion Menus
+

Hilbish provides the user with proper menus + for completions and history usage. Want to see your previous commands? + Hit Ctrl-R.

-
-
-
- - - -
-
-
Tons of Features, and More to Come
-
-

- Hilbish offers a bunch of features to make your interactive - shell experience rich. Things like syntax highlighting and hinting - available via the Lua API. -

-

* Command hints shown in photo are not default.

-
-
+
+
+
Tons of Features, and More to Come
+

Hilbish offers a bunch of features to make your + interactive shell experience rich. Things like syntax highlighting + and hinting available via the Lua API.

- -
-

Screenshots

-
-
- -
-
- -
-
- -
-
-
-

Why not just Lua?

Hilbish is your interactive shell as well as a just a Lua interpreter diff --git a/website/content/blog/v2.2-release.md b/website/content/blog/v2.2-release.md new file mode 100644 index 0000000..25f52df --- /dev/null +++ b/website/content/blog/v2.2-release.md @@ -0,0 +1,81 @@ +--- +title: "v2.2 Release" +date: 2023-12-25T23:56:36-04:00 +draft: false +--- + +> The release with full changelogs and prebuilt binaries can be +seen at the [v2.2.0](https://github.com/Rosettea/Hilbish/releases/tag/v2.2.0) +tag. + +Welcome to a very long awaited release of Hilbish, and on Christmas. Just think +of it as a long preparing, late Christmas gift. :) +This release does not contain a whole lot of changes, but it is a new +release with enhancements and bug fixes! + +# Documentation +As is a trend, the documentation has been improved by ONE HUNDRED TIMES. +Okay, not quite, but they've definitely been given an uplift. +Everything has been rewritten, new documentation has been added to both +the website and the local docs accessible with the `doc` command. +Both the website and local docs are now in sync with each other. + +This means that the `doc` command has also been improved to consolidate +the documentation changes. It looks a lot better, has pagination, etc! + +Speaking of pagination... +# Features +## Greenhouse +The first new added feature is the Greenhouse pager! It is a library and +command accessible via `greenhouse`. It will have better integration with +Hilbish things, like notifications and can be used as a base for displaying +multi-line text output instead of paging to less. The usage of Greenhouse is +more efficient and better in Hibish! + +## Notifications +Wait... notifications? Yes! All new in the 2.2 release is a generic notification +interface for things in Hilbish to alert the user of things going on. Stuff like +background jobs finishing, simple alarms, *actual messages*, whatever you like. + +## Fuzzy Searching +Users can now use fuzzy search for command history and completion search. +Enable it with `hilbish.opts.fuzzy = true`! + +### Smaller Enhancements +Did you know of the `cdr` command? I personally don't use it, but I've made +it look slightly better for ease of use. That simple change is adding the indexes +next to the directory so you'll know to type `cdr 2`. + +Users can now add aliases with numbered substitutions. In shell script, +some people have to make functions for certain things that are actually +just aliases. A simple example: `nix run nixpkgs#package` cannot be aliased +because if it was aliased to something like `run` normally there would be a space after. + +Simple fix: +```lua +hilbish.alias('run', 'nix run nixpkgs#%1') +``` + +Rejoice! + +# Bug Fixes +There are a small amount of bug fixes but they're still fixes! + +In some cases Hilbish will panic if: +- Alias resolution results in something empty +- A user does not return a table in a runner functions +These are both fixed. + +An infinite loop has been patched out if someone navigates without +having any prior history. Imagine pressing the up key on a fresh Hilbish +install and you shell no longer working... that's gone now. + +Something else that's gone... is still Windows support, but I added a fix +which will make file completion work now. Job management commands work as +well now too due to an oversight when changing up the job functions. + +# Towards v2.3 +For the next release, I'm hoping that it won't take as long to deliver on +what is realistically a small amount of changes. So v2.3 will be coming +in a short time with some good changes, promise! See you in the +next blog post. diff --git a/website/content/docs b/website/content/docs new file mode 120000 index 0000000..92a7f82 --- /dev/null +++ b/website/content/docs @@ -0,0 +1 @@ +../../docs \ No newline at end of file diff --git a/website/content/docs/api b/website/content/docs/api deleted file mode 120000 index 1c5c360..0000000 --- a/website/content/docs/api +++ /dev/null @@ -1 +0,0 @@ -../../../docs/api/ \ No newline at end of file diff --git a/website/content/docs/features/runner-mode.md b/website/content/docs/features/runner-mode.md deleted file mode 100644 index 8774de9..0000000 --- a/website/content/docs/features/runner-mode.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Runner Mode -description: Customize the interactive script/command runner. -layout: doc -menu: - docs: - parent: "Features" ---- - -Hilbish allows you to change how interactive text can be interpreted. -This is mainly due to the fact that the default method Hilbish uses -is that it runs Lua first and then falls back to shell script. - -In some cases, someone might want to switch to just shell script to avoid -it while interactive but still have a Lua config, or go full Lua to use -Hilbish as a REPL. This also allows users to add alternative languages, -instead of either like Fennel. - -Runner mode can also be used to handle specific kinds of input before -evaluating like normal, which is how [Link.hsh](https://github.com/TorchedSammy/Link.hsh) -handles links. diff --git a/website/static/completion.mp4 b/website/static/completion.mp4 new file mode 100644 index 0000000..057f9ab Binary files /dev/null and b/website/static/completion.mp4 differ diff --git a/website/themes/hsh/assets/css/syntax.css b/website/themes/hsh/assets/css/syntax.css new file mode 100644 index 0000000..c4885c0 --- /dev/null +++ b/website/themes/hsh/assets/css/syntax.css @@ -0,0 +1,89 @@ +.chroma { + display: inline-block; + padding: 0.5em; +} +/* Background */ .bg { background-color: #F7F7F7; } +/* PreWrapper */ .chroma { background-color: #F7F7F7; } +/* Other */ .chroma .x { } +/* Error */ .chroma .err { color: #a61717; background-color: #e3d2d2 } +/* CodeLine */ .chroma .cl { } +/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; } +/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; } +/* LineHighlight */ .chroma .hl { background-color: #F7F7F7 } +/* LineNumbersTable */ .chroma .lnt { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f } +/* LineNumbers */ .chroma .ln { white-space: pre; user-select: none; margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f } +/* Line */ .chroma .line { display: flex; } +/* Keyword */ .chroma .k { color: #008800; font-weight: bold } +/* KeywordConstant */ .chroma .kc { color: #008800; font-weight: bold } +/* KeywordDeclaration */ .chroma .kd { color: #008800; font-weight: bold } +/* KeywordNamespace */ .chroma .kn { color: #008800; font-weight: bold } +/* KeywordPseudo */ .chroma .kp { color: #008800 } +/* KeywordReserved */ .chroma .kr { color: #008800; font-weight: bold } +/* KeywordType */ .chroma .kt { color: #888888; font-weight: bold } +/* Name */ .chroma .n { } +/* NameAttribute */ .chroma .na { color: #336699 } +/* NameBuiltin */ .chroma .nb { color: #003388 } +/* NameBuiltinPseudo */ .chroma .bp { } +/* NameClass */ .chroma .nc { color: #bb0066; font-weight: bold } +/* NameConstant */ .chroma .no { color: #003366; font-weight: bold } +/* NameDecorator */ .chroma .nd { color: #555555 } +/* NameEntity */ .chroma .ni { } +/* NameException */ .chroma .ne { color: #bb0066; font-weight: bold } +/* NameFunction */ .chroma .nf { color: #0066bb; font-weight: bold } +/* NameFunctionMagic */ .chroma .fm { } +/* NameLabel */ .chroma .nl { color: #336699; font-style: italic } +/* NameNamespace */ .chroma .nn { color: #bb0066; font-weight: bold } +/* NameOther */ .chroma .nx { } +/* NameProperty */ .chroma .py { color: #336699; font-weight: bold } +/* NameTag */ .chroma .nt { color: #bb0066; font-weight: bold } +/* NameVariable */ .chroma .nv { color: #336699 } +/* NameVariableClass */ .chroma .vc { color: #336699 } +/* NameVariableGlobal */ .chroma .vg { color: #dd7700 } +/* NameVariableInstance */ .chroma .vi { color: #3333bb } +/* NameVariableMagic */ .chroma .vm { } +/* Literal */ .chroma .l { } +/* LiteralDate */ .chroma .ld { } +/* LiteralString */ .chroma .s { color: #dd2200; background-color: #fff0f0 } +/* LiteralStringAffix */ .chroma .sa { color: #dd2200; background-color: #fff0f0 } +/* LiteralStringBacktick */ .chroma .sb { color: #dd2200; background-color: #fff0f0 } +/* LiteralStringChar */ .chroma .sc { color: #dd2200; background-color: #fff0f0 } +/* LiteralStringDelimiter */ .chroma .dl { color: #dd2200; background-color: #fff0f0 } +/* LiteralStringDoc */ .chroma .sd { color: #dd2200; background-color: #fff0f0 } +/* LiteralStringDouble */ .chroma .s2 { color: #dd2200; background-color: #fff0f0 } +/* LiteralStringEscape */ .chroma .se { color: #0044dd; background-color: #fff0f0 } +/* LiteralStringHeredoc */ .chroma .sh { color: #dd2200; background-color: #fff0f0 } +/* LiteralStringInterpol */ .chroma .si { color: #3333bb; background-color: #fff0f0 } +/* LiteralStringOther */ .chroma .sx { color: #22bb22; background-color: #f0fff0 } +/* LiteralStringRegex */ .chroma .sr { color: #008800; background-color: #fff0ff } +/* LiteralStringSingle */ .chroma .s1 { color: #dd2200; background-color: #fff0f0 } +/* LiteralStringSymbol */ .chroma .ss { color: #aa6600; background-color: #fff0f0 } +/* LiteralNumber */ .chroma .m { color: #0000dd; font-weight: bold } +/* LiteralNumberBin */ .chroma .mb { color: #0000dd; font-weight: bold } +/* LiteralNumberFloat */ .chroma .mf { color: #0000dd; font-weight: bold } +/* LiteralNumberHex */ .chroma .mh { color: #0000dd; font-weight: bold } +/* LiteralNumberInteger */ .chroma .mi { color: #0000dd; font-weight: bold } +/* LiteralNumberIntegerLong */ .chroma .il { color: #0000dd; font-weight: bold } +/* LiteralNumberOct */ .chroma .mo { color: #0000dd; font-weight: bold } +/* Operator */ .chroma .o { } +/* OperatorWord */ .chroma .ow { color: #008800 } +/* Punctuation */ .chroma .p { } +/* Comment */ .chroma .c { color: #888888 } +/* CommentHashbang */ .chroma .ch { color: #888888 } +/* CommentMultiline */ .chroma .cm { color: #888888 } +/* CommentSingle */ .chroma .c1 { color: #888888 } +/* CommentSpecial */ .chroma .cs { color: #cc0000; background-color: #fff0f0; font-weight: bold } +/* CommentPreproc */ .chroma .cp { color: #cc0000; font-weight: bold } +/* CommentPreprocFile */ .chroma .cpf { color: #cc0000; font-weight: bold } +/* Generic */ .chroma .g { } +/* GenericDeleted */ .chroma .gd { color: #000000; background-color: #ffdddd } +/* GenericEmph */ .chroma .ge { font-style: italic } +/* GenericError */ .chroma .gr { color: #aa0000 } +/* GenericHeading */ .chroma .gh { color: #333333 } +/* GenericInserted */ .chroma .gi { color: #000000; background-color: #ddffdd } +/* GenericOutput */ .chroma .go { color: #888888 } +/* GenericPrompt */ .chroma .gp { color: #555555 } +/* GenericStrong */ .chroma .gs { font-weight: bold } +/* GenericSubheading */ .chroma .gu { color: #666666 } +/* GenericTraceback */ .chroma .gt { color: #aa0000 } +/* GenericUnderline */ .chroma .gl { text-decoration: underline } +/* TextWhitespace */ .chroma .w { color: #bbbbbb } diff --git a/website/themes/hsh/layouts/partials/head.html b/website/themes/hsh/layouts/partials/head.html index fca4558..147fb11 100644 --- a/website/themes/hsh/layouts/partials/head.html +++ b/website/themes/hsh/layouts/partials/head.html @@ -23,7 +23,10 @@ + {{ $syntax := resources.Get "css/syntax.css" | resources.Minify | resources.Fingerprint }} + + diff --git a/website/themes/hsh/layouts/shortcodes/video.html b/website/themes/hsh/layouts/shortcodes/video.html new file mode 100644 index 0000000..d0f1314 --- /dev/null +++ b/website/themes/hsh/layouts/shortcodes/video.html @@ -0,0 +1,5 @@ + +