Bump ReverseMarkdown from 4.6.0 to 6.0.0#271
Conversation
--- updated-dependencies: - dependency-name: ReverseMarkdown dependency-version: 6.0.0 dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
dependabot
Bot
added
.NET
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Up to standards ✅🟢 Issues
|
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
This PR upgrades the ReverseMarkdown dependency from version 4.6.0 to 6.0.0. Although the analysis indicates the changes are technically up to standards, this upgrade represents a major architectural shift. The library has been rewritten to use the AngleSharp-based engine instead of HtmlAgilityPack, and the configuration model has been restructured.
The primary risk is the absence of verification tests to ensure that the documentation generation remains consistent. Given that this jump skips v5 and moves directly to v6, there is a possibility of breaking changes or regressions in the generated Markdown output that automated static analysis cannot detect. It is recommended to perform a visual or automated diff of the documentation output before merging.
About this PR
- The jump from v4 to v6 involves a ground-up rewrite of the library's engine. Please ensure that the current project configuration is compatible with the new 'Flavor' and 'Config' groups introduced in the v5/v6 lifecycle. Code using v4-specific patterns may require manual refactoring to align with the new engine's requirements.
Test suggestions
- Verify that documentation generation produces consistent Markdown output after the transition from HtmlAgilityPack to the AngleSharp-based engine.
- Ensure the project compiles correctly when jumping from v4 to v6, as breaking changes may exist beyond the v5-to-v6 compatibility layer.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify that documentation generation produces consistent Markdown output after the transition from HtmlAgilityPack to the AngleSharp-based engine.
2. Ensure the project compiles correctly when jumping from v4 to v6, as breaking changes may exist beyond the v5-to-v6 compatibility layer.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
|
Superseded by #272. |
dependabot
Bot
deleted the
dependabot/nuget/src/DocsGenerator/ReverseMarkdown-6.0.0
branch
Updated ReverseMarkdown from 4.6.0 to 6.0.0.
Release notes
Sourced from ReverseMarkdown's releases.
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
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)