Merge branch 'refactor' into 'main'

refactor: fix clippy lints

See merge request Erenoit/discord-bot!24

Author: Erenoit

src/bot/commands/entertainment/mod.rs

@@ -1,4 +1,6 @@
 //! Contains all the entertainment commands.
 
+/// meme command.
 pub mod meme;
+/// sus command.
 pub mod sus;

src/bot/commands/macros.rs

@@ -1,3 +1,5 @@
+//! Macros for the commands.
+
 /// Gives [`Server`] and [`Guild`] for the given [`Context`].
 ///
 /// Most of the commands need these two, so this macro is used to reduce code

src/bot/commands/mod.rs

@@ -17,7 +17,10 @@ pub mod entertainment;
 pub mod music;
 pub mod others;
 
+/// Error type for the bot.
 type Error = Box<dyn std::error::Error + Send + Sync>;
+/// Context type for the bot.
 pub type Context<'a> = poise::Context<'a, Data, Error>;
 
+/// The data type for the bot.
 pub struct Data;

src/bot/commands/music/mod.rs

@@ -1,20 +1,31 @@
 //! Contains all the music commands.
 
+/// clear command
 pub mod clear;
+/// join command
 pub mod join;
+/// leave command
 pub mod leave;
+/// music command
 #[allow(clippy::module_inception)]
 #[cfg(feature = "database")]
 pub mod music;
+/// play command
 pub mod play;
+/// queue command
 pub mod queue;
+/// repeat command
 pub mod repeat;
+/// shuffle command
 pub mod shuffle;
+/// skip command
 pub mod skip;
+/// stop command
 pub mod stop;
 
 use crate::{bot::commands::Context, server::Server};
 
+/// Gets the voice channel id from the context.
 fn context_to_voice_channel_id(ctx: &Context<'_>) -> Option<serenity::model::id::ChannelId> {
     ctx.guild()
         .expect("Guild should be Some")
@@ -23,6 +34,7 @@ fn context_to_voice_channel_id(ctx: &Context<'_>) -> Option<serenity::model::id:
         .and_then(|voice_state| voice_state.channel_id)
 }
 
+/// Handles the voice channel connection.
 async fn handle_vc_connection(ctx: &Context<'_>, server: &Server) -> anyhow::Result<()> {
     let bot_vc = server.player.connected_vc().await;
     if bot_vc.is_none() {

src/bot/commands/music/music.rs

@@ -207,7 +207,7 @@ pub async fn list(ctx: Context<'_>) -> Result<(), Error> {
         .await?
         .iter()
         .for_each(|result| {
-            _ = writeln!(
+            writeln!(
                 msg,
                 "**{}**: <{}>",
                 result
@@ -216,7 +216,8 @@ pub async fn list(ctx: Context<'_>) -> Result<(), Error> {
                     .expect("There is a `-` in prefix. This cannot fail.")
                     .1,
                 result.value
-            );
+            )
+            .ok();
         });
 
         msg += "\n";

src/bot/commands/others/mod.rs

@@ -1,5 +1,8 @@
 //! Contains all the commands that don't fit in any other category.
 
+/// help command
 pub mod help;
+/// ping command
 pub mod ping;
+/// register command
 pub mod register;

src/bot/event.rs

@@ -1,3 +1,5 @@
+//! Struct for handling `Discord` events.
+
 use std::sync::Arc;
 
 use serenity::{
@@ -16,6 +18,7 @@ use crate::server::Server;
 /// It currently handles `Ready`, `GuildCreate` and `GuildDelete` events.
 pub struct Handler;
 impl Handler {
+    /// Creates new [`Handler`] struct.
     pub const fn new() -> Self { Self }
 }
 
@@ -32,6 +35,7 @@ impl EventHandler for Handler {
         }
 
         log!(info, "{} is online!", (ready.user.name.magenta()));
+        drop(servers);
     }
 
     async fn guild_create(&self, _ctx: Context, guild: Guild, is_new: bool) {

src/bot/mod.rs

@@ -24,9 +24,15 @@ pub struct Bot;
 
 impl Bot {
     /// Creates a new instance of the bot.
+    #[must_use]
     pub const fn new() -> Self { Self }
 
     /// Runs the bot.
+    ///
+    /// # Panics
+    ///
+    /// This method panics if it cannot run database mitigations or cannot
+    /// connects to the `Discord`
     pub async fn run(&mut self) {
         #[cfg(feature = "database")]
         get_config!()

src/config/database.rs

@@ -10,6 +10,7 @@ use taplo::dom::Node;
 #[cfg(not(feature = "config_file"))]
 use crate::config::Node;
 
+/// Database configuration.
 #[non_exhaustive]
 pub(super) struct DatabaseConfig {
     /// Database pool.

src/config/defaults.rs

@@ -4,21 +4,34 @@
 //! when the config file is not present or when a value is missing from the
 //! config file.
 
+/// Default Prefix
 pub(super) const PREFIX: &str = "-";
+/// Default Auto Register Commands
 pub(super) const AUTO_REGISTER_COMMANDS: bool = true;
+/// Default VC Auto Change
 #[cfg(feature = "music")]
 pub(super) const VC_AUTO_CHANGE: bool = false;
+/// Default Enable Spotify
 #[cfg(feature = "spotify")]
 pub(super) const ENABLE_SPOTIFY: bool = false;
+/// Default YT Search Count
 #[cfg(feature = "music")]
 pub(super) const YT_SEARCH_COUNT: u8 = 5;
+/// Default YT Age Restricted
 #[cfg(feature = "music")]
 pub(super) const YT_AGE_RESTRICTED: bool = false;
+/// Default Enable Database
 #[cfg(feature = "database")]
 pub(super) const ENABLE_DATABASE: bool = true;
+/// Default Always Embed
 pub(super) const ALWAYS_EMBED: bool = false;
+/// Default Random Embed Colors
 pub(super) const RANDOM_EMBED_COLORS: bool = false;
+/// Default Embed Success Color
 pub(super) const SUCCESS_COLOR: u32 = 0x00FF00;
+/// Default Embed Normal Color
 pub(super) const NORMAL_COLOR: u32 = 0x0000FF;
+/// Default Embed Error Color
 pub(super) const ERROR_COLOR: u32 = 0xFF0000;
+/// Default Interaction Time Limit
 pub(super) const INTERACTION_TIME_LIMIT: u64 = 30;