Skip to content

syntax/sh: Improve heredoc detection #3931

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.

Sign up for GitHub

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

Open
JoeKar wants to merge 1 commit into
base: master
Choose a base branch
from
Open

syntax/sh: Improve heredoc detection #3931

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions runtime/syntax/sh.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ rules:
rules: []

- constant.string:
start: "<<[^\\s]+[-~.]*[A-Za-z0-9]+$"
end: "^[^\\s]+[A-Za-z0-9]+$"
start: "<<-?[\\s]*[\\w,.:~#!§$%=?@*+-]+$"
end: "^[\\w,.:~#!§$%=?@*+-]+$"
Comment on lines +60 to +61
Copy link
Contributor

@Andriamanitra Andriamanitra Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do people actually use punctuation for defining heredocs? I think it would be beneficial to keep the set of characters more realistic to reduce likelihood of false positives when looking for the end token.

Copy link
Collaborator Author

@JoeKar JoeKar Dec 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really know if they are used, but they are at least allowed. I tried them with the bash.
In case we ignore a valid character there will most probably be a ticket complaining about it. 🤷‍♂️

Edit:
By taking a closer look at [\\s] the [] can be removed.

Copy link
Contributor

@Andriamanitra Andriamanitra Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've never seen punctuation used for heredocs but I guess some other editors also allow it (although they don't need to worry about false positives for the end delimiter):

skip: "\\\\."
rules: []

Expand Down