fix: don't capture leading whitespace in modeline #129
Conversation
This file contains 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
Problem: Including leading whitespace in modeline leads (somehow) to leading whitespace being included in other nodes, especially `taglink`, and thus concealed. This breaks right-aligned taglinks in Neovim documentation. Solution: Do not include whitespace in modeline.
justinmk
reviewed
Mar 20, 2024
| @@ -171,7 +171,7 @@ module.exports = grammar({ | |||
| ), | |||
|
|
|||
| // Modeline: must start with "vim:" (optionally preceded by whitespace) | |||
| modeline: ($) => token(prec(2, /[\t ]*vim:[^\n]+\n/)), | |||
| modeline: ($) => token(prec(2, /vim:[^\n]+\n/)), | |||
There was a problem hiding this comment.
Yeah, explicitly matching whitespace in the token always causes problems. And it's not needed here anyway, because modeline is defined as a top-level ("block") token:
Lines 25 to 29 in 66f4fee
There was a problem hiding this comment.
Yup. This slipped by me in review.
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.
Problem: Including leading whitespace in modeline leads (somehow) to
leading whitespace being included in other nodes, especially
taglink,and thus concealed. This breaks right-aligned taglinks in Neovim
documentation.
Solution: Do not include whitespace in modeline.