Add options help

Author: No767

bot/cogs/config.py

@@ -3,6 +3,7 @@
 import datetime
 import difflib
 from enum import Enum
+from pathlib import Path
 from typing import (
     TYPE_CHECKING,
     Annotated,
@@ -29,6 +30,7 @@
     check_permissions,
     is_manager,
 )
+from libs.utils.config import OptionsHelp
 from libs.utils.embeds import CooldownEmbed, Embed
 from libs.utils.pages import SimplePages
 from libs.utils.pages.paginator import RoboPages
@@ -37,12 +39,14 @@
 
 if TYPE_CHECKING:
     from cogs.tickets import Tickets
+
     from rodhaj import Rodhaj
 
 
 UNKNOWN_ERROR_MESSAGE = (
     "An unknown error happened. Please contact the dev team for assistance"
 )
+OPTIONS_FILE = Path(__file__).parents[1] / "locale" / "options.json"
 
 
 class BlocklistTicket(NamedTuple):
@@ -347,6 +351,7 @@ def __init__(self, bot: Rodhaj) -> None:
             "anon_reply_without_command",
             "anon_snippets",
         ]
+        self.options_help = OptionsHelp(OPTIONS_FILE)
 
     @property
     def display_emoji(self) -> discord.PartialEmoji:

bot/libs/utils/config.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 from typing import Any, Generic, Optional, TypeVar, Union, overload
 
+import orjson
 import yaml
 
 _T = TypeVar("_T")
@@ -44,3 +45,39 @@ def __len__(self) -> int:
 
     def all(self) -> dict[str, Union[_T, Any]]:
         return self._config
+
+
+class OptionsHelp(Generic[_T]):
+    def __init__(self, path: Path):
+        self.path = path
+        self._config: dict[str, Union[_T, Any]] = {}
+        self.load_from_file()
+
+    def load_from_file(self) -> None:
+        try:
+            with open(self.path, "r") as f:
+                self._config: dict[str, Union[_T, Any]] = orjson.loads(f.read())
+        except FileNotFoundError:
+            self._config = {}
+
+    @overload
+    def get(self, key: Any) -> Optional[Union[_T, Any]]: ...
+
+    @overload
+    def get(self, key: Any, default: Any) -> Union[_T, Any]: ...
+
+    def get(self, key: Any, default: Any = None) -> Optional[Union[_T, Any]]:
+        """Retrieves a config entry."""
+        return self._config.get(str(key), default)
+
+    def __contains__(self, item: Any) -> bool:
+        return str(item) in self._config
+
+    def __getitem__(self, item: Any) -> Union[_T, Any]:
+        return self._config[str(item)]
+
+    def __len__(self) -> int:
+        return len(self._config)
+
+    def all(self) -> dict[str, Union[_T, Any]]:
+        return self._config

bot/locale/options.json

@@ -0,0 +1,50 @@
+{
+    "guild_age": {
+        "default": "2 days",
+        "description": "Sets the default age required for an guild in order to use Rodhaj",
+        "examples": [
+            "`config set-age guild 2 days`"
+        ],
+        "notes": []
+    },
+    "account_age": {
+        "default": "2 hours",
+        "description": "Sets the default age required for an account that has joined the guild that Rodhaj is operating on",
+        "examples": [
+            "`config set-age account 2 days`"
+        ],
+        "notes": []
+    },
+    "mention": {
+        "default": "@here",
+        "description": "Sets the default mention to use when new tickets are created",
+        "examples": [
+            "`config set mention @here`"
+        ],
+        "notes": ["Pass in an empty string in order to disable this"]
+    },
+    "anon_replies": {
+        "default": false,
+        "description": "Enables the anonymous replying feature of Rodhaj. This affects the guild itself.",
+        "examples": [
+            "`config toggle anon_replies false`"
+        ],
+        "notes": []
+    },
+    "anon_reply_without_command": {
+        "default": false,
+        "description": "Anonymously reply without using the command",
+        "examples": [
+            "`config toggle anon_reply_without_command true`"
+        ],
+        "notes": []
+    },
+    "anon_snippets": {
+        "default": false,
+        "description": "Enable the usage of sending snippets anonymously",
+        "examples": [
+            "`config toggle anon_snippets true`"
+        ],
+        "notes": []
+    }
+}