fix(ruby): properly highlight %r{} regex literals containing nested patterns #4286
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, the Ruby grammar only recognized %r{} regex literals
in limited contexts, causing patterns like %r{(\.{2}|\A/)} to
break syntax highlighting.
This fix:
- Adds a top-level REGEXP mode to support all %r{} variations globally
- Enables nested brace handling inside %r{...}
- Removes redundant %r handling tied to RE_STARTERS_RE
- Adds a test case to regexes.txt to prevent regression
joshgoebel
reviewed
Jul 3, 2025
src/languages/ruby.js
Outdated
Comment on lines
244
to
247
| { begin: '%r\\(', end: '\\)[a-z]*' }, | ||
| { begin: '%r!', end: '![a-z]*' }, | ||
| { begin: '%r\\[', end: '\\][a-z]*' }, | ||
| { begin: '/', end: '/[a-z]*' } |
There was a problem hiding this comment.
All of these should be regex literals, not strings.
joshgoebel
reviewed
Jul 3, 2025
joshgoebel
reviewed
Jul 3, 2025
| hljs.BACKSLASH_ESCAPE, | ||
| SUBST, | ||
| { | ||
| begin: /\{/, end: /\}/, |
There was a problem hiding this comment.
What about a { or } inside of a character group []... please adds some tests and show that this would also be properly handled... I worry this is going to get very hard to get right without a full regex parser.
There was a problem hiding this comment.
Maybe just handling [] with escapes inside (to allow escaping a other closing ]) would be sufficient though?
There was a problem hiding this comment.
@joshgoebel this should now be fixed, I also added some tests to verify these cases.
Yang062
approved these changes
Jul 4, 2025
|
101142167176
***@***.***
Jacques Erasmus ***@***.***> 于 2025年7月4日周五 19:49写道：
… ***@***.**** commented on this pull request.
------------------------------
In src/languages/ruby.js
<#4286 (comment)>
:
> @@ -227,6 +227,27 @@ export default function(hljs) {
]
};
+ const REGEXP = {
+ className: 'regexp',
+ contains: [
+ hljs.BACKSLASH_ESCAPE,
+ SUBST,
+ {
+ begin: /\{/, end: /\}/,
@joshgoebel <https://github.com/joshgoebel> this should now be fixed, I
also added some tests to verify these cases.
—
Reply to this email directly, view it on GitHub
<#4286 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BK2N76VR5FECLYCE47MX7X33GZS4NAVCNFSM6AAAAACAIM4ROGVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDSOBWHA3DINRWHA>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
- Add character class handling to prevent {} inside [] from being treated as interpolation
- Support escaped closing brackets (\]) within character classes
- Ensure quantifiers like {3} still work outside character classes
- Add test cases to verify edge cases are handled properly
j-erasmus
force-pushed
the
466023-fix-ruby-syntax-highlighting
branch
from
eb40cc7 to
10e9c97
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This fixes an issue where
%r{}-style regular expressions in Ruby were not correctly highlighted when they contained nested patterns or complex escape sequences. Patterns like(\.{2}|\A/)would either break highlighting or be ignored entirely due to improper handling of nesting inside%r{}.Resolves: #4281
Root Cause
Highlight.js previously treated
%r{}regex literals as flat strings. This caused the parser to:{2}(quantifiers)\AFix
REGEXPmode to match%r{},%r(),%r[],%r!, etc. anywhere in Ruby code%r{}usingcontains: ['self']%rvariants from the legacyRE_STARTERS_REblock (which still handles/.../contexts)Screenshots