Croc/croccybot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feature (reaction-roles): Configuration command.

Browse Source 
New monolithic `rroles` configuration command.
Complete logging and setting implementation in RR tracker.
Improve strings in RR settings.

Add special `NEWPAGE` manual section parsed by the help command.
Add `tabulated` method for `ObjectSettings` for easy display.
Add `_parse_create` switch for the `Role` setting type.
This commit is contained in:
Conatum
2021-10-18 15:28:14 +03:00
parent 006f2cfd6d
commit cfa3c90841
7 changed files with 912 additions and 265 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
bot/modules/meta/help.py
View File

@@ -78,15 +78,17 @@ async def cmd_help(ctx):
help_map = {field_name: i for i, (field_name, _) in enumerate(help_fields)}
if not help_map:
await ctx.reply("No documentation has been written for this command yet!")
return await ctx.reply("No documentation has been written for this command yet!")
field_pages = [[]]
page_fields = field_pages[0]
for name, pos in help_map.items():
if name.endswith("``"):
# Handle codeline help fields
help_fields[pos] = (
page_fields.append((
name.strip("`"),
"`{}`".format('`\n`'.join(help_fields[pos][1].splitlines()))
)
))
elif name.endswith(":"):
# Handle property/value help fields
lines = help_fields[pos][1].splitlines()
@@ -98,10 +100,10 @@ async def cmd_help(ctx):
names.append(split[0] if len(split) > 1 else "")
values.append(split[-1])
help_fields[pos] = (
page_fields.append((
name.strip(':'),
prop_tabulate(names, values)
)
))
elif name == "Related":
# Handle the related field
names = [cmd_name.strip() for cmd_name in help_fields[pos][1].split(',')]
@@ -110,32 +112,46 @@ async def cmd_help(ctx):
(getattr(ctx.client.cmd_names.get(cmd_name, None), 'desc', '') or '').format(ctx=ctx)
for cmd_name in names
]
help_fields[pos] = (
page_fields.append((
name,
prop_tabulate(names, values)
)
))
elif name == "PAGEBREAK":
page_fields = []
field_pages.append(page_fields)
else:
page_fields.append((name, help_fields[pos][1]))
# Build the aliases
aliases = getattr(command, 'aliases', [])
alias_str = "(Aliases `{}`.)".format("`, `".join(aliases)) if aliases else ""
# Build the embed
embed = discord.Embed(
title="`{}` command documentation. {}".format(command.name, alias_str),
colour=discord.Colour(0x9b59b6)
)
for fieldname, fieldvalue in help_fields:
embed.add_field(
name=fieldname,
value=fieldvalue.format(ctx=ctx, prefix=ctx.best_prefix),
inline=False
# Build the embeds
pages = []
for i, page_fields in enumerate(field_pages):
embed = discord.Embed(
title="`{}` command documentation. {}".format(
command.name,
alias_str
),
colour=discord.Colour(0x9b59b6)
)
for fieldname, fieldvalue in page_fields:
embed.add_field(
name=fieldname,
value=fieldvalue.format(ctx=ctx, prefix=ctx.best_prefix),
inline=False
)
embed.set_footer(
text="[optional] and <required> denote optional and required arguments, respectively."
)
embed.set_footer(
text="{}\n[optional] and <required> denote optional and required arguments, respectively.".format(
"Page {} of {}".format(i + 1, len(field_pages)) if len(field_pages) > 1 else '',
)
)
pages.append(embed)
# Post the embed
await ctx.reply(embed=embed)
await ctx.pager(pages)
else:
# Build the command groups
cmd_groups = {}