Bump ReverseMarkdown from 3.19.0 to 6.1.0#139
Conversation
--- updated-dependencies: - dependency-name: ReverseMarkdown dependency-version: 6.1.0 dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
Up to standards ✅🟢 Issues
|
There was a problem hiding this comment.
Pull Request Overview
This PR upgrades ReverseMarkdown across three major versions (v3.19.0 to v6.1.0). While Codacy analysis indicates the change is 'up to standards', the upgrade involves a complete engine rewrite in the underlying library.
Such a transition poses a high risk for regression in documentation generation, specifically regarding output formatting and escaping logic. There is currently no evidence or test coverage provided to verify that the DocsGenerator produces consistent output after this significant engine replacement.
About this PR
- The upgrade to v6.1.0 includes a 'ground-up rewrite' of the library's conversion engine (introduced in v6.0.0). This represents a high risk for breaking changes in output formatting, escaping, or configuration compatibility. Please provide verification that the generated documentation remains stable.
Test suggestions
- Verify that existing HTML to Markdown conversion logic produces correct output with the new v6.x engine rewrite
- Confirm that any configuration options used by DocsGenerator are compatible with the v6.0.0 configuration overhaul
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify that existing HTML to Markdown conversion logic produces correct output with the new v6.x engine rewrite
2. Confirm that any configuration options used by DocsGenerator are compatible with the v6.0.0 configuration overhaul
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
Updated ReverseMarkdown from 3.19.0 to 6.1.0.
Release notes
Sourced from ReverseMarkdown's releases.
6.1.0
What's Changed
Full Changelog: mysticmind/reversemarkdown-net@6.0.0...6.1.0
6.0.0
v6 is a ground-up rewrite of the conversion engine. HTML is parsed with AngleSharp's HTML5-compliant parser into an intermediate Markdown DOM, which is rendered through per-flavor writers. The result is more correct, faster, leaner, and extensible - while keeping the public API source-compatible with v5.
Engine
Output flavors
Seven output flavors, selected via the single canonical Flavor enum (MarkdownFlavor):
Spec compliance
Extensibility
HTML pre-filtering (new)
Configuration overhaul
<pre>-as-HTML, line-start escaping, configurable line endings, bullet character, and default code-block language.Framework support
Performance
... (truncated)
5.5.0
What's Changed
Full Changelog: mysticmind/reversemarkdown-net@5.4.0...5.5.0
5.4.0
✨ New features
🐛 Bug fixes
[[UnmanagedCallersOnly]](…)previously became[\[UnmanagedCallersOnly\]](…). Brackets inside backtick code spans are now left untouched; brackets outside code spans are still escaped.🔧 Maintenance
Full Changelog: mysticmind/reversemarkdown-net@5.3.0...5.4.0
5.3.0
What's Changed
Full Changelog: mysticmind/reversemarkdown-net@5.2.1...5.3.0
5.2.1
What's Changed
Full Changelog: mysticmind/reversemarkdown-net@5.2.0...5.2.1
5.2.0
What's Changed
<pre>content as HTML by @mysticmind in Add option to convert <pre> content as HTML mysticmind/reversemarkdown-net#422Full Changelog: mysticmind/reversemarkdown-net@5.1.0...5.2.0
5.1.0
What's Changed
New Contributors
Full Changelog: mysticmind/reversemarkdown-net@5.0.0...5.1.0
5.0.0
What's Changed
<p>Tags by @ssperling-wmp in Fixing #408 Exponential Time Complexity Bug Causing Hangs with Nested <p> Tags mysticmind/reversemarkdown-net#409Milestone 5.0.0
New Contributors
Full Changelog: mysticmind/reversemarkdown-net@4.7.0...5.0.0
4.7.1
Fix Exponential Time Complexity Bug Causing Hangs with Nested
<p>Tags GH-408 by @ssperling-wmp (cherry-picked and merged from master)Full Changelog: mysticmind/reversemarkdown-net@4.7.0...4.7.1
4.7.0
What's Changed
New Contributors
Full Changelog: mysticmind/reversemarkdown-net@4.6.0...4.7.0
4.6.0
What's Changed
New Contributors
Full Changelog: mysticmind/reversemarkdown-net@4.5.0...4.6.0
4.5.0
Full Changelog: mysticmind/reversemarkdown-net@4.4.0...4.5.0
4.4.0
Full Changelog: mysticmind/reversemarkdown-net@4.3.0...4.4.0
4.3.0
SuppressNewlinestoSuppressDivNewlines. Note that 4.2.0 was published with incorrect name so unlisted it rather than bumping up the major version due to this change.Full Changelog: mysticmind/reversemarkdown-net@4.2.0...4.3.0
4.2.0
What's Changed
Note: NuGet version unlisted due to incorrect config name, see 4.3.0 for details.
New Contributors
Full Changelog: mysticmind/reversemarkdown-net@4.1.0...4.2.0
4.1.0
Whats Changed
s,delandstrike#356Full Changelog: mysticmind/reversemarkdown-net@4.0.0...4.1.0
4.0.0
What's Changed
<sup>tag conversion by @francescolf in Add support for <sup> tag conversion mysticmind/reversemarkdown-net#358New Contributors
Full Changelog: mysticmind/reversemarkdown-net@3.25.0...4.0.0
3.25.0
Full Changelog: mysticmind/reversemarkdown-net@3.24.0...3.25.0
3.24.0
What's Changed
Full Changelog: mysticmind/reversemarkdown-net@3.23.1...3.24.0
Milestone: https://github.com/mysticmind/reversemarkdown-net/milestone/24?closed=1
3.23.1
Full Changelog: mysticmind/reversemarkdown-net@3.23.0...3.23.1
3.23.0
Full Changelog: mysticmind/reversemarkdown-net@3.22.0...3.23.0
3.22.0
Full Changelog: mysticmind/reversemarkdown-net@3.21.0...3.22.0
3.21.0
Full Changelog: mysticmind/reversemarkdown-net@3.20.0...3.21.0
3.20.0
Commits viewable in compare view.
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebasewill rebase this PR@dependabot recreatewill recreate this PR, overwriting any edits that have been made to it@dependabot show <dependency name> ignore conditionswill show all of the ignore conditions of the specified dependency@dependabot ignore this major versionwill close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor versionwill close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependencywill close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)