mirror of https://github.com/Hilbis/Hilbish
docs: [ci] generate new docs
parent
a7ba2fdf1a
commit
824f5bd06d
|
@ -21,16 +21,18 @@ 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.
|
All are not required, only the useful ones the runner needs to return.
|
||||||
(So if there isn't an error, just omit `err`.)
|
(So if there isn't an error, just omit `err`.)
|
||||||
|
|
||||||
- `exitCode` (number): A numerical code to indicate the exit result.
|
- `exitCode` (number): Exit code of the command
|
||||||
- `input` (string): The user input. This will be used to add
|
- `input` (string): The text input of the user. This is used by Hilbish to append extra input, in case
|
||||||
to the history.
|
more is requested.
|
||||||
- `err` (string): A string to indicate an interal error for the runner.
|
- `err` (string): A string that represents an error from the runner.
|
||||||
It can be set to a few special values for Hilbish to throw the right hooks and have a better looking message:
|
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
|
||||||
`[command]: not-found` will throw a command.not-found hook based on what `[command]` is.
|
hooks and have a better looking message.
|
||||||
|
- `\<command>: not-found` will throw a `command.not-found` hook
|
||||||
`[command]: not-executable` will throw a command.not-executable hook.
|
based on what `\<command>` is.
|
||||||
- `continue` (boolean): Whether to prompt the user for more input.
|
- `\<command>: not-executable` will throw a `command.not-executable` hook.
|
||||||
|
- `continue` (boolean): Whether Hilbish should prompt the user for no input
|
||||||
|
- `newline` (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
|
Here is a simple example of a fennel runner. It falls back to
|
||||||
shell script if fennel eval has an error.
|
shell script if fennel eval has an error.
|
||||||
|
|
Loading…
Reference in New Issue