Add pagination to the output of the favorites list command
#954
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update Discord.js to version 14.11.0 to fix an error which occurred during implementation of this PR. (See: https://stackoverflow .com/questions/75892478/discord-js-v14-7-1-typeerror-channel-istextbased-is-not-a-function) Add Pagination.djs to project.
It's possible the favorites list may be very long. In the event this occurs, care must be taken when displaying the information as Discord imposes limits on the size of embeds (and more generally, messages). This implementation adds a library which makes paginating embeds easy so that the output of this command can handle an arbitrary amount of favorites. Furthermore, it switches the output to ephemeral to help prevent clutter in channels.
Not 100% sure if this PR constitutes a minor or patch bump... opted for minor since it introduces new functionality while also fixing a bug.
📦 A new release has been made for this pull request.To play around with this PR, pull Images are available for x86_64 and ARM64.
|
Signed-off-by: Cory J Reid <[email protected]>
Update Discord.js to version 14.11.0 to fix an error which occurred during implementation of this PR. (See: https://stackoverflow .com/questions/75892478/discord-js-v14-7-1-typeerror-channel-istextbased-is-not-a-function) Add Pagination.djs to project. Signed-off-by: Cory J Reid <[email protected]>
Signed-off-by: Cory J Reid <[email protected]>
It's possible the favorites list may be very long. In the event this occurs, care must be taken when displaying the information as Discord imposes limits on the size of embeds (and more generally, messages). This implementation adds a library which makes paginating embeds easy so that the output of this command can handle an arbitrary amount of favorites. Furthermore, it switches the output to ephemeral to help prevent clutter in channels. Signed-off-by: Cory J Reid <[email protected]>
Not 100% sure if this PR constitutes a minor or patch bump... opted for minor since it introduces new functionality while also fixing a bug. Signed-off-by: Cory J Reid <[email protected]>
…into favorites-list-with-pagination
I accidentally forgot to add the date when I made my addition.
The `yarn tsc` command was failing due to issues with project configuration and conflicting versions of @types/ws.
|
Alright, I got all the build checks passing! Sorry for the spam... I'm a Java developer typically so not super familiar with the Node/TS world. However it shows the merge is still blocked due to my first commits being unsigned (had never had a need to have that setup before). I'm not sure if you can simply override that on a case-by-case basis or if I should close this PR and open a new one? Please do let me know at your leisure (also if there's anything else I need to do/adjust)! Thanks! |
codetheweb
approved these changes
Jul 19, 2023
At the request of the repo owner.
|
🚀 Released in Release v2.4.0. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #606
Introduces pagination to the output of the
favorites listcommand to prevent extremely large lists of favorites violating Discord's embed/message limits.Key Choices
I figured it would be easier to maintain by simply adding a package which provides the pagination rather than creating one myself.
I was encountering a bug when using the pagination library - turns out the bug was in Discord.js and upgrading resolved the issue. I updated and pinned to latest. (See: https://stackoverflow.com/questions/75892478/discord-js-v14-7-1-typeerror-channel-istextbased-is-not-a-function)
Note: Edits to the changelog might seem excessive... I simply formatted the file after making my additions to bring solid consistency. Can always undo this if this is an issue.