Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup discord integration code #314

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

JJ-8
Copy link
Collaborator

@JJ-8 JJ-8 commented Aug 11, 2024

The Discord integration code is quite a mess. This PR reorganizes the code of the Discord bot to be easier to understand. Furthermore, it should prepare for different Discord channel handling styles so we can easily implement configurable styles of channel handling.

Now the code for each interaction for a command is defined in the original command file
instead of one big file that implements the logic for all commands.
The challenges-talk channel is the only channel that does not have a Discord bot message in it,
so we should include everything in the channel.
These command implementations are a specific implementation of handling interaction,
so it should not be in the global folder.
When we want to introduce new ways of interacting with Discord, we need to separate the current 'agile' implementation with everything else.
This folder structure makes much more sense therefore.
In the future we want to be able to change the handle style of the Discord bot (see #239).
Now we have an easy way of adding new handle styles which can be toggled by .env configuration.

Only the discordHooks.ts needs to be split and reorganized for this to fully work.
@JJ-8 JJ-8 self-assigned this Aug 11, 2024
The channels.ts file is created with the agile workflow in mind.
Therefore it belongs to the agile subdirectory and it is not a general utility file.
Just like the commands and interactions, the hooks are now also dynamically imported.
This reduces the cognitive complexity a lot and allows for more reusable setup.
It makes more sense to have this function here than in the hooks.ts
since it is related to solving a task and not for hooking.
@JJ-8 JJ-8 marked this pull request as ready for review October 20, 2024 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant