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

92 lines
3.0 KiB
Markdown
Raw Normal View History

feat!: enhance docs and doc command changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website (soon). all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-02 19:08:03 +00:00
---
name: Module hilbish
fix: remove empty entries for hilbish module, add descriptions
2022-12-02 21:02:13 +00:00
description: the core Hilbish API
fix: doc generation for hilbish module
2022-12-02 20:57:38 +00:00
layout: apidoc
feat!: enhance docs and doc command changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website (soon). all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-02 19:08:03 +00:00
---
refactor!: move global functions to the hilbish module its more organized this way and the `hilbish` lua module is now what global was before anyway a feature in this commit also is that `goro` now allows passing any amount of args to the calling function
2022-01-26 19:51:52 +00:00
fix: doc generation for hilbish module
2022-12-02 20:57:38 +00:00
## Introduction
fix: remove empty entries for hilbish module, add descriptions
2022-12-02 21:02:13 +00:00
The Hilbish module includes the core API, containing
interfaces and functions which directly relate to shell functionality.
fix: doc generation for hilbish module
2022-12-02 20:57:38 +00:00
## Functions
fix: use slice for doc pieces instead of a map a map doesnt have a fixed order which results in a new order everytime docs are generated. i forgot that important detail..
2022-12-03 15:30:41 +00:00
### alias(cmd, orig)
Sets an alias of `cmd` to `orig`
refactor!: move global functions to the hilbish module its more organized this way and the `hilbish` lua module is now what global was before anyway a feature in this commit also is that `goro` now allows passing any amount of args to the calling function
2022-01-26 19:51:52 +00:00
feat!: enhance docs and doc command changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website (soon). all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-02 19:08:03 +00:00
### appendPath(dir)
Appends `dir` to $PATH
fix: use slice for doc pieces instead of a map a map doesnt have a fixed order which results in a new order everytime docs are generated. i forgot that important detail..
2022-12-03 15:30:41 +00:00
### complete(scope, cb)
Registers a completion handler for `scope`.
A `scope` is currently only expected to be `command.<cmd>`,
replacing <cmd> with the name of the command (for example `command.git`).
`cb` must be a function that returns a table of "completion groups."
Check `doc completions` for more information.
### cwd()
Returns the current directory of the shell
### exec(cmd)
Replaces running hilbish with `cmd`
feat!: enhance docs and doc command changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website (soon). all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-02 19:08:03 +00:00
### goro(fn)
Puts `fn` in a goroutine
refactor!: move global functions to the hilbish module its more organized this way and the `hilbish` lua module is now what global was before anyway a feature in this commit also is that `goro` now allows passing any amount of args to the calling function
2022-01-26 19:51:52 +00:00
fix: use slice for doc pieces instead of a map a map doesnt have a fixed order which results in a new order everytime docs are generated. i forgot that important detail..
2022-12-03 15:30:41 +00:00
### 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.
feat!: enhance docs and doc command changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website (soon). all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-02 19:08:03 +00:00
### hinter(line, pos)
The command line hint handler. It gets called on every key insert to
docs: [ci] generate new docs
2022-04-22 02:22:20 +00:00
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.
docs: [ci] generate new docs
2022-03-26 21:34:42 +00:00
fix: use slice for doc pieces instead of a map a map doesnt have a fixed order which results in a new order everytime docs are generated. i forgot that important detail..
2022-12-03 15:30:41 +00:00
### inputMode(mode)
Sets the input mode for Hilbish's line reader. Accepts either emacs or vim
### interval(cb, time)
Runs the `cb` function every `time` milliseconds.
Returns a `timer` object (see `doc timers`).
### multiprompt(str)
Changes the continued line prompt to `str`
### prependPath(dir)
Prepends `dir` to $PATH
### 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
feat!: enhance docs and doc command changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website (soon). all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-02 19:08:03 +00:00
### read(prompt?) -> input?
Read input from the user, using Hilbish's line editor/input reader.
feat: add hilbish.read function `hilbish.read` will read input from the user, using hilbish's line editor library (hilbiline or readline)
2021-10-30 23:53:42 +00:00
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)
feat!: enhance docs and doc command changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website (soon). all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-02 19:08:03 +00:00
### run(cmd, returnOut) -> exitCode, stdout, stderr
Runs `cmd` in Hilbish's sh interpreter.
docs: [ci] generate new docs
2022-04-04 10:40:25 +00:00
If returnOut is true, the outputs of `cmd` will be returned as the 2nd and
3rd values instead of being outputted to the terminal.
refactor!: move global functions to the hilbish module its more organized this way and the `hilbish` lua module is now what global was before anyway a feature in this commit also is that `goro` now allows passing any amount of args to the calling function
2022-01-26 19:51:52 +00:00
fix: use slice for doc pieces instead of a map a map doesnt have a fixed order which results in a new order everytime docs are generated. i forgot that important detail..
2022-12-03 15:30:41 +00:00
### 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.
docs: [ci] generate new docs
2022-03-20 19:16:13 +00:00
feat!: enhance docs and doc command changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website (soon). all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-02 19:08:03 +00:00
### timeout(cb, time)
Runs the `cb` function after `time` in milliseconds
docs: [ci] generate new docs
2022-04-12 23:37:39 +00:00
Returns a `timer` object (see `doc timers`).
docs: [ci] regenerate new docs
2022-02-25 22:00:39 +00:00
feat!: enhance docs and doc command changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website (soon). all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-02 19:08:03 +00:00
### which(name)
Checks if `name` is a valid command
docs: [ci] generate new docs
2022-03-01 23:00:20 +00:00