Better help

This commit is contained in:
yago 2015-04-05 13:57:25 +02:00
parent c1d2885e9c
commit 6ebf354735

View File

@ -37,38 +37,68 @@ function has_usage_data(dict)
return true
end
function plugin_help(name)
local plugin = plugins[name]
if not plugin then return nil end
local text = ""
if (type(plugin.usage) == "table") then
for ku,usage in pairs(plugin.usage) do
text = text..usage..'\n'
end
text = text..'\n'
elseif has_usage_data(plugin) then -- Is not empty
text = text..plugin.usage..'\n\n'
end
return text
end
-- !help command
function telegram_help()
local text = "Plugin list: \n\n"
-- Plugins names
for name in pairs(plugins) do
text = text..name..'\n'
end
text = text..'\n'..'Write "!help [plugin name]" for more info.'
text = text..'\n'..'Or "!help all" to show all info.'
return text
end
-- !help all command
function help_all()
local ret = ""
for k, dict in pairs(plugins) do
if (type(dict.usage) == "table") then
for ku,usage in pairs(dict.usage) do
ret = ret..usage..'\n'
end
ret = ret..'\n'
elseif has_usage_data(dict) then -- Is not empty
ret = ret..dict.usage..'\n\n'
end
for name in pairs(plugins) do
ret = ret .. plugin_help(name)
end
return ret
end
function run(msg, matches)
if matches[1] == "!help md" then
return html_help()
else
if matches[1] == "!help" then
return telegram_help()
elseif matches[1] == "!help all" then
return help_all()
else
local text = plugin_help(matches[1])
if not text then
text = telegram_help()
end
return text
end
end
return {
description = "Help plugin. Get info from other plugins. ",
usage = {
"!help: Show all the help",
"!help md: Generate a GitHub Markdown table"
"!help: Show list of plugins.",
"!help all: Show all commands for every plugin.",
"!help [plugin name]: Commands for that plugin."
},
patterns = {
"^!help$",
"^!help md$"
"^!help all",
"^!help (.+)"
},
run = run
}