• New context menu item sends an ephemeral message with better versions of Twitter links
• Adds basic bones for context-menu commands, similar to the way chat-input (slash) commands work
• Fixed some cases of hard-coded formatting, using Discord.js's tools

Closes #45

This should make commands be fully functional (subcommands, context menu commands, etc) and easier to implement. The unit tests should also be passing.

Added

• Discord client
• Event handling
• Command dispatcher
• Lots of unit tests
• Some fixes to the dev environment, making ESLint and Prettier fight less

The test coverage is "ok," but could be improved. I added a CI check to make coverage clear and keep us accountable.

Closes #7

• who should own the bot account?

• can the bot be easily transferred between discord accounts in the future?

• how to safely distribute the token for testing purposes?

This is a chonky pull request. Lots of new files, and lots of little edits all over the place.

• Added a new type for Event Handlers
• Added a ./events folder with an index.ts that gathers all event files, similar to ./commands
• Moved all event handlers out of main.ts and into individual event files
• Moved all event handler testing code out of main.test.ts into individual test files
• Moved command-handling code from handleInteraction.ts into the interactionCreate event file
• Updated all affected test files
• Wrote new tests for all new code - 100% coverage on all additions
• On the side, I made xkcd.test.ts mock the logger file like the other tests

There's a lot here, so I'm sure it's a little messy. Don't be shy with requesting changes.

Closes #28

When users add reactions to messages, the bot will some fraction of the time, also react with that same reaction.

/set-reaction-rate <rate> [emoji] sets how often the bot reacts. If emoji is not specified, this will set the default reaction rate for all reactions, which can be overriden on a reaction-by-reaction basis by specifying emoji. rate is a simple fractional number like 0.1. If this command has not been run yet, set the default reaction rate to 0.05.

/get-reaction-rate [emoji] prints the set rate for either the default or a specific emoji. If no specific rate is set for an emoji, show the default and indicate that it is is the default.

At its very basic, /help lists the commands available to the user. This is at least a start.

This command will automatically include new commands as they're added in src/commands/index.ts.

Closes #8

@JstnMcBrd made a good point in #14 that handleInteraction is a hekkin chonker of a function.

I think that function should be in charge of constructing the context, since that's a natural part of executing a command, which is the primary job of the handleInteraction function. The methods (prepareForLongRunningTasks, reply, followUp, etc.) could be moved away, using something like a function factory, without breaking the context interface. We can't just move the functions directly, since they rely on the interaction metadata from the specific command invocation, but a factory could encapsulate the relevant logic while leaving handleInteraction to do the main business of constructing and dispatching the wider context.

The logger was already partially abstracted before, but it required passing logger around through parameters in methods. This was causing problems for event handler abstraction.

Now the logger is in a separate file called logger.ts that contains a method that returns the logger to use (the console, for now). We use a method instead of a constant to make mocking easier for tests.

All files that used the logger before now pull the logger from logger.ts instead of passing through parameters. I also updated tests to reflect this fact by mocking logger.ts.

(Posited by @ZYancey)

Many stories (Starboard, Tracking, Smites) depend on a Database, establishing this should be a high priority as it will unlock future work It could be nice if it regularly created snapshots of the database on a schedule or through a slash command.

/xkcd should post a link with the most recent xkcd comic. /xkcd [query] should search for xkcd comics and post the best match

Dev notes: Perhaps look at how Ze Kaiser did this to get ideas on the search

Tags at a minimum viable stage. Not close to ready for merge. Mostly just for reference at this point but following next week I should be able to clean things up.

Copied from a discussion in #dev. See there for more details.

Instead of the bot automatically replacing the user's message when it detects a twitter.com link, how about it sends an ephemeral reply advising the user to edit their message to use fxtwitter.com?

Hi there! I noticed you posted a twitter link. Did you know you can improve the embed by editing your message to use fxtwitter.com instead of twitter.com?

Or something shorter like

Pro tip: replace twitter.com with fxtwitter.com for a better discord embed!

Or something more assertive

Please replace twitter.com with fxtwitter.com for an improved embed.

Or something goofy

Uh oh, looks like you posted a default twitter link. Such a terrible embed. That's really embarrassing. Better edit your message before anyone notices. Quick, replace twitter.com with fxtwitter.com!

Similar to the /xkcd command, we could easily add a command to fetch the Astronomy Picture of the Day.

NASA has an open API for APOD, and there's also some node module wrappers to make it easy. Here's the best one I found.

Just like the /xkcd command, it could fetch the current APOD or any APOD from the past, all the way back to 1996.

The purpose of the /emoji command would be similar to /profile - return the internal image used for a custom emoji.

Discord.js has this functionality with the Emoji.url property.