sammyette
/
Hilbish
mirror of https://github.com/Hilbis/Hilbish
2
2
Fork 0
Code Issues Releases Wiki Activity

docs: [ci] generate new docs

pull/325/head
TorchedSammy 2024-08-16 19:26:30 +00:00 committed by github-actions[bot]
parent a7ba2fdf1a
commit 824f5bd06d
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/api/hilbish/hilbish.runner.md
View File

@ -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.