-
Notifications
You must be signed in to change notification settings - Fork 73
[markdown] Preserve metadata passed to fenced code blocks #2186
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[markdown] Preserve metadata passed to fenced code blocks #2186
Conversation
Package publishing
Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a valuable feature by preserving metadata from fenced code blocks, attaching it as a data-metadata
attribute to the pre
element. The implementation is well-executed, and the accompanying tests provide good coverage for the new functionality. I have one suggestion to refactor a small portion of the code to reduce duplication, which will enhance maintainability. Overall, this is a solid contribution.
PR HealthBreaking changes ✔️
This check can be disabled by tagging the PR with Changelog Entry ✔️
Changes to files need to be accounted for in their respective changelogs. This check can be disabled by tagging the PR with Coverage ✔️
This check for test coverage is informational (issues shown here will not fail the PR). This check can be disabled by tagging the PR with API leaks ✔️The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.
This check can be disabled by tagging the PR with License Headers ✔️
All source files should start with a license header. Unrelated files missing license headers
This check can be disabled by tagging the PR with |
Pull Request Test Coverage Report for Build 18136699326Details
💛 - Coveralls |
This is sort of the crux of whether I like this feature 😛 half-joking. I think this looks great. |
Revisions updated by `dart tools/rev_sdk_deps.dart`. ai (https://github.com/dart-lang/ai/compare/59db320..a29274b): a29274b 2025-10-09 Greg Spencer Provide output logs when the process launch fails. (dart-lang/ai#293) d33ed02 2025-10-07 Greg Spencer [Feat] Add hot restart tool (dart-lang/ai#297) dartdoc (https://github.com/dart-lang/dartdoc/compare/ec2a4fe..98d03ad): 98d03ad2 2025-10-09 Sarah Zakarias Bump to 9.0.0 (dart-lang/dartdoc#4116) 45ba6ede 2025-10-07 Sam Rawlins Display constructor names in annotations (dart-lang/dartdoc#4115) ecosystem (https://github.com/dart-lang/ecosystem/compare/96ee861..f4fbac4): f4fbac4 2025-10-13 Moritz Use up to date firehose in publish (dart-lang/ecosystem#376) 1fe5686 2025-10-10 Moritz Relax assumptions on workspaces in firehose (dart-lang/ecosystem#375) shelf (https://github.com/dart-lang/shelf/compare/f30d650..710b8ce): 710b8ce 2025-10-08 Kevin Moore shelf_router_generator: update dependencies, SDK (dart-lang/shelf#484) tools (https://github.com/dart-lang/tools/compare/6866f9b..adf3fe7): adf3fe78 2025-10-13 Parker Lougheed [markdown] Preserve metadata passed to fenced code blocks (dart-lang/tools#2186) b435a46b 2025-10-10 Stephen Adams Fix `SingleMapping.spanFor` to use previous line (dart-lang/tools#2205) 4c7dae18 2025-10-10 Morgan :) Fix for skipped tests on Windows. (dart-lang/tools#2204) 50b4514e 2025-10-09 Morgan :) Use Event extension type for Windows DirectoryWatcher. (dart-lang/tools#2203) a0af8b59 2025-10-08 Morgan :) Use Event extension type for MacOS DirectoryWatcher. (dart-lang/tools#2201) 0f50f061 2025-10-08 Morgan :) Add package-private extension type Event on FileSystemEvent. (dart-lang/tools#2200) d67ab97c 2025-10-07 Moritz [bazel_worker] Upgrade `protobuf` + cleanups (dart-lang/tools#2195) webdev (https://github.com/dart-lang/webdev/compare/29ba1b1..186bfe7): 186bfe71 2025-10-09 Ben Konyi [ DWDS ] Expose `dtdUri` via `DebugConnection` (dart-lang/webdev#2694) 3ab8fca3 2025-10-09 Srujan Gaddam [DWDS] Don't send PauseInterrupted event during a hot reload (dart-lang/webdev#2695) cdc5cc3c 2025-10-09 jensjoha Pass script uri for javascript expression compilation (dart-lang/webdev#2682) Change-Id: Ie78adfec4a8887af1ea3104b50c52ea2fd3bb1d2 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/454621 Reviewed-by: Konstantin Shcheglov <[email protected]> Auto-Submit: Devon Carew <[email protected]> Commit-Queue: Konstantin Shcheglov <[email protected]>
To enable accessing any extra metadata passed to the fenced code block after the language, store it on the wrapping
pre
element with a data attribute.For example:
Roughly becomes the following HTML:
Many site generation tools (such as Starlight) support this section for customizing the rendered code block.
Currently we've forked this syntax to use on dart.dev, but I imagine this is a common enough pattern that'd others would benefit. If preferred, it could opt-in through the syntax's constructor, but that's not a common pattern yet in the package and CommonMark doesn't mandate any specific treatment of the string.