Skip to content

Replace markdownV2 in some messages - #656

Merged
grunch merged 1 commit into
mainfrom
remove-markdownV2
May 14, 2025
Merged

Replace markdownV2 in some messages#656
grunch merged 1 commit into
mainfrom
remove-markdownV2

Conversation

@grunch

@grunch grunch commented May 14, 2025

Copy link
Copy Markdown
Member

Most of the times MDV2 is unnecessary

Summary by CodeRabbit

  • Style

    • Improved message formatting by switching from 'MarkdownV2' to 'Markdown' in multiple Telegram messages for simpler and more consistent display.
    • Removed unnecessary sanitization of the buyer rating in invoice payment request messages.
  • Refactor

    • Streamlined internal handling of hold invoice creation responses for improved code clarity.

Most of the times MDV2 is unnecessary
@coderabbitai

coderabbitai Bot commented May 14, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The updates remove the extraction and use of the _request property from the createHoldInvoice response in the waitPayment function and adjust how buyer ratings are handled in messages. Additionally, the Telegram message parse mode is switched from 'MarkdownV2' to 'Markdown' in several message-sending functions, simplifying formatting.

Changes

Files Change Summary
bot/commands.ts Removed destructuring and use of the _request property from createHoldInvoice in waitPayment.
bot/messages.ts Removed sanitizeMD for buyer rating, replaced let with const for rate, and changed parse mode to 'Markdown' in four message-sending functions.

Possibly related PRs

Poem

A tweak to the bot, so neat and precise,
No more _request—just hash will suffice!
Markdown made simple, no more V2,
Ratings shine bright with a formatting hue.
🐰✨
Code hops along, with messages clear,
Telegram chats bring users cheer!

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b2e55f6 and 8d67689.

📒 Files selected for processing (2)
  • bot/commands.ts (1 hunks)
  • bot/messages.ts (4 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
bot/commands.ts (1)
ln/hold_invoice.js (1)
  • createHoldInvoice (6-31)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: ci_to_main
  • GitHub Check: ci_to_main
🔇 Additional comments (6)
bot/commands.ts (1)

57-60: Improvement: Removed unused variable from destructuring

The removal of the _request property from the destructuring assignment simplifies the code by only extracting the properties that are actually used (hash and secret). This is a good practice that reduces unnecessary variables.

bot/messages.ts (5)

79-79: LGTM: Improved variable declaration

Changed from mutable let to immutable const for the rate variable, which is good practice since this value isn't modified after initialization.


91-91: Simplifies message formatting by switching to Markdown parse mode

The change from MarkdownV2 to Markdown simplifies the formatting requirements, as MarkdownV2 requires stricter character escaping. This aligns with the PR objective to remove unnecessary MarkdownV2 usage.


127-128: Consistent message formatting using Markdown

Switching from MarkdownV2 to Markdown for QR code captions keeps the formatting consistent with other message parsing changes and simplifies the character escaping requirements.


156-157: Simplified message formatting

Changed from MarkdownV2 to Markdown for the cancel order command message, making the formatting consistent with other similar changes in this PR.


149-150:

Details

❌ Incorrect review comment

Consider consistent parse mode usage across the codebase

There are still several instances of MarkdownV2 parse mode being used in this file (lines 149, 184, 435, 500, etc.). Consider making all formatting consistent by using either Markdown or MarkdownV2 throughout the codebase in a future update.

To understand which other locations might need updating for consistency, run:

Also applies to: 184-185, 435-436, 500-501


🏁 Script executed:

#!/bin/bash
# Find all MarkdownV2 occurrences in the codebase
rg -i "markdownv2" --type ts

Length of output: 1354


Parse mode usage is already consistent
All instances of parse_mode in the codebase explicitly use 'MarkdownV2'—no occurrences of 'Markdown' or other modes were found. No further changes are necessary.

Likely an incorrect or invalid review comment.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@grunch
grunch merged commit 51d729b into main May 14, 2025
@grunch
grunch deleted the remove-markdownV2 branch May 14, 2025 13:53
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