2
2
spogulis no https://github.com/Hilbis/Hilbish synced 2025-07-10 21:12:02 +00:00
Hilbish/emmyLuaDocs/hilbish.lua
TorchedSammy 1b24e91597
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 15:08:03 -04:00

85 rindas
1.4 KiB
Lua

--- @meta
local hilbish = {}
---
--- @param cmd string
--- @param orig string
function hilbish.alias(cmd, orig) end
---
--- @param dir string|table
function hilbish.appendPath(dir) end
---
--- @param scope string
--- @param cb function
function hilbish.complete(scope, cb) end
---
function hilbish.cwd() end
---
--- @param cmd string
function hilbish.exec(cmd) end
---
--- @param fn function
function hilbish.goro(fn) end
---
--- @param line string
function hilbish.highlighter(line) end
---
--- @param line string
--- @param pos int
function hilbish.hinter(line, pos) end
---
--- @param mode string
function hilbish.inputMode(mode) end
---
--- @param cb function
--- @param time number
--- @return table
function hilbish.interval(cb, time) end
---
--- @param str string
function hilbish.multiprompt(str) end
---
--- @param dir string
function hilbish.prependPath(dir) end
---
--- @param str string
--- @param typ string Type of prompt, being left or right. Left by default.
function hilbish.prompt(str, typ) end
---
--- @param prompt string
function hilbish.read(prompt) end
---
--- @param cmd string
function hilbish.run(cmd) end
---
--- @param mode string|function
function hilbish.runnerMode(mode) end
---
--- @param cb function
--- @param time number
--- @return table
function hilbish.timeout(cb, time) end
---
--- @param binName string
function hilbish.which(binName) end
return hilbish