pfist / hiei.js Goto Github PK

Slash commands have their own permission system. Permissions should be defined in the command file, and sent along with the command's registry data.

Tasks

• Send permissions when registering commands
• Test permissions for slash, user, and message commands

I'm still deciding how to approach this. Should Hiei handle command registration or leave it for the bot to deal with?

I would like to explore the possibility of automating command registration. Essentially: if local commands are different from remote commands, register commands again to keep them updated.

Tasks

• Move sortBy function to a new HieiUtil utility class
• Cleaner comparison
• Better variable names

Launch a simple docs website with the 1.0 release. Also fill out the Readme before shipping.

Readme

• Title and description
• Features
• Get started
• Links
• Contributing

Docs

• Choose site framework
• Setup repo
• Customize design
• Deploy to Cloudflare Pages

Welcome

• Get started

Guide

• Slash commands
• Message commands
• User commands
• Listeners

Reference

• HieiClient
• SlashCommand
• MessageCommand
• UserCommand
• Listener

The last step when everything else is done: publish to NPM so I can use hiei in my projects.

• Authenticate with npm login
• Make sure package.json is formatted correctly
• Set up np for easier publishing
• Check name availability
• Publish 🚀

Useful resources:

• npm docs
• How to publish packages to npm (the way the industry does things)
• np

Once hiei is feature complete, it's time to clean up and polish things a bit.

Tasks

• Ensure consistent variable and parameter names throughout the framework
• Clean up comments (either remove all or comment every function with a consistent style)
• Run final test to make sure everything works

Hiei should include a very simple test bot in the test/ directory that tests and demonstrates all of Hiei's functionality.

Tasks

• Test client options
• Test commands
• Test listeners

Hiei should handle Discord and internal events out of the box. Internal events are those generated by Hiei's command and listener handlers.

Tasks

• Handle Discord events
• Handle internal events

After one evening working with Hiei, it's pretty clear my command registration isn't working well. I made a bot with 2 commands, and even if I don't change them, Hiei still registers them every time the bot logs in.

I should look at what's going on and see if I can make it work more consistently. If not, I should just drop it in favor of the separate registration script method described in the discord.js guide. The only problem to solve then will be: where does the script exist? Can I package it with Hiei somehow, or will I have to create a new one for every bot?

Tasks

• Support command options
• Support subcommands
• Support default permissions
• Support custom permissions

Hiei should handle message components, i.e. buttons and select menus.

Tasks

• Handle buttons
• Handle select menus

Add a utility class called HieiUtil for storing small, useful utility functions that are used throughout hiei.

Tasks

• Sort an array of objects by key in descending order
• Get an array of JS files found in a directory and its subdirectories

Hiei should handle slash, user, and message commands out of the box. There are two ways I could approach this:

1. Create separate handlers for each command type
2. Create a single command handler that uses conditional logic (isCommand, isContextMenu, etc.) to figure out which type to handle

Tasks

• Handle slash commands
• Handle user commands
• Handle message commands

Hiei should handle errors with a custom class that extends the native Error object. Read this article from Node Best Practices for guidance.