Incorrect parsing of code injection strings

[4jamesccraven]

When using a comment based injection, it is typically shown using /* this comment syntax */, however the nixfmt rfc style formatter will change these to # this style of comment. When the comment is changed like that, the injections still function, but the first node inside the string is treated as part of the nix string before continuing. This breaks plugins like otter.nvim that allow lsp functionality inside of code injections. The formatter has an open issue on this (NixOS/nixfmt#179), but ideally the behaviour should not be dependent on comment style. Below is an example screenshot, you can see that the first node, in each case a comment, is green which the colour for a string with my particular theme. This is something I'd really like to get working as it would save me a lot of rebuilds on my neovim configurations. If I can help fix the issue I'm happy to contribute my time as well, I just need guidance on where to begin.

My neovim/nixos configs, for reference

@cstrahan

[stelcodes]

I'm seeing this issue too, but it happens with both /* and # comments. It's pretty annoying. Possibly related, my treesitter based commentstring gets messed up after injections no matter what comment plugin I use. If I use a /* lua */ injection, the rest of the file gets the -- commentstring.

[stelcodes]

My minimal repro:

repro.nix

{
  foo = /* lua */ ''
    -- Test
  '';
  bar = /* lua */ ''
    -- Test
  '';
}

[toastal]

{
  foo = # lua 
    ''
      -- Test
    '';
  bar = # lua
    ''
      -- Test
    '';
}

this works but you need to indent a new level… nixfmt was half-baked when they pushed it thru IMO.

[4jamesccraven]

{
foo = # lua
''
-- Test
'';
bar = # lua
''
-- Test
'';
}
this works but you need to indent a new level… nixfmt was half-baked when they pushed it thru IMO.

I can confirm that this does not work on my system. The first injection is properly highlighted, but the second is not. Additionally, the indentation you have is the exact same as that which I have in the original issue description.

Also, I don't think perceived shortcomings of nixfmt should be a factor in whether or not this gets a fix. While I have this issue due to the formatter, others may want to format their code this way of their own volition, irrespective of automatic formatters.

[toastal]

Oh wild… I have used this pattern for ages & never saw this attrset issue.

Then this is worse than I thought.

[miallo]

Indeed, as @stelcodes mentioned, this does not have to do with nixfmt (it supports /* */ since version 1.1.0). @4jamesccraven maybe you could update the title?

Some state does not seem to be properly reset at the end of parsing a different code block, so in the following ones, it gets confused.
E.g. here the "How are you?" should be displayed as a string, too:

let
  world = "World";
in
{
  greet = /* bash */ ''
    echo "Hi ${world}! This is fine"
  '';
  script = /* bash */ ''
    echo "Hello, ${world}! How are you?"
  '';
}

[4jamesccraven]

@miallo I changed it; I'm open to further wording suggestions if it seems like it will help.

Hopefully it will catch the attention of a maintainer.