mirrors/prosody
1
0
Fork 0
mirror of https://github.com/bjc/prosody.git synced 2025-04-03 05:07:42 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

mod_admin_shell: Support for hiding certain commands from default help listing

Browse source 
Useful for e.g. deprecated commands.
This commit is contained in:
Matthew Wild 2025-02-13 16:16:19 +00:00
parent 4cc122bdc0
commit 009996c9e8
1 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

13
plugins/mod_admin_shell.lua
View file

@ -349,7 +349,7 @@ module:hook("admin/repl-input", function (event)
return true;
end);
local function describe_command(s)
local function describe_command(s, hidden)
local section, name, args, desc = s:match("^([%w_]+):([%w_]+)%(([^)]*)%) %- (.+)$");
if not section then
error("Failed to parse command description: "..s);
@ -360,6 +360,7 @@ local function describe_command(s)
args = array.collect(args:gmatch("[%w_]+")):map(function (arg_name)
return { name = arg_name };
end);
hidden = hidden;
};
end
@ -455,10 +456,12 @@ def_env.help = setmetatable({}, {
end
for command, command_help in it.sorted_pairs(section_help.commands or {}) do
c = c + 1;
local args = array.pluck(command_help.args, "name"):concat(", ");
local desc = command_help.desc or command_help.module and ("Provided by mod_"..command_help.module) or "";
print(("%s:%s(%s) - %s"):format(section_name, command, args, desc));
if not command_help.hidden then
c = c + 1;
local args = array.pluck(command_help.args, "name"):concat(", ");
local desc = command_help.desc or command_help.module and ("Provided by mod_"..command_help.module) or "";
print(("%s:%s(%s) - %s"):format(section_name, command, args, desc));
end
end
elseif help_topics[section_name] then
local topic = help_topics[section_name];