fix(telegram): render Markdown with Telegram formatting#1624
Closed
elibosley wants to merge 5 commits into
Closed
Conversation
Purpose of the change: - Preserve paragraph spacing when Markdown input is converted to Telegram HTML payloads. How behavior was before: - Telegram HTML cleanup collapsed all repeated newlines to a single newline. - Markdown paragraph boundaries were lost, while hard line breaks and paragraphs became indistinguishable. Why that was a problem: - Messages with intentional blank lines appeared compressed in Telegram. - Metadata-style lines could be hard to scan because paragraph spacing from Markdown was not retained. What the new change accomplishes: - Keeps paragraph breaks for Markdown-origin Telegram HTML payloads. - Preserves legacy single-newline cleanup for raw HTML and text-origin content. - Adds regression coverage for Markdown paragraph spacing. How it works: - Makes Telegram HTML line-break cleanup format-sensitive. - Uses a double CRLF for Markdown paragraph closures, keeps single CRLF for title wrappers and legacy HTML/text paths, and trims a trailing extra paragraph break.
elibosley
force-pushed
the
codex/fix-telegram-paragraph-spacing
branch
from
94c8291 to
4fd9ff2
Compare
Purpose of the change: - Backport the broader Telegram Markdown rendering fixes from apprise-go into the upstream Telegram plugin. - Keep the existing paragraph-spacing PR as a single combined Telegram formatting change. How behavior was before: - Telegram Markdown targets received standard Markdown mostly unchanged. - MarkdownV2 escaping was not context-aware for code blocks, links, and converted HTML. - HTML input could be converted generically before Telegram had a chance to preserve Telegram-supported formatting. Why that was a problem: - Telegram's Markdown and MarkdownV2 parse modes are not compatible with generic Markdown syntax. - Valid standard Markdown could render incorrectly or be rejected by Telegram for bad escaping. - Paragraph, link, and code formatting could be lost or over-escaped. What the new change accomplishes: - Converts standard Markdown and HTML into Telegram Markdown v1 or MarkdownV2 for Telegram Markdown targets. - Preserves paragraph breaks while keeping hard line breaks as single newlines. - Applies MarkdownV2 escaping by text, link, and code/pre context. How it works: - Adds a Telegram-specific HTMLParser renderer for Telegram Markdown output. - Uses Markdown rendering with fenced-code support as the standard Markdown input path. - Adds a per-plugin conversion hook so Telegram can bypass generic Markdown conversion while other plugins keep existing behavior. - Expands Telegram tests for standard Markdown, MarkdownV2, links, code, HTML input, and paragraph spacing.
elibosley
changed the title
Purpose of the change: - Raise coverage for the new Telegram Markdown renderer to 100 percent across changed executable lines and branches. How behavior was before: - Main Telegram Markdown behavior was covered, but defensive helper no-ops and malformed/self-closing HTML parser branches were not executed. Why that was a problem: - The new renderer carried uncovered edge paths around empty builders, single trailing newlines, <br>, <li>, self-closing tags, and unmatched end tags. What the new change accomplishes: - Adds focused tests for the remaining Telegram renderer edge cases. - Confirms the new code reaches 100 percent diff line and branch coverage under the focused coverage run. How it works: - Exercises the private Telegram renderer helpers and parser entry points directly from the Telegram plugin tests. - Keeps the patch test-only and leaves production behavior unchanged.
Purpose of the change: - Fix a live Telegram client rendering issue found during end-to-end testing. How behavior was before: - Telegram Markdown v1 escaped literal '[' characters in rendered text. - Telegram accepted the payload but displayed the backslash in the client. Why that was a problem: - Markdown v1 notification labels such as [2/5 Markdown v1 conversion] showed a visible leading backslash. - The API-level test passed, but the client rendering was visibly wrong. What the new change accomplishes: - Stops escaping literal '[' characters in regular Telegram Markdown v1 text. - Preserves existing MarkdownV2 escaping and all other Markdown v1 escaping. How it works: - Narrows the Markdown v1 text escape regex to backslash, asterisk, underscore, and backtick.
Owner
|
I feel some of these changes you've put forward really mimic a more general solution brought forth here in an incomplete PR: #932. The idea of the PR was to add support for HTML -> Markdown and leverage the translations tools already built (for all services)... But it was never completed by the individual who started it. Right now, when the (Apprise) input is HTML and the output is markdown, the Your PR seems to convert I appreciate you trying to forward port a change you made on our Apprise-Go adaptation; i just need time to digest what is being submitted. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1624 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 210 212 +2
Lines 29834 30150 +316
Branches 4973 5029 +56
==========================================
+ Hits 29834 30150 +316
🚀 New features to boost your workflow:
|
- Purpose: address PR feedback asking whether the Telegram formatter should be split from a future general HTML-to-Markdown converter. - Before: the Telegram HTML renderer and conversion hook worked, but their scope was implicit and looked like a plugin-local replacement for a broader converter. - Problem: reviewers had to infer why Telegram bypasses the global conversion path for Markdown targets. - Change: document that the HTML renderer is intentionally Telegram-specific and that the conversion hook keeps original content so send() can apply Telegram parse-mode escaping. - Validation: run ruff check, ruff format --check, and focused Telegram/API pytest coverage.
Owner
|
I feel #1638 correctly handles this PR as this is to focused on 1 service and not all of them. Thanks for PR reguardless! 🙏 |
Author
|
No worries! Glad you got inspired I got busy 🙈
…On Jun 15, 2026 at 20:35 -0400, Chris Caron ***@***.***>, wrote:
caronc left a comment (caronc/apprise#1624)
I feel #1638 correctly handles this PR as this is to focused on 1 service and not all of them. Thanks for PR reguardless! 🙏
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Root Cause
Telegram's Markdown modes are not generic Markdown. The previous path either passed standard Markdown through mostly unchanged for Telegram Markdown targets, or relied on generic HTML cleanup for Telegram HTML targets. That collapsed intentional paragraph breaks, lost Telegram-supported formatting in some HTML-to-Markdown cases, and escaped MarkdownV2 content without enough context for links and code blocks. Live Telegram client testing also showed that escaping literal
[in Markdown v1 text can display a visible backslash, so Markdown v1 text escaping is kept narrower than MarkdownV2.Implementation Notes
HTMLParserrenderer that emits Telegram Markdown v1/MarkdownV2.html_to_markdown()converter.~~strike~~normalized for Telegram rendering.Validation
uv run --with ruff ruff check .uv run --with ruff ruff format --check .uv run --with pytest --with pytest-mock pytest tests/test_plugin_telegram.py tests/test_api.py -qAdditional Check
uv run --with pytest --with pytest-mock pytest -qreported1349 passed, 265 skipped, 14 warningsbefore I interrupted a hanging teardown/keyboard-interrupt cleanup path; the focused suites above completed normally.