Config help

Author: Taaku18

CHANGELOG.md

@@ -23,6 +23,7 @@ however, insignificant breaking changes does not guarantee a major version bump,
 - Multi-step alias, see `?help alias add`. Public beta testing, might be unstable.
 - Misc commands without cogs are now displayed in `?help`.
 - `?help` works for alias and snippets.
+- `?config help <config-name>` shows a help embed for the configuration.
 
 ### Changes
 
@@ -35,6 +36,7 @@ however, insignificant breaking changes does not guarantee a major version bump,
 - `?plugin registry page-number` plugin registry can specify a page number for quick access.
 - A reworked interface for `?snippet` and `?alias`.
   - Add an `?snippet raw <name>` command for viewing the raw content of a snippet (escaped markdown).
+- The placeholder channel for the streaming status changed to https://www.twitch.tv/discordmodmail/.
 
 ### Fixes
 
@@ -45,6 +47,7 @@ however, insignificant breaking changes does not guarantee a major version bump,
 - Resolves errors when message was sent by mods after thread is closed somehow.
 - Recipient join/leave server messages are limited to only the guild set by `GUILD_ID`.
 - When creating snippets and aliases, it now checks if another snippets/aliases with the same name exists.
+- Was looking for `config.json` in the wrong directory.
 
 ### Internal
 

cogs/utility.py

@@ -733,11 +733,14 @@ async def config(self, ctx):
         Type `{prefix}config options` to view a list
         of valid configuration variables.
 
+        Type `{prefix}config help config-name` for info
+         on a config.
+
         To set a configuration variable:
-        - `{prefix}config set varname value here`
+        - `{prefix}config set config-name value here`
 
         To remove a configuration variable:
-        - `{prefix}config remove varname`
+        - `{prefix}config remove config-name`
         """
         await ctx.send_help(ctx.command)
 
@@ -849,6 +852,52 @@ async def config_get(self, ctx, key: str.lower = None):
 
         return await ctx.send(embed=embed)
 
+    @config.command(name="help", aliases=["info"])
+    @checks.has_permissions(PermissionLevel.OWNER)
+    async def config_help(self, ctx, key: str.lower):
+        """
+        Show information on a specified configuration.
+        """
+        if key not in self.bot.config.public_keys:
+            embed = Embed(
+                title="Error",
+                color=Color.red(),
+                description=f"`{key}` is an invalid key.",
+            )
+            return await ctx.send(embed=embed)
+
+        config_help = self.bot.config.config_help
+        info = config_help.get(key)
+
+        if info is None:
+            embed = Embed(
+                title="Error",
+                color=Color.red(),
+                description=f"No help details found for `{key}`.",
+            )
+            return await ctx.send(embed=embed)
+
+        def fmt(val):
+            return val.format(prefix=self.bot.prefix, bot=self.bot)
+
+        embed = Embed(
+            title=f"Configuration description on {key}:",
+            color=self.bot.main_color
+        )
+        embed.add_field(name='Default:', value=fmt(info['default']), inline=False)
+        embed.add_field(name='Information:', value=fmt(info['description']), inline=False)
+        example_text = ''
+        for example in info['examples']:
+            example_text += f'- {fmt(example)}\n'
+        embed.add_field(name='Example(s):', value=example_text, inline=False)
+
+        note_text = ''
+        for note in info['notes']:
+            note_text += f'- {fmt(note)}\n'
+        if note_text:
+            embed.add_field(name='Notes(s):', value=note_text, inline=False)
+        return await ctx.send(embed=embed)
+
     @commands.group(aliases=["aliases"], invoke_without_command=True)
     @checks.has_permissions(PermissionLevel.MODERATOR)
     async def alias(self, ctx, *, name: str.lower = None):

core/config.py

@@ -24,7 +24,7 @@ class ConfigManager:
 
     public_keys = {
         # activity
-        "twitch_url": "https://www.twitch.tv/discord-modmail/",
+        "twitch_url": "https://www.twitch.tv/discordmodmail/",
         # bot settings
         "main_category_id": None,
         "prefix": "?",
@@ -55,8 +55,8 @@ class ConfigManager:
         "thread_self_close_response": "You have closed this Modmail thread.",
         # moderation
         "recipient_color": str(discord.Color.gold()),
-        "mod_tag": None,
         "mod_color": str(discord.Color.green()),
+        "mod_tag": None,
         # anonymous message
         "anon_username": None,
         "anon_avatar_url": None,
@@ -117,6 +117,7 @@ def __init__(self, bot):
         self.bot = bot
         self._cache = {}
         self.ready_event = asyncio.Event()
+        self.config_help = {}
 
     def __repr__(self):
         return repr(self._cache)
@@ -129,7 +130,7 @@ def populate_cache(self) -> dict:
             {k.lower(): v for k, v in os.environ.items() if k.lower() in self.all_keys}
         )
         configjson = os.path.join(
-            os.path.dirname(os.path.abspath(__file__)), "config.json"
+            os.path.dirname(os.path.dirname(os.path.abspath(__file__))), "config.json"
         )
         if os.path.exists(configjson):
             logger.debug("Loading envs from config.json.")
@@ -147,8 +148,13 @@ def populate_cache(self) -> dict:
                     logger.critical(
                         "Failed to load config.json env values.", exc_info=True
                     )
-
         self._cache = data
+
+        confighelpjson = os.path.join(
+            os.path.dirname(os.path.abspath(__file__)), "config_help.json"
+        )
+        with open(confighelpjson, "r") as f:
+            self.config_help = json.load(f)
         return self._cache
 
     async def clean_data(self, key: str, val: typing.Any) -> typing.Tuple[str, str]: