Skip to content

Conversation

parlough
Copy link
Member

@parlough parlough commented Sep 30, 2025

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:

```dart showLineNumbers
code
```

Roughly becomes the following HTML:

<pre data-metadata="showLineNumbers">
  <code class="language-dart">code</code>
</pre>

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.

Copy link

Package publishing

Package Version Status Publish tag (post-merge)
package:bazel_worker 1.1.3 already published at pub.dev
package:benchmark_harness 2.4.0-wip WIP (no publish necessary)
package:boolean_selector 2.1.2 already published at pub.dev
package:browser_launcher 1.1.3 already published at pub.dev
package:cli_config 0.2.1-wip WIP (no publish necessary)
package:cli_util 0.5.0-wip WIP (no publish necessary)
package:clock 1.1.3-wip WIP (no publish necessary)
package:code_builder 4.11.0 already published at pub.dev
package:coverage 1.15.0 already published at pub.dev
package:csslib 1.0.2 already published at pub.dev
package:extension_discovery 2.1.0 already published at pub.dev
package:file 7.0.2-wip WIP (no publish necessary)
package:file_testing 3.1.0-wip WIP (no publish necessary)
package:glob 2.1.3 already published at pub.dev
package:graphs 2.3.3-wip WIP (no publish necessary)
package:html 0.15.6 already published at pub.dev
package:io 1.1.0-wip WIP (no publish necessary)
package:json_rpc_2 4.0.0 already published at pub.dev
package:markdown 7.3.1-wip WIP (no publish necessary)
package:mime 2.0.0 already published at pub.dev
package:oauth2 2.0.4-wip WIP (no publish necessary)
package:package_config 2.3.0-wip WIP (no publish necessary)
package:pool 1.5.2 already published at pub.dev
package:process 5.0.5 already published at pub.dev
package:pub_semver 2.2.0 already published at pub.dev
package:pubspec_parse 1.5.0 already published at pub.dev
package:source_map_stack_trace 2.1.3-wip WIP (no publish necessary)
package:source_maps 0.10.14-wip WIP (no publish necessary)
package:source_span 1.10.1 already published at pub.dev
package:sse 4.1.8 already published at pub.dev
package:stack_trace 1.12.1 already published at pub.dev
package:stream_channel 2.1.4 already published at pub.dev
package:stream_transform 2.1.2-wip WIP (no publish necessary)
package:string_scanner 1.4.1 already published at pub.dev
package:term_glyph 1.2.3-wip WIP (no publish necessary)
package:test_reflective_loader 0.4.0 already published at pub.dev
package:timing 1.0.2 already published at pub.dev
package:unified_analytics 8.0.5 already published at pub.dev
package:watcher 1.1.4 ready to publish watcher-v1.1.4
package:yaml 3.1.3 already published at pub.dev
package:yaml_edit 2.2.2 already published at pub.dev

Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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.

Copy link

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
markdown None 7.3.0 7.3.1-wip 7.3.0 ✔️

This check can be disabled by tagging the PR with skip-breaking-check.

Changelog Entry ✔️
Package Changed Files

Changes to files need to be accounted for in their respective changelogs.

This check can be disabled by tagging the PR with skip-changelog-check.

Coverage ✔️
File Coverage
pkgs/markdown/lib/src/block_syntaxes/fenced_code_block_syntax.dart 💚 98 % ⬆️ 0 %

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 skip-coverage-check.

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.

Package Leaked API symbol Leaking sources

This check can be disabled by tagging the PR with skip-leaking-check.

License Headers ✔️
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers
Files
pkgs/bazel_worker/benchmark/benchmark.dart
pkgs/bazel_worker/example/client.dart
pkgs/bazel_worker/example/worker.dart
pkgs/benchmark_harness/integration_test/perf_benchmark_test.dart
pkgs/boolean_selector/example/example.dart
pkgs/clock/lib/clock.dart
pkgs/clock/lib/src/clock.dart
pkgs/clock/lib/src/default.dart
pkgs/clock/lib/src/stopwatch.dart
pkgs/clock/lib/src/utils.dart
pkgs/clock/test/clock_test.dart
pkgs/clock/test/default_test.dart
pkgs/clock/test/stopwatch_test.dart
pkgs/clock/test/utils.dart
pkgs/coverage/lib/src/coverage_options.dart
pkgs/html/example/main.dart
pkgs/html/lib/dom.dart
pkgs/html/lib/dom_parsing.dart
pkgs/html/lib/html_escape.dart
pkgs/html/lib/parser.dart
pkgs/html/lib/src/constants.dart
pkgs/html/lib/src/encoding_parser.dart
pkgs/html/lib/src/html_input_stream.dart
pkgs/html/lib/src/list_proxy.dart
pkgs/html/lib/src/query_selector.dart
pkgs/html/lib/src/token.dart
pkgs/html/lib/src/tokenizer.dart
pkgs/html/lib/src/treebuilder.dart
pkgs/html/lib/src/utils.dart
pkgs/html/test/dom_test.dart
pkgs/html/test/parser_feature_test.dart
pkgs/html/test/parser_test.dart
pkgs/html/test/query_selector_test.dart
pkgs/html/test/selectors/level1_baseline_test.dart
pkgs/html/test/selectors/level1_lib.dart
pkgs/html/test/selectors/selectors.dart
pkgs/html/test/support.dart
pkgs/html/test/tokenizer_test.dart
pkgs/html/test/trie_test.dart
pkgs/html/tool/generate_trie.dart
pkgs/pubspec_parse/test/git_uri_test.dart
pkgs/stack_trace/example/example.dart
pkgs/watcher/test/custom_watcher_factory_test.dart
pkgs/yaml_edit/example/example.dart

This check can be disabled by tagging the PR with skip-license-check.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 18136699326

Details

  • 21 of 21 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.02%) to 96.142%

Totals Coverage Status
Change from base Build 18136242133: 0.02%
Covered Lines: 1570
Relevant Lines: 1633

💛 - Coveralls

@srawlins
Copy link
Member

and CommonMark doesn't mandate any specific treatment of the string.

This is sort of the crux of whether I like this feature 😛 half-joking. I think this looks great.

@srawlins srawlins merged commit adf3fe7 into dart-lang:main Oct 12, 2025
16 checks passed
copybara-service bot pushed a commit to dart-lang/sdk that referenced this pull request Oct 13, 2025
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants