mirror of https://github.com/Hilbis/Hilbish
docs: add emmylua doc for functions
parent
180b77f166
commit
1c4f4b52f3
|
@ -2,6 +2,9 @@ local currentRunner = 'hybrid'
|
|||
local runnerHandler = {}
|
||||
local runners = {}
|
||||
|
||||
--- Get a runner by name.
|
||||
--- @param name string
|
||||
--- @return table
|
||||
function runnerHandler.get(name)
|
||||
local r = runners[name]
|
||||
|
||||
|
@ -12,6 +15,10 @@ function runnerHandler.get(name)
|
|||
return r
|
||||
end
|
||||
|
||||
--- Adds a runner to the table of available runners. If runner is a table,
|
||||
--- it must have the run function in it.
|
||||
--- @param name string
|
||||
--- @param runner function | table
|
||||
function runnerHandler.add(name, runner)
|
||||
if type(name) ~= 'string' then
|
||||
error 'expected runner name to be a table'
|
||||
|
@ -32,6 +39,9 @@ function runnerHandler.add(name, runner)
|
|||
runnerHandler.set(name, runner)
|
||||
end
|
||||
|
||||
--- Sets a runner by name. The runner table must have the run function in it.
|
||||
--- @param name string
|
||||
--- @param runner table
|
||||
function runnerHandler.set(name, runner)
|
||||
if not runner.run or type(runner.run) ~= 'function' then
|
||||
error 'run function in runner missing'
|
||||
|
@ -40,6 +50,11 @@ function runnerHandler.set(name, runner)
|
|||
runners[name] = runner
|
||||
end
|
||||
|
||||
--- Executes cmd with a runner. If runnerName isn't passed, it uses
|
||||
--- the user's current runner.
|
||||
--- @param cmd string
|
||||
--- @param runnerName string?
|
||||
--- @return string, number, string
|
||||
function runnerHandler.exec(cmd, runnerName)
|
||||
if not runnerName then runnerName = currentRunner end
|
||||
|
||||
|
@ -50,6 +65,8 @@ end
|
|||
|
||||
-- lsp shut up
|
||||
hilbish = hilbish
|
||||
--- Sets the current interactive/command line runner mode.
|
||||
--- @param name string
|
||||
function runnerHandler.setCurrent(name)
|
||||
local r = runnerHandler.get(name)
|
||||
currentRunner = name
|
||||
|
|
Loading…
Reference in New Issue