TextMate grammar doesn't handle unclosed triple-backtick code blocks in doc comments #6130

Activity

1. DanTup

   added

   is bug

   in editorRelates to code editing or language featuresRelates to code editing or language features

   on Jul 27, 2026
2. DanTup

   added this to the v3.140.0 milestone on Jul 27, 2026
3. DanTup

   changed the title [-]Semantic tokens for code block doesn't stop at the end of comment[/-] [+]TextMate grammar doesn't handle unclosed triple-backtick code blocks in doc comments[/+] on Jul 27, 2026
4. DanTup

   self-assigned this

   on Jul 27, 2026
5. DanTup commented on Jul 27, 2026

   

   DanTup

   on Jul 27, 2026

   MemberAuthor

   More actions

   Oddly, this seems to only occur in some very specific cases.

   /// Text
   /// ```
   /// code
   ///
   int? x1;
   
   /// ```
   /// code
   ///
   int? x2;
   
   /// Text
   /// ```
   /// code
   int? x3;
   
   /// ```
   /// code
   int? x4;
   

   Here, only the first example seems to be left broken (it's the only one where the ? shows as blue because it's still in code mode):

   

   >/// Text
   #^^^ source.dart comment.block.documentation.dart
   #   ^^^^^^ source.dart comment.block.documentation.dart
   >/// ```
   #^^^^^^^ source.dart comment.block.documentation.dart
   >/// code
   #^^^^ source.dart comment.block.documentation.dart
   #    ^^^^ source.dart comment.block.documentation.dart variable.other.source.dart
   >///
   #^^^^ source.dart comment.block.documentation.dart
   >int? x1;
   #^^^^^^^^ source.dart comment.block.documentation.dart variable.other.source.dart
   >
   >/// ```
   #^^^ source.dart comment.block.documentation.dart
   #   ^^^^^ source.dart comment.block.documentation.dart
   >/// code
   #^^^^^^^^^ source.dart comment.block.documentation.dart
   >///
   #^^^^ source.dart comment.block.documentation.dart
   >int? x2;
   #^^^ source.dart support.class.dart
   #   ^ source.dart keyword.operator.ternary.dart
   #    ^^^ source.dart
   #       ^ source.dart punctuation.terminator.dart
   >
   >/// Text
   #^^^ source.dart comment.block.documentation.dart
   #   ^^^^^^ source.dart comment.block.documentation.dart
   >/// ```
   #^^^^^^^ source.dart comment.block.documentation.dart
   >/// code
   #^^^^ source.dart comment.block.documentation.dart
   #    ^^^^ source.dart comment.block.documentation.dart variable.other.source.dart
   >int? x3;
   #^^^ source.dart support.class.dart
   #   ^ source.dart keyword.operator.ternary.dart
   #    ^^^ source.dart
   #       ^ source.dart punctuation.terminator.dart
   >
   >/// ```
   #^^^ source.dart comment.block.documentation.dart
   #   ^^^^^ source.dart comment.block.documentation.dart
   >/// code
   #^^^^^^^^^ source.dart comment.block.documentation.dart
   >int? x4;
   #^^^ source.dart support.class.dart
   #   ^ source.dart keyword.operator.ternary.dart
   #    ^^^ source.dart
   #       ^ source.dart punctuation.terminator.dart
   >
   

   Fortunately TextMate grammars are easy to debug 😂

   😄React with 😄1Reacted by Felipe Morschel

   👀React with 👀1Reacted by Felipe Morschel
6. DanTup commented on Jul 28, 2026

   

   DanTup

   on Jul 28, 2026

   MemberAuthor

   More actions

   I've a PR open that fixes this at #6132, however because the grammar is owned in another repo, and the parser used for the tests in that repo is owned in another repo, I'm going to wait to get all those PRs done before landing this one. Those PRs are linked in #6132
7. srawlins

   added 2 commits that reference this issue on Jul 29, 2026

   Fix the patterns for code blocks and the handling of newlines when ma…

   ...

   b308b4b

   Fix the patterns for code blocks and the handling of newlines when ma…

   ...

   103c983
8. DanTup

   closed this as completedin #6132on Jul 30, 2026