Incorrect parsing of shell heredoc

[aquarhead]

For example:

The syntax is not capturing the EOF but rather treats all lines follows as part of the heredoc.

Moving the EOF to beginning of the line works, as that's how a shell script would indeed format:

But of course this is invalid just syntax:

<$> just
error: Expected '*', ':', '$', identifier, or '+', but found end of line
  ——▶ justfile:66:4
   │
66 │ EOF
   │    ^

I looked around but don't really know how to fix it. Perhaps someways to remove all the indentations and send only the "actual body" to the embedded language somehow?

[nefrob]

The recipe body currently highlights using just syntax rather than shell syntax and breaks down in a lot of cases. I'll track this with #28 and #33.

[aquarhead]

FYI this looks fixed in 0.9.0 👍

[nefrob]

@aquarhead good to know, the lsp must be correcting the highlighting here now. This will likely still break on github or other places that rely solely on textmate grammar highlighting.

[jayqi]

I am on 0.9.0 but still seem to be seeing incorrect highlighting.

[schlichtanders]

I just installed it and also can see that the language server is running, nevertheless I see that EOF is wrongly parsed for linting.

It is a complex failure: While the outer commands are still correctly highlighted, the content is actually completely broken after only a single EOF. Look at the second command, which is the same as the first, but differently highlighted (broken).

Here the code

failing-command:
    #!/usr/bin/env bash
    set -euxo pipefail

    mkdir -p ~/bin
    tee > ~/bin/julia <<'EOF'
    # --check-bounds=yes makes testing use the same compilation as standard run
    $HOME/.juliaup/bin/julia --check-bounds=yes "$@"
    EOF
    chmod +x ~/bin/julia


next-command: failing-command
    #!/usr/bin/env bash
    set -euxo pipefail

    mkdir -p ~/bin
    tee > ~/bin/julia2 <<'EOF'
    # --check-bounds=yes makes testing use the same compilation as standard run
    $HOME/.juliaup/bin/julia --check-bounds=yes "$@"
    EOF
    chmod +x ~/bin/julia

[RedCMD]

the ShellScript EOF bug is here:

• Shell script syntax highlighting fails with indented EOT HereDoc jeff-hykin/better-shell-syntax#97

---

a workaround in your language would be to swap end for while

VSCode TextMate's while is a lot more strict than end (and TextMate 2.0's while)
it restricts inner rules from escaping
https://github.com/RedCMD/TmLanguage-Syntax-Highlighter/blob/main/documentation/rules.md#while

vscode-just/syntaxes/just.tmLanguage.yml

Lines 540 to 548 in 32a6803

	- comment: Shell
	begin: "^\\s+(#!/usr/bin/env\\s+(?:-S\\s+)?(?:sh|bash|zsh|fish).*)$"
	end: (?=^[^\s])
	beginCaptures:
	'1':
	name: comment.line.number-sign.shebang.just
	contentName: source.shell
	patterns:
	- include: source.shell

"comment": "Shell",
"begin": "^(\\s+)(#!/usr/bin/env\\s+(?:-S\\s+)?(?:sh|bash|zsh|fish).*)$",
"while": "^(?=\\s*$|\\1)",
"beginCaptures": { "2": { "name": "comment.line.number-sign.shebang.just" } },
"contentName": "source.shell",
"patterns": [ { "include": "source.shell" } ]

you can replace the \\1 with \\s if indenting is allowed to vary

same can be done to the other "embedded-languages"

[schlichtanders]

Thank you so much!! is there a way to add these configurations as a normal user via vscode settings?
(it looks to me like you changed vscode-just source code)

[RedCMD]

this is not something that can be done via settings
the closest you could get to that would be creating an entire extension to inject the TextMate rules

but it is much easier to just modify the vscode-just source code

[nefrob]

I'll look into this change + try to release it this weekend. Feel free to open as a PR if you have time @RedCMD.

[nefrob]

PR: #100.

[nefrob]

Released: https://github.com/nefrob/vscode-just/releases/tag/0.10.1. Might take 10-15mins for vscode extension to complete publishing.

[jayqi]

Confirmed to have fixed it for me. Thanks!