feat: Use clap help instead of custom #5

lorax · 2025-07-31T09:57:04Z

lorax commented

2025-07-31 09:57:04 +00:00

the ! is now the caller instead of the command name
this enables things like !help <command> to show it's description
therefore the custom help text is no longer needed
this way the bot acts more like a familiar cli
also we get the bot version info for free ^^

* the ! is now the caller instead of the command name * this enables things like `!help <command>` to show it's description * therefore the custom help text is no longer needed * this way the bot acts more like a familiar cli * also we get the bot version info for free ^^

lorax added 5 commits

2025-07-31 09:57:05 +00:00

feat: add aliases for commands 7840e69987

Merge branch 'use-clap' into lorax/clap 916e0044d7

Merge branch 'use-clap' into lorax/creds 9ea758214e

Merge branch 'lorax/creds' into lorax/clap e4c2909c45

feat: Use clap help instead of custom 01007e8e5f

* the ! is now the caller instead of the command name
* this enables things like `!help <command>` to show it's description
* therefore the custom help text is no longer needed
* this way the bot acts more like a familiar cli
* also we get the bot version info for free ^^

lorax requested review from aviac

2025-07-31 09:57:14 +00:00

lorax changed target branch from lorax/creds to use-clap

2025-07-31 10:00:56 +00:00

lorax added 1 commit

2025-07-31 10:02:43 +00:00

Merge branch 'use-clap' into lorax/clap 2a60f63414

aviac requested changes

2025-07-31 11:13:40 +00:00

Dismissed

aviac left a comment

Woah, richtig nice! Schoen simpel jetzt alles 💯 Noch ein paar Kleinigkeiten, aber ansonsten koennen wir das basically mergen

bots/soko-command-bot/src/commands.rs Outdated

					
				@ -73,29 +74,18 @@ pub async fn execute_commands(

				    client: Client,

				    message: &str,

				) -> anyhow::Result<()> {

				    let binary_name = std::env::args()

				        .next()

				        .context("Binary name not found! Aborting!")?;

				    let binary_name = "!";

Bitte kommentieren. Das hat mich gerade verwirrt. Ich dachte, dass Args::try_parse_from den richtigen binary namen vom rust crate benoetigt oder sonst abschmiert. Das Ding wird ja aber anscheinend

nicht gecheckt
verwendet um die help message zu bauen

Das war mir sehr neu und irgendwie nicht intuitiv

Bitte kommentieren. Das hat mich gerade verwirrt. Ich dachte, dass `Args::try_parse_from` den richtigen binary namen vom rust crate benoetigt oder sonst abschmiert. Das Ding wird ja aber anscheinend 1. nicht gecheckt 2. verwendet um die help message zu bauen Das war mir sehr neu und irgendwie nicht intuitiv

^^'

bots/soko-command-bot/src/commands.rs Outdated

					
				@ -73,29 +74,18 @@ pub async fn execute_commands(

				    client: Client,

				    message: &str,

				) -> anyhow::Result<()> {

				    let binary_name = std::env::args()

				        .next()

				        .context("Binary name not found! Aborting!")?;

				    let binary_name = "!";

				    let mut msg_args = message.split_whitespace();

				    let cmd = message.split_whitespace();

Wenn wir nicht nur das erste arg nehmen, welche implications hat das dann noch? Also zum Beispiel

!help me

waere dann invalid ... naja, geht vielleicht sogar wenn es die error message ordentlich printed. Hmm bin noch nicht so sicher.

Also ja, lass uns das so machen.

Wenn wir nicht nur das erste arg nehmen, welche implications hat das dann noch? Also zum Beispiel `!help me` waere dann invalid ... naja, geht vielleicht sogar wenn es die error message ordentlich printed. Hmm bin noch nicht so sicher. Also ja, lass uns das so machen.

Ist eigentlich aussagekräftig

error: unrecognized subcommand 'me'

Usage: ! <COMMAND>

For more information, try '--help'.

Ist eigentlich aussagekräftig ``` error: unrecognized subcommand 'me' Usage: ! <COMMAND> For more information, try '--help'. ```

bots/soko-command-bot/src/main.rs Outdated

					
				@ -38,7 +37,9 @@ async fn on_room_message(event: OriginalSyncRoomMessageEvent, room: Room, client

				        return;

				    }

				    if let Err(error) = execute_commands(room, event, client, message).await {

				    if let Err(error) =

				        execute_commands(room, event, client, message.strip_prefix("!").unwrap()).await

Mit dem unwrap() stuerzt der bot jedes mal ab wenn keine command nachricht kommt. Also wie checken das schon vorher, aber es ist vielleicht besser hier wenigstens nen Kommentar dranzuschreiben, wenn nicht sogar das bisschen zu refactoren, sodass es den case wo es None ist ordentlich handlet

Mit dem `unwrap()` stuerzt der bot jedes mal ab wenn keine command nachricht kommt. Also wie checken das schon vorher, aber es ist vielleicht besser hier wenigstens nen Kommentar dranzuschreiben, wenn nicht sogar das bisschen zu refactoren, sodass es den case wo es `None` ist ordentlich handlet

Also das wäre sicherlich schöner, aber oben wird ja schon returned, wenn die Nachricht nicht den prefix '!' hat. Demnach sollte der Bot nicht abstürzen.

In solchen Faellen ist ein unwrap einfach meist ein Zeichen dafuer, dass irgendwas noch nicht ganz stimmig ist. Mit der Zeit werden unwraps immer mehr ein Dorn im Auge einfach auch wenn sie am Anfang komfortabel sind ^^

Ich hab's mal in a47e5570bc 'gefixt'

In solchen Faellen ist ein `unwrap` einfach meist ein Zeichen dafuer, dass irgendwas noch nicht ganz stimmig ist. Mit der Zeit werden `unwrap`s immer mehr ein Dorn im Auge einfach auch wenn sie am Anfang komfortabel sind ^^ Ich hab's mal in a47e5570bcb0d36a35a2e139fe8c8962ced68267 'gefixt'

👍 1