diff --git a/docs/api/hilbish/hilbish.runner/index.html b/docs/api/hilbish/hilbish.runner/index.html index 620835e..759d94f 100644 --- a/docs/api/hilbish/hilbish.runner/index.html +++ b/docs/api/hilbish/hilbish.runner/index.html @@ -9,9 +9,12 @@ 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
+(So if there isn’t an error, just omit err
.)
exitCode
(number): Exit code of the commandinput
(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.\<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 Hilbish should prompt the user for no inputnewline
(boolean): Whether a newline should be added at the end of input
.Here is a simple example of a fennel runner. It falls back to shell script if fennel eval has an error.
1local fennel = require 'fennel'
2
3hilbish.runnerMode(function(input)