Bash support in embedded code blocks of *.nix files

[jnoortheen]

• Embedded language support for Bash.

[ian-h-chamberlain]

For inspiration, tree-sitter-nix seems to use various prefixes to decide whether a string should be injected as bash:

• /* bash */ comment beforehand (also supports e.g. /* python */ etc. but not sure if this is feasible with LSP / tmLanguage)
• writeShellScript, runCommand, writeShellApplication
• various phases / hooks like configurePhase, buildPhase etc.

Supporting the /* bash */ comments would be nice if possible, since this allows for highlighting scripts in let bindings and arbitrary function args that might not be recognized automatically, while still leaving other multi-line strings as plain strings.

Edit: it may also be feasible to use request forwarding to support arbitrary language servers, so VSCode could fall back to something like bash-lsp for highlighting/completion etc

[different-name]

https://github.com/ruschaaf/extended-embedded-languages

Implements this for a variety of host and embedded languages, including host nix

[different-name]

Though the structure it uses is incompatible with nixfmt-rfc-style it seems

postBuild = /*bash*/ ''
  wrapProgram $out/bin/ALCOM \
    --set WEBKIT_DISABLE_DMABUF_RENDERER 1
'';

Will be formatted to

postBuild = # bash
  ''
    wrapProgram $out/bin/ALCOM \
      --set WEBKIT_DISABLE_DMABUF_RENDERER 1
  '';

Which then means the embedded language comment isn't properly detected anymore

ruschaaf/extended-embedded-languages#23

[eclairevoyant]

the structure it uses is incompatible with nixfmt-rfc-style

Open issue: NixOS/nixfmt#179

Also relevant: nix-community/tree-sitter-nix#139

[dyegoaurelio]

nixfmt now allows language annotations before strings.
So this

/* bash */ "echo hello"

Is compatible with the official formatter now.

[eclairevoyant]

https://github.com/ruschaaf/extended-embedded-languages

As commented on the issue above - I use that program with the patch eclairevoyant/eel@c6237da and some other improvements, which makes it work with current nixfmt.

You can use it directly from https://github.com/eclairevoyant/eel.