mirror of
https://github.com/Hilbis/Hilbish
synced 2025-04-03 20:23:23 +00:00
sammyette
4150001d8b
* fix: make lua implemented hilbish interfaces documented * fix: signature link in table of contents * fix: reduce function list to match in go generated docs * fix: toc appending * docs: enable docs for hilbish.messages * feat: add description gen, and more spacing between param listing * docs: add more detailed documentation for lua modules * docs: update hilbish.messages docs * fix: add description for lua doc'd modules, remove duplicate docs * docs: add back hilbish.jobs doc * feat: generate toc for lua modules * fix: add table heading * ci: add lua docgen * docs: put dirs.old doc on 1 line
116 lines
2.6 KiB
Lua
116 lines
2.6 KiB
Lua
-- @module hilbish.runner
|
|
local currentRunner = 'hybrid'
|
|
local runners = {}
|
|
|
|
-- lsp shut up
|
|
hilbish = hilbish
|
|
|
|
--- Get a runner by name.
|
|
--- @param name string Name of the runner to retrieve.
|
|
--- @return table
|
|
function hilbish.runner.get(name)
|
|
local r = runners[name]
|
|
|
|
if not r then
|
|
error(string.format('runner %s does not exist', name))
|
|
end
|
|
|
|
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 Name of the runner
|
|
--- @param runner function|table
|
|
function hilbish.runner.add(name, runner)
|
|
if type(name) ~= 'string' then
|
|
error 'expected runner name to be a table'
|
|
end
|
|
|
|
if type(runner) == 'function' then
|
|
runner = {run = runner} -- this probably looks confusing
|
|
end
|
|
|
|
if type(runner) ~= 'table' then
|
|
error 'expected runner to be a table or function'
|
|
end
|
|
|
|
if runners[name] then
|
|
error(string.format('runner %s already exists', name))
|
|
end
|
|
|
|
hilbish.runner.set(name, runner)
|
|
end
|
|
|
|
--- *Sets* a runner by name. The difference between this function and
|
|
--- add, is set will *not* check if the named runner exists.
|
|
--- The runner table must have the run function in it.
|
|
--- @param name string
|
|
--- @param runner table
|
|
function hilbish.runner.set(name, runner)
|
|
if not runner.run or type(runner.run) ~= 'function' then
|
|
error 'run function in runner missing'
|
|
end
|
|
|
|
runners[name] = runner
|
|
end
|
|
|
|
--- Executes `cmd` with a runner.
|
|
--- If `runnerName` is not specified, it uses the default Hilbish runner.
|
|
--- @param cmd string
|
|
--- @param runnerName string?
|
|
--- @return table
|
|
function hilbish.runner.exec(cmd, runnerName)
|
|
if not runnerName then runnerName = currentRunner end
|
|
|
|
local r = hilbish.runner.get(runnerName)
|
|
|
|
return r.run(cmd)
|
|
end
|
|
|
|
--- Sets Hilbish's runner mode by name.
|
|
--- @param name string
|
|
function hilbish.runner.setCurrent(name)
|
|
local r = hilbish.runner.get(name)
|
|
currentRunner = name
|
|
|
|
hilbish.runner.setMode(r.run)
|
|
end
|
|
|
|
--- Returns the current runner by name.
|
|
--- @returns string
|
|
function hilbish.runner.getCurrent()
|
|
return currentRunner
|
|
end
|
|
|
|
hilbish.runner.add('hybrid', function(input)
|
|
local cmdStr = hilbish.aliases.resolve(input)
|
|
|
|
local res = hilbish.runner.lua(cmdStr)
|
|
if not res.err then
|
|
return res
|
|
end
|
|
|
|
return hilbish.runner.sh(input)
|
|
end)
|
|
|
|
hilbish.runner.add('hybridRev', function(input)
|
|
local res = hilbish.runner.sh(input)
|
|
if not res.err then
|
|
return res
|
|
end
|
|
|
|
local cmdStr = hilbish.aliases.resolve(input)
|
|
return hilbish.runner.lua(cmdStr)
|
|
end)
|
|
|
|
hilbish.runner.add('lua', function(input)
|
|
local cmdStr = hilbish.aliases.resolve(input)
|
|
return hilbish.runner.lua(cmdStr)
|
|
end)
|
|
|
|
hilbish.runner.add('sh', function(input)
|
|
return hilbish.runner.sh(input)
|
|
end)
|
|
|