Fix: Remove messageId arg from room reactions#12
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe updates remove the requirement to specify a message ID when sending a reaction in a chat room, both in the command-line interface and its documentation. The command now sends reactions at the room level using only the room ID and emoji. Additionally, a commented-out interface was cleaned up from the subscription command. Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
3878-3883: Add language identifier to fenced code block
To improve readability and satisfy markdown lint rules (MD040), specify the language on the code fence for the usage example. For example:- ``` + ```sh🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3878-3878: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
README.md(3 hunks)src/commands/rooms/reactions/send.ts(8 hunks)src/commands/rooms/reactions/subscribe.ts(0 hunks)
💤 Files with no reviewable changes (1)
- src/commands/rooms/reactions/subscribe.ts
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
3878-3878: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: test
- GitHub Check: e2e-tests
🔇 Additional comments (15)
README.md (4)
3874-3876: Consistent heading update: RemovedMESSAGEID
The heading now correctly reflects the new signature without theMESSAGEIDparameter.
3880-3883: Usage updated to removeMESSAGEID
The usage example now only requiresROOMIDandEMOJI, matching the updated command implementation.
3885-3887: Arguments section matches new signature
TheARGUMENTSsection correctly lists onlyROOMIDandEMOJI, omittingMESSAGEID.
3903-3905: Description aligned with updated signature
TheDESCRIPTIONsection accurately describes sending a reaction at the room level without targeting a message.src/commands/rooms/reactions/send.ts (11)
8-18: Correctly removed the messageId parameter from command argumentsThe command now properly defines only roomId and emoji as its arguments, which aligns with the PR objective to remove the unnecessary messageId parameter from room reactions.
20-20: Description updated to reflect room-level reactionThe command description has been appropriately updated to describe sending a reaction in a chat room without referencing a specific message.
22-27: Examples updated consistentlyAll command examples have been updated to reflect the new syntax without the messageId parameter, making the documentation clear and consistent.
64-64: Parameter destructuring updated appropriatelyThe destructuring of arguments now correctly includes only roomId and emoji, removing the previously unused messageId parameter.
87-88: Error output format updatedThe JSON error output format has been correctly updated to remove the messageId field while maintaining all other necessary information.
204-205: Log message simplified appropriatelyThe log message for sending a reaction has been simplified to remove references to messageId while still providing clear information about the action being performed.
215-216: Success log message updatedThe success log message has been simplified to remove the messageId reference while maintaining clarity about the completed action.
230-231: Console output message updated consistentlyThe user-facing success message has been updated to clearly indicate that the reaction was sent to the room, without referencing a specific message.
259-260: Error log message updatedThe error log message has been properly updated to remove the messageId field while maintaining all relevant error context.
270-272: Error JSON output format updatedThe error JSON output format has been correctly updated to remove the messageId field while maintaining all other necessary information.
207-210: Reaction send implementation remains unchangedThe actual implementation of sending a reaction didn't require changes, confirming that the messageId parameter was indeed unnecessary as the room.reactions.send method only needs emoji type and metadata.
…ions Fix: Remove messageId arg from room reactions and fix some failing tests
Description
Room reactions do not require a messageId, so this has been removed.
Summary by CodeRabbit
Documentation
Refactor